@squiz/job-runner-lib 1.66.1 → 2.1.0

package/src/domains/manifest/services/ComponentFunctionService.spec.ts

@@ -1,683 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { ManifestModel } from '../ManifestModel';
-import { ComponentFunctionService } from './ComponentFunctionService';
-import { ManifestV1 } from '../ManifestV1';
-
-describe('ComponentFunctionService', () => {
-  const rootUrl = '/__dxp/au/components-render/test-tenant';
-  const service = new ComponentFunctionService();
-  const manifestPath = '';
-  const manifestModel: ManifestModel = {
-    $schema: './manifest-schemas/v1.json',
-
-    name: 'hello',
-    version: '1.0.1',
-    namespace: 'foo',
-    displayName: 'some display name',
-    description: 'some description',
-
-    mainFunction: 'hello',
-
-    functions: [
-      {
-        entry: 'whatever.js',
-        name: 'hello',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-
-          required: ['hello'],
-        },
-
-        output: {
-          responseType: 'html',
-        },
-
-        queryParameters: {
-          foo: {
-            required: false,
-          },
-        },
-      },
-
-      {
-        entry: 'whatever.js',
-        name: 'static-files',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-
-          required: ['hello'],
-        },
-
-        output: {
-          responseType: 'html',
-
-          staticFiles: [
-            {
-              file: {
-                filepath: './something.png',
-              },
-              location: 'header',
-            },
-
-            {
-              file: {
-                filepath: './sub/sub-dir.png',
-              },
-              location: 'header',
-            },
-
-            {
-              file: {
-                filepath: './sub/../sub-dir-transverse-up.png',
-              },
-              location: 'header',
-            },
-
-            {
-              file: {
-                filepath: '../sub-dir-transverse-up-past-root.png',
-              },
-              location: 'header',
-            },
-
-            {
-              file: {
-                filepath: '/absolute/path.png',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath: 'no-prefix.png',
-              },
-              location: 'header',
-            },
-          ],
-        },
-      },
-
-      {
-        entry: 'whatever.js',
-        name: 'hello-json',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-
-          required: ['hello'],
-        },
-
-        output: {
-          responseType: 'json',
-          definition: {
-            type: 'object',
-            properties: {
-              prop: { type: 'string' },
-              obj: { type: 'object', properties: { 'sub-prop': { type: 'number' } }, required: ['sub-prop'] },
-            },
-            additionalProperties: false,
-            required: ['prop', 'obj'],
-          },
-        },
-      },
-    ],
-  };
-
-  describe('prepareComponentFunctionForWebResponse', () => {
-    it('should convert all static file references in to fully qualified urls', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const func = service.getFunctionDefinitionFromManifest('static-files', manifest)!;
-      const webFunc = service.prepareComponentFunctionForWebResponse(func, manifest, 'set-a', rootUrl);
-
-      expect(webFunc).toEqual({
-        entry: 'whatever.js',
-        name: 'static-files',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-          required: ['hello'],
-        },
-
-        output: {
-          responseType: 'html',
-
-          staticFiles: [
-            {
-              file: {
-                filepath: '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/something.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub/sub-dir.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up-past-root.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/absolute/path.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath: '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/no-prefix.png?_componentSet=set-a',
-              },
-              location: 'header',
-            },
-          ],
-        },
-      });
-    });
-  });
-
-  describe('prepareManifestForWebResponse', () => {
-    it('should convert all static file references in to fully qualified urls for all function', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const webManifest = service.prepareManifestForWebResponse(manifest, 'set-a', rootUrl);
-
-      expect(webManifest).toEqual({
-        $schema: './manifest-schemas/v1.json',
-
-        description: 'some description',
-        displayName: 'some display name',
-        name: 'hello',
-        namespace: 'foo',
-        version: '1.0.1',
-
-        mainFunction: 'hello',
-
-        functions: [
-          {
-            entry: 'whatever.js',
-            name: 'hello',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-
-              required: ['hello'],
-            },
-
-            output: {
-              responseType: 'html',
-              staticFiles: undefined,
-            },
-
-            queryParameters: {
-              foo: {
-                required: false,
-              },
-            },
-          },
-
-          {
-            entry: 'whatever.js',
-            name: 'static-files',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-              required: ['hello'],
-            },
-
-            output: {
-              responseType: 'html',
-
-              staticFiles: [
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/something.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub/sub-dir.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up-past-root.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/absolute/path.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/no-prefix.png?_componentSet=set-a',
-                  },
-                  location: 'header',
-                },
-              ],
-            },
-          },
-          {
-            entry: 'whatever.js',
-            name: 'hello-json',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-
-              required: ['hello'],
-            },
-
-            output: {
-              responseType: 'json',
-              definition: {
-                type: 'object',
-                properties: {
-                  prop: { type: 'string' },
-                  obj: { type: 'object', properties: { 'sub-prop': { type: 'number' } }, required: ['sub-prop'] },
-                },
-                additionalProperties: false,
-                required: ['prop', 'obj'],
-              },
-            },
-          },
-        ],
-      });
-    });
-  });
-
-  describe('prepareComponentFunctionForPreview', () => {
-    it('should convert all static file references in to fully qualified urls', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const func = service.getFunctionDefinitionFromManifest('static-files', manifest)!;
-      const webFunc = service.prepareComponentFunctionForPreview(func, manifest, 'test-preview', rootUrl);
-      expect(webFunc).toEqual({
-        entry: 'whatever.js',
-        name: 'static-files',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-          required: ['hello'],
-        },
-
-        output: {
-          responseType: 'html',
-
-          staticFiles: [
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/something.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub/sub-dir.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up-past-root.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/absolute/path.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-            {
-              file: {
-                filepath:
-                  '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/no-prefix.png?_previewKey=test-preview',
-              },
-              location: 'header',
-            },
-          ],
-        },
-      });
-    });
-  });
-
-  describe('prepareManifestForPreview', () => {
-    it('should convert all static file references in to fully qualified urls for all function', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const webManifest = service.prepareManifestForPreview(manifest, 'test-preview', rootUrl);
-
-      expect(webManifest).toEqual({
-        $schema: './manifest-schemas/v1.json',
-
-        description: 'some description',
-        displayName: 'some display name',
-        name: 'hello',
-        namespace: 'foo',
-        version: '1.0.1',
-
-        mainFunction: 'hello',
-
-        functions: [
-          {
-            entry: 'whatever.js',
-            name: 'hello',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-
-              required: ['hello'],
-            },
-
-            queryParameters: {
-              foo: {
-                required: false,
-              },
-            },
-
-            output: {
-              responseType: 'html',
-            },
-          },
-
-          {
-            entry: 'whatever.js',
-            name: 'static-files',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-              required: ['hello'],
-            },
-
-            output: {
-              responseType: 'html',
-
-              staticFiles: [
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/something.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub/sub-dir.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/sub-dir-transverse-up-past-root.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/absolute/path.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-                {
-                  file: {
-                    filepath:
-                      '/__dxp/au/components-render/test-tenant/s/foo/hello/1.0.1/no-prefix.png?_previewKey=test-preview',
-                  },
-                  location: 'header',
-                },
-              ],
-            },
-          },
-          {
-            entry: 'whatever.js',
-            name: 'hello-json',
-
-            input: {
-              type: 'object',
-              properties: {
-                hello: { type: 'string' },
-              },
-
-              required: ['hello'],
-            },
-
-            output: {
-              responseType: 'json',
-              definition: {
-                type: 'object',
-                properties: {
-                  prop: { type: 'string' },
-                  obj: { type: 'object', properties: { 'sub-prop': { type: 'number' } }, required: ['sub-prop'] },
-                },
-                additionalProperties: false,
-                required: ['prop', 'obj'],
-              },
-            },
-          },
-        ],
-      });
-    });
-  });
-
-  describe('getFunctionDefinitionFromManifest', () => {
-    it('should return a function a component manifest file if it exists', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest);
-
-      expect(func).toEqual({
-        entry: 'whatever.js',
-        name: 'hello',
-
-        input: {
-          type: 'object',
-          properties: {
-            hello: { type: 'string' },
-          },
-          required: ['hello'],
-        },
-
-        queryParameters: {
-          foo: {
-            required: false,
-          },
-        },
-
-        output: {
-          responseType: 'html',
-        },
-      });
-    });
-
-    it('should return undefined if no function is found', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const func = service.getFunctionDefinitionFromManifest("doesn't exist", manifest);
-
-      expect(func).toBeUndefined();
-    });
-  });
-
-  describe('assertInputValidForComponentFunction', () => {
-    it("should throw an error if the input to a component function doesn't meet the schema", () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const input = {};
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest)!;
-
-      expect(() => service.assertInputValidForComponentFunction(input, func)).toThrowErrorMatchingInlineSnapshot(
-        `"failed validation: The required property \`hello\` is missing at \`#\`"`,
-      );
-    });
-
-    it('should throw an error if input is undefined', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const input = undefined;
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest)!;
-
-      expect(() => service.assertInputValidForComponentFunction(input, func)).toThrowErrorMatchingInlineSnapshot(
-        `"input value for hello cannot be undefined"`,
-      );
-    });
-
-    it('should return undefined is  meets schema', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const input = {
-        hello: 'some-value',
-      };
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest)!;
-
-      expect(service.assertInputValidForComponentFunction(input, func)).toBeUndefined();
-    });
-
-    it('should allow an empty FormattedText property', () => {
-      const input = {
-        myProp: [],
-      };
-      expect(() =>
-        service.assertInputValidForComponentFunction(input, {
-          entry: 'whatever.js',
-          name: 'hello',
-          input: {
-            type: 'object',
-            properties: {
-              myProp: {
-                type: 'FormattedText',
-              },
-            },
-            required: [],
-          },
-          output: {
-            responseType: 'html',
-          },
-        }),
-      ).not.toThrow();
-    });
-  });
-
-  describe('assertOutputValidForComponentFunction', () => {
-    it('should handle HtmlResponse type', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const output = 'I am html';
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest)!;
-
-      expect(service.assertOutputValidForComponentFunction(output, func)).toBeUndefined();
-    });
-
-    it('should throw an error if undefined is validated', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const output = undefined;
-      const func = service.getFunctionDefinitionFromManifest('hello', manifest)!;
-
-      expect(() => service.assertOutputValidForComponentFunction(output, func)).toThrowErrorMatchingInlineSnapshot(
-        `"input value for hello cannot be undefined"`,
-      );
-    });
-
-    it('should handle a JsonResponse type', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const output = {
-        prop: 'hello',
-        obj: {
-          'sub-prop': 123456,
-        },
-      };
-      const func = service.getFunctionDefinitionFromManifest('hello-json', manifest)!;
-
-      expect(service.assertOutputValidForComponentFunction(output, func)).toBeUndefined();
-    });
-
-    it('should throw an error if response does not meet component function output schema', () => {
-      const manifest = new ManifestV1(JSON.parse(JSON.stringify(manifestModel)), manifestPath);
-      const output = {
-        prop: 'hello',
-        obj: {},
-      };
-      const func = service.getFunctionDefinitionFromManifest('hello-json', manifest)!;
-
-      expect(() => service.assertOutputValidForComponentFunction(output, func)).toThrowErrorMatchingInlineSnapshot(
-        `"failed validation: The required property \`sub-prop\` is missing at \`#/obj\`"`,
-      );
-
-      expect(() => service.assertOutputValidForComponentFunction({}, func)).toThrowErrorMatchingInlineSnapshot(`
-        "failed validation: The required property \`prop\` is missing at \`#\`,
-        The required property \`obj\` is missing at \`#\`"
-      `);
-    });
-  });
-});