@squiz/render-runtime-lib 1.74.0 → 1.75.0

package/lib/webserver/controllers/StaticController.spec.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_helpers_1 = require("../../test-helpers");
+const static_route_tests_1 = require("./test/static-route-tests");
+const test_1 = require("../../test");
+describe('render-runtime - static files', () => {
+    const testServer = new test_helpers_1.TestHelpers.TestServer({
+        componentSetService: new test_1.MockedComponentSetServiceForProduction(),
+    });
+    beforeAll(async () => {
+        testServer.start();
+    });
+    afterAll(() => {
+        testServer.stop();
+    });
+    describe('Static Files routes tests', () => {
+        (0, static_route_tests_1.staticRouteTests)(() => testServer.request);
+    });
+    describe('Response Headers test', () => {
+        it('should return the headers set on the component set', async () => {
+            const response = await testServer.request.get('/s/unit-test-components/test-static-files/1.0.0/birthday-cake.png?_componentSet=set');
+            expect(response.header['some-header-name-1']).toEqual('mocked-component-set-header-val-1');
+            expect(response.header['some-header-name-2']).toEqual('mocked-component-set-header-val-2');
+            expect(response.statusCode).toEqual(200);
+        });
+    });
+});
+//# sourceMappingURL=StaticController.spec.js.map

package/lib/webserver/controllers/StaticController.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticController.spec.js","sourceRoot":"","sources":["../../../src/webserver/controllers/StaticController.spec.ts"],"names":[],"mappings":";;AAAA,qDAAiD;AACjD,kEAA6D;AAE7D,qCAAoE;AAEpE,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,MAAM,UAAU,GAAG,IAAI,0BAAW,CAAC,UAAU,CAAC;QAC5C,mBAAmB,EAAE,IAAI,6CAAsC,EAAE;KAClE,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,GAAG,EAAE;QACZ,UAAU,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,IAAA,qCAAgB,EAAC,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAClE,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,GAAG,CAC3C,qFAAqF,CACtF,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;YAC3F,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;YAC3F,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/webserver/controllers/test/definition-route-tests.js

