chore: add generatePageMetaData test

Author: openscript

gatsby-node.ts

@@ -1,7 +1,7 @@
 import { GatsbyNode } from 'gatsby';
 import { CreateGenericPages } from './src/gatsby/createPages/createGenericPages';
 import { customizeSitePageContext } from './src/gatsby/createSchemaCustomization/customizeSitePageContext';
-import { GeneratePageMetaData } from './src/gatsby/onCreatePage/generatePageMetaData';
+import { generatePageMetaData } from './src/gatsby/onCreatePage/generatePageMetaData';
 
 export const createPages: GatsbyNode['createPages'] = async args => {
   await CreateGenericPages(args);
@@ -12,5 +12,5 @@ export const createSchemaCustomization: GatsbyNode['createSchemaCustomization']
 };
 
 export const onCreatePage: GatsbyNode<Record<string, unknown>, Queries.SitePageContext>['onCreatePage'] = async args => {
-  await GeneratePageMetaData(args);
+  await generatePageMetaData(args);
 };

src/gatsby/onCreatePage/generatePageMetaData.test.ts

@@ -0,0 +1,182 @@
+import { generatePageMetaData } from './generatePageMetaData';
+
+const args: any = {
+  actions: {},
+  page: {},
+  reporter: {},
+};
+
+jest.mock('../../../content/i18n/de-CH.json', () => ({}), { virtual: true });
+
+describe('generatePageMetaData', () => {
+  beforeEach(() => {
+    args.actions = {
+      createPage: jest.fn(),
+      deletePage: jest.fn(),
+    };
+    args.page = {};
+    args.reporter = {
+      warn: jest.fn(),
+    };
+  });
+
+  it('returns without page context', async () => {
+    await generatePageMetaData(args);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('returns when is not a stateful created page', async () => {
+    args.page = {
+      context: {},
+      isCreatedByStatefulCreatePages: false,
+    };
+    await generatePageMetaData(args);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('returns without locale pages id', async () => {
+    args.page = {
+      context: {},
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('returns when locale pages id is blacklisted', async () => {
+    args.page = {
+      context: {
+        localePagesId: 'dev-404-page',
+      },
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('returns with warning when there are no messages for locale', async () => {
+    args.page = {
+      context: {
+        localePagesId: 'some.page',
+      },
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.reporter.warn).toBeCalledWith(`Page context locale is null or couldn't find locale undefined.`);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('returns with warning when the key site.meta.title is not in the messages', async () => {
+    args.page = {
+      context: {
+        localePagesId: 'index',
+        locale: 'de-CH',
+      },
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.reporter.warn).toBeCalledWith(`Missing key site.meta.title in messages.`);
+    expect(args.actions.deletePage).not.toBeCalled();
+    expect(args.actions.createPage).not.toBeCalled();
+  });
+
+  it('set the meta data with warning when the page title key is not in the messages', async () => {
+    args.page = {
+      context: {
+        localePagesId: 'some.fictional.page',
+        locale: 'en-US',
+      },
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.reporter.warn).toBeCalledWith(`Missing key page.some.fictional.page.meta.title in messages.`);
+    expect(args.reporter.warn).toBeCalledWith(`Missing key page.some.fictional.page.meta.description in messages.`);
+    expect(args.actions.createPage).toMatchInlineSnapshot(`
+      [MockFunction] {
+        "calls": [
+          [
+            {
+              "context": {
+                "locale": "en-US",
+                "localePagesId": "some.fictional.page",
+                "metaData": {
+                  "description": undefined,
+                  "title": "openscript Ltd.",
+                },
+              },
+              "isCreatedByStatefulCreatePages": true,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": undefined,
+          },
+        ],
+      }
+    `);
+  });
+
+  it('sets the meta data', async () => {
+    args.page = {
+      context: {
+        localePagesId: 'index',
+        locale: 'en-US',
+      },
+      isCreatedByStatefulCreatePages: true,
+    };
+    await generatePageMetaData(args);
+    expect(args.actions.deletePage).toMatchInlineSnapshot(`
+      [MockFunction] {
+        "calls": [
+          [
+            {
+              "context": {
+                "locale": "en-US",
+                "localePagesId": "index",
+              },
+              "isCreatedByStatefulCreatePages": true,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": undefined,
+          },
+        ],
+      }
+    `);
+    expect(args.actions.createPage).toMatchInlineSnapshot(`
+      [MockFunction] {
+        "calls": [
+          [
+            {
+              "context": {
+                "locale": "en-US",
+                "localePagesId": "index",
+                "metaData": {
+                  "description": "Companions for adventures in the world of bits and bytes.",
+                  "title": "Home - openscript Ltd.",
+                },
+              },
+              "isCreatedByStatefulCreatePages": true,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": undefined,
+          },
+        ],
+      }
+    `);
+  });
+});

src/gatsby/onCreatePage/generatePageMetaData.ts

@@ -27,7 +27,7 @@ function createPageTitle(siteTitle: string, pageTitle?: string) {
   return pageTitle ? `${pageTitle} - ${siteTitle}` : siteTitle;
 }
 
-export async function GeneratePageMetaData({ actions, page, reporter }: CreatePageArgs<Queries.SitePageContext>) {
+export async function generatePageMetaData({ actions, page, reporter }: CreatePageArgs<Queries.SitePageContext>) {
   const { createPage, deletePage } = actions;
   if (!page.context || !page.isCreatedByStatefulCreatePages) {
     return;