@@ -0,0 +1,627 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definitionRouteTests = void 0;
+function definitionRouteTests(request, _rootUrl = 'http://localhost:3000') {
+    describe('definition routes', () => {
+        it('should return the component manifest', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/manifest.json');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                $schema: 'http://localhost:3000/schemas/v1.json#',
+                name: 'test-component',
+                namespace: 'unit-test-components',
+                description: 'some-description',
+                displayName: 'some-display-name',
+                version: '1.0.0',
+                mainFunction: 'main',
+                functions: [
+                    {
+                        name: 'main',
+                        entry: 'main.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['something'],
+                        },
+                        output: {
+                            responseType: 'html',
+                        },
+                    },
+                    {
+                        name: 'promise-func',
+                        entry: 'promise.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['something'],
+                        },
+                        output: {
+                            responseType: 'html',
+                        },
+                    },
+                ],
+                previews: {
+                    preview1: {
+                        functionData: {
+                            main: {
+                                inputData: {
+                                    type: 'inline',
+                                    value: {
+                                        something: 'something',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the component main function definition when no fn specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the component main function definition with component type when specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/main');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the function definition specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/promise-func');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'promise-func',
+                entry: 'promise.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should 404 if requesting on a non-existent component', async () => {
+            const response = await request().get('/d/unit-test-components/bad-component/1.0.0');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/bad-component 1.0.0 could not be found',
+            });
+        });
+        it('should 404 if requesting on a non-existent component version', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/9.9.9');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/test-component 9.9.9 could not be found',
+            });
+        });
+        it('should 404 if requesting a non-existent function on a valid component', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/non-existent-fn');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'non-existent-fn could not be found in test-component 1.0.0',
+            });
+        });
+        it('should NOT convert the static files to a fully qualified domains', async () => {
+            const response = await request().get('/d/unit-test-components/test-static-files/1.0.0');
+            expect(response.statusCode).toEqual(200);
+            expect(response.body).toEqual({
+                entry: 'main.js',
+                input: {},
+                name: 'main',
+                output: {
+                    responseType: 'html',
+                    staticFiles: [
+                        {
+                            file: {
+                                filepath: 'sub/dir/static-library-file.js',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                        {
+                            file: {
+                                filepath: 'https://cdnjs.cloudflare.com/ajax/libs/react/18.1.0/umd/react.production.min.js',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                        {
+                            file: {
+                                filepath: './sub2/dir/static-library-file.js',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                    ],
+                },
+            });
+        });
+    });
+    describe('preview routes - /d/ routes', () => {
+        it('should return the component manifest with resolved preview static files URLs', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.1/manifest.json?_previewKey=test-preview');
+            const expected = {
+                $schema: 'http://localhost:3000/schemas/v1.json#',
+                name: 'test-preview-component',
+                version: '1.0.1',
+                mainFunction: 'main',
+                displayName: 'some-display-name',
+                namespace: 'unit-test-components',
+                description: 'some-description',
+                functions: [
+                    {
+                        name: 'main',
+                        entry: 'main.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: [],
+                        },
+                        output: {
+                            responseType: 'html',
+                            staticFiles: [
+                                {
+                                    location: 'header',
+                                    file: {
+                                        type: 'css',
+                                        filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview`,
+                                    },
+                                },
+                                {
+                                    location: 'footer',
+                                    file: {
+                                        type: 'js',
+                                        filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/js-file.js?_previewKey=test-preview`,
+                                    },
+                                },
+                            ],
+                        },
+                    },
+                    {
+                        name: 'promise-func',
+                        entry: 'promise.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['something'],
+                        },
+                        output: {
+                            responseType: 'html',
+                            staticFiles: [
+                                {
+                                    location: 'header',
+                                    file: {
+                                        type: 'css',
+                                        filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview`,
+                                    },
+                                },
+                            ],
+                        },
+                    },
+                ],
+                staticFiles: {
+                    locationRoot: 'public',
+                },
+                previews: {
+                    'test-preview': {
+                        functionData: {
+                            main: {
+                                inputData: {
+                                    type: 'inline',
+                                    value: {
+                                        something: 'foo',
+                                    },
+                                },
+                                wrapper: {
+                                    path: 'preview-wrapper.html',
+                                },
+                            },
+                        },
+                    },
+                },
+            };
+            expect(response.body).toEqual(expected);
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+        });
+        it('should return the component main function definition when no fn specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.1?_previewKey=test-preview');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: [],
+                },
+                output: {
+                    responseType: 'html',
+                    staticFiles: [
+                        {
+                            location: 'header',
+                            file: {
+                                type: 'css',
+                                filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview`,
+                            },
+                        },
+                        {
+                            location: 'footer',
+                            file: {
+                                type: 'js',
+                                filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/js-file.js?_previewKey=test-preview`,
+                            },
+                        },
+                    ],
+                },
+            };
+            expect(response.body).toEqual(expected);
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+        });
+        it('should return the component main function definition when specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.1/main?_previewKey=test-preview');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: [],
+                },
+                output: {
+                    responseType: 'html',
+                    staticFiles: [
+                        {
+                            location: 'header',
+                            file: {
+                                type: 'css',
+                                filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview`,
+                            },
+                        },
+                        {
+                            location: 'footer',
+                            file: {
+                                type: 'js',
+                                filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/js-file.js?_previewKey=test-preview`,
+                            },
+                        },
+                    ],
+                },
+            };
+            expect(response.body).toEqual(expected);
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+        });
+        it('should return the function definition specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.1/promise-func?_previewKey=test-preview');
+            const expected = {
+                name: 'promise-func',
+                entry: 'promise.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                    staticFiles: [
+                        {
+                            location: 'header',
+                            file: {
+                                type: 'css',
+                                filepath: `${_rootUrl}/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview`,
+                            },
+                        },
+                    ],
+                },
+            };
+            expect(response.body).toEqual(expected);
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+        });
+        it('should 404 if requesting on a non-existent component', async () => {
+            const response = await request().get('/d/unit-test-components/bad-component/1.0.0?_previewKey=test-preview');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/bad-component 1.0.0 could not be found',
+            });
+        });
+        it('should 404 if requesting on a non-existent component version', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/9.9.9?_previewKey=test-preview');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/test-preview-component 9.9.9 could not be found',
+            });
+        });
+        it('should 404 if requesting a non-existent function on a valid component', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.1/non-existent-fn?_previewKey=test-preview');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'non-existent-fn could not be found in test-preview-component 1.0.1',
+            });
+        });
+        it('should set the headers defined in the function preview for the main route', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.2/?_previewKey=test-preview');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            expect(response.header['some-header-1']).toEqual('val-1');
+            expect(response.header['some-header-2']).toEqual('val-2');
+        });
+        it('should set the headers defined in the function preview for the function specific route', async () => {
+            const response = await request().get('/d/unit-test-components/test-preview-component/1.0.2/main?_previewKey=test-preview');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            expect(response.header['some-header-1']).toEqual('val-1');
+            expect(response.header['some-header-2']).toEqual('val-2');
+        });
+    });
+    describe('definition route - invalid query params', () => {
+        it('should throw an appropriate error message when botha _componentSet and _previewKey are provided as query parameters', async () => {
+            const response = await request().get('/d/unit-test-components/test-static-files/1.0.0?_componentSet=set&_previewKey=test-preview');
+            expect(response.statusCode).toEqual(400);
+        });
+    });
+    describe('definition routes - with component set', () => {
+        it('should return the component manifest', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/manifest.json?_componentSet=set');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                $schema: 'http://localhost:3000/schemas/v1.json#',
+                name: 'test-component',
+                namespace: 'unit-test-components',
+                description: 'some-description',
+                displayName: 'some-display-name',
+                version: '1.0.0',
+                mainFunction: 'main',
+                functions: [
+                    {
+                        name: 'main',
+                        entry: 'main.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['something'],
+                        },
+                        output: {
+                            responseType: 'html',
+                        },
+                    },
+                    {
+                        name: 'promise-func',
+                        entry: 'promise.js',
+                        input: {
+                            type: 'object',
+                            properties: {
+                                something: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['something'],
+                        },
+                        output: {
+                            responseType: 'html',
+                        },
+                    },
+                ],
+                previews: {
+                    preview1: {
+                        functionData: {
+                            main: {
+                                inputData: {
+                                    type: 'inline',
+                                    value: {
+                                        something: 'something',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the component main function definition when no fn specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0?_componentSet=set');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the component main function definition when specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/main?_componentSet=set');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'main',
+                entry: 'main.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should return the function definition specified in the route', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/promise-func?_componentSet=set');
+            expect(response.statusCode).toEqual(200);
+            expect(response.type).toEqual('application/json');
+            const expected = {
+                name: 'promise-func',
+                entry: 'promise.js',
+                input: {
+                    type: 'object',
+                    properties: {
+                        something: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['something'],
+                },
+                output: {
+                    responseType: 'html',
+                },
+            };
+            expect(response.body).toEqual(expected);
+        });
+        it('should 404 if requesting on a non-existent component', async () => {
+            const response = await request().get('/d/unit-test-components/bad-component/1.0.0?_componentSet=set');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/bad-component 1.0.0 could not be found',
+            });
+        });
+        it('should 404 if requesting on a non-existent component version', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/9.9.9?_componentSet=set');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'manifest for unit-test-components/test-component 9.9.9 could not be found',
+            });
+        });
+        it('should 404 if requesting a non-existent function on a valid component', async () => {
+            const response = await request().get('/d/unit-test-components/test-component/1.0.0/non-existent-fn?_componentSet=set');
+            expect(response.statusCode).toEqual(404);
+            expect(response.body).toEqual({
+                message: 'non-existent-fn could not be found in test-component 1.0.0',
+            });
+        });
+        it('should convert the static files to a fully qualified domains', async () => {
+            const response = await request().get('/d/unit-test-components/test-static-files/1.0.0?_componentSet=set');
+            expect(response.statusCode).toEqual(200);
+            expect(response.body).toEqual({
+                entry: 'main.js',
+                input: {},
+                name: 'main',
+                output: {
+                    responseType: 'html',
+                    staticFiles: [
+                        {
+                            file: {
+                                filepath: _rootUrl +
+                                    '/s/unit-test-components/test-static-files/1.0.0/sub/dir/static-library-file.js?_componentSet=set',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                        {
+                            file: {
+                                filepath: 'https://cdnjs.cloudflare.com/ajax/libs/react/18.1.0/umd/react.production.min.js',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                        {
+                            file: {
+                                filepath: _rootUrl +
+                                    '/s/unit-test-components/test-static-files/1.0.0/sub2/dir/static-library-file.js?_componentSet=set',
+                                type: 'js',
+                            },
+                            location: 'header',
+                        },
+                    ],
+                },
+            });
+        });
+    });
+}
+exports.definitionRouteTests = definitionRouteTests;
+//# sourceMappingURL=definition-route-tests.js.map