@squiz/component-cli-lib 1.21.1-alpha.2 → 1.21.1-alpha.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/component-cli-lib",
-  "version": "1.21.1-alpha.2",
+  "version": "1.21.1-alpha.21",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -13,16 +13,16 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@squiz/component-lib": "1.21.1-alpha.2",
-    "@squiz/component-web-api-lib": "1.21.1-alpha.2",
-    "@squiz/dx-common-lib": "1.21.1-alpha.2",
-    "@squiz/dx-json-schema-lib": "1.21.1-alpha.2",
-    "@squiz/dx-logger-lib": "1.21.1-alpha.2",
-    "@squiz/virus-scanner-lib": "1.21.1-alpha.2",
+    "@squiz/component-lib": "1.21.1-alpha.21",
+    "@squiz/component-web-api-lib": "1.21.1-alpha.21",
+    "@squiz/dx-common-lib": "1.21.1-alpha.21",
+    "@squiz/dx-json-schema-lib": "1.21.1-alpha.21",
+    "@squiz/dx-logger-lib": "1.21.1-alpha.21",
+    "@squiz/virus-scanner-lib": "1.21.1-alpha.21",
     "@types/cli-color": "2.0.2",
     "@types/express": "4.17.17",
     "@types/jest": "28.1.8",
-    "@types/node": "17.0.27",
+    "@types/node": "18.15.2",
     "@types/supertest": "2.0.12",
     "dotenv": "16.0.3",
     "jest": "29.4.1",
@@ -32,12 +32,12 @@
     "typescript": "4.9.4"
   },
   "dependencies": {
-    "@squiz/render-runtime-lib": "1.21.1-alpha.2",
+    "@squiz/render-runtime-lib": "1.21.1-alpha.21",
     "archiver": "5.3.1",
     "axios": "1.3.2",
     "cli-color": "^2.0.2",
     "open": "^8.4.0",
     "supertest": "^6.2.3"
   },
-  "gitHead": "094356f01a017174820505681d5dfc4a2ee9428b"
+  "gitHead": "b6a0d4e2501e58cb3c3ecd26741c447e2c3bc1db"
 }

package/src/component-dev.ts

@@ -9,7 +9,6 @@ import path from 'path';
 import { ComponentFunctionService, ComponentSetServiceForLocalDev, ManifestServiceForDev } from '@squiz/component-lib';
 import open from 'open';
 import { DevelopmentApiKeyService } from '@squiz/dx-common-lib';
-import { JsonValidationService } from '@squiz/dx-json-schema-lib';
 
 /**
  * startDevelopmentRender starts a dev-mode render stack for any
@@ -37,14 +36,14 @@ export function startDevelopmentRender(
       dataMountPoint,
       shouldCacheResponses: false,
       workerTimeout: 5_000,
-      numOfWorkers: 2,
+      minWorkers: 2,
+      maxWorkers: 2,
     },
     logger,
   );
-  const jsonValidationService = new JsonValidationService();
-  const componentFunctionService = new ComponentFunctionService(rootUrl, jsonValidationService);
+  const componentFunctionService = new ComponentFunctionService(rootUrl);
   const componentSetService = new ComponentSetServiceForLocalDev(logger);
-  const manifestService = new ManifestServiceForDev(dataMountPoint, logger, jsonValidationService);
+  const manifestService = new ManifestServiceForDev(dataMountPoint, logger);
   const contentItemService = undefined;
   const renderInputService = new RenderInputService(
     componentSetService,

package/src/integration-tests/__components__/matrix-asset-uri/main.js

@@ -0,0 +1,7 @@
+/**
+ * @param {object} input
+ * @param {ComponentInfo} info
+ */
+module.exports = async function (input, info) {
+  return `<div>Input: ${input.text}</div>`;
+};

package/src/integration-tests/__components__/matrix-asset-uri/manifest.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://localhost:3000/schemas/v1.json#",
+
+  "name": "matrix-asset-uri",
+  "version": "1.0.0",
+  "mainFunction": "main",
+  "displayName": "some-display-name",
+  "namespace": "smoke-test-components",
+  "description": "some-description",
+  "functions": [
+    {
+      "name": "main",
+      "entry": "main.js",
+      "input": {
+        "type": "object",
+        "properties": {
+          "text": {
+            "type": "string",
+            "format": "matrix-asset-uri",
+            "matrixAssetTypes": ["image"]
+          }
+        },
+        "required": ["text"]
+      },
+      "output": { "responseType": "html" }
+    }
+  ],
+  "previews": {
+    "test-preview": {
+      "functionData": {
+        "main": {
+          "inputData": {
+            "type": "inline",
+            "value": {
+              "text": "matrix://canary.uat.matrix.squiz.cloud/abc123"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/src/integration-tests/helper.ts

@@ -9,7 +9,6 @@ import { ContentApi } from '@squiz/component-web-api-lib';
 import { config } from 'dotenv';
 import { execSync } from 'child_process';
 import { getLogger } from '@squiz/dx-logger-lib';
-import { JsonValidationService } from '@squiz/dx-json-schema-lib';
 
 config();
 
@@ -112,11 +111,7 @@ export const ci_buildBranch = configObj.ci_buildBranch;
 
 export async function getTestComponents() {
   const componentsDir = path.join(__dirname, '/__components__/');
-  const manifestService = new ManifestServiceForDev(
-    componentsDir,
-    getLogger({ name: 'getTestComponents' }),
-    new JsonValidationService(),
-  );
+  const manifestService = new ManifestServiceForDev(componentsDir, getLogger({ name: 'getTestComponents' }));
   return await manifestService.listAllComponentManifests();
 }
 export async function createFile(filePath: string, sizeInMB: number) {

package/src/integration-tests/upload-and-render-component.integration.spec.ts

@@ -19,6 +19,7 @@ import { logger } from '../upload-component-folder';
 import { ComponentSetWebModelForCreate } from '@squiz/component-lib';
 import fsp from 'fs/promises';
 import { randomUUID } from 'crypto';
+import { AxiosError } from 'axios';
 
 const webPath = 'set-' + randomUUID();
 const contentItemId = randomUUID();
@@ -101,17 +102,21 @@ describe('uploading a component', () => {
 
   describe('Deploy a basic component having a input with multiline format', () => {
     beforeAll(async () => {
-      await deleteComponentSet(webPath);
-      await deleteContentItem(contentItemId);
-      for (const manifest of await getTestComponents()) {
-        await managementService.delete(`/component/${manifest.getName()}`).catch(() => null);
-        await contentService
-          .delete(
+      try {
+        await deleteComponentSet(webPath);
+        await deleteContentItem(contentItemId);
+        for (const manifest of await getTestComponents()) {
+          await managementService.delete(`/component/${manifest.getName()}`);
+          await contentService.delete(
             `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
               manifest.getComponentFunctionByName().name
             }`,
-          )
-          .catch(() => null);
+          );
+        }
+      } catch (error: unknown) {
+        if ((error as AxiosError).response?.status !== 404) {
+          throw error;
+        }
       }
     });
 
@@ -157,22 +162,90 @@ describe('uploading a component', () => {
     });
   });
 
+  describe('Deploy a basic component with input format matrix-asset-uri', () => {
+    beforeAll(async () => {
+      try {
+        await deleteComponentSet(webPath);
+        await deleteContentItem(contentItemId);
+        for (const manifest of await getTestComponents()) {
+          await managementService.delete(`/component/${manifest.getName()}`);
+          await contentService.delete(
+            `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
+              manifest.getComponentFunctionByName().name
+            }`,
+          );
+        }
+      } catch (error) {
+        if ((error as AxiosError).response?.status !== 404) {
+          throw error;
+        }
+      }
+    });
+    it('Should upload the component and return a valid url to preview', async () => {
+      const componentPath = path.join(__dirname, '/__components__/matrix-asset-uri');
+      await uploadComponentFolder(managementServiceRoot, configObj.managementServiceUrl, componentPath, testFilesDir);
+      const uploadedComponent =
+        '<a href="/r/smoke-test-components/matrix-asset-uri/1.0.0?_previewKey=test-preview">1.0.0</a>';
+      const get = await supertest(configObj.renderServiceUrl).get('/');
+      expect(get.status).toEqual(200);
+      expect((get as any)?.res?.text).toContain(uploadedComponent);
+    });
+
+    it('Should render a component with matrix-asset-uri format string input with set and content item', async () => {
+      const componentSet: ComponentSetWebModelForCreate = {
+        webPath,
+        displayName: 'some-display-name',
+        description: 'Set description',
+        headers: {},
+        environmentVariables: {},
+        components: {
+          'smoke-test-components/matrix-asset-uri': [{ environmentVariables: {}, version: '1.0.0' }],
+        },
+        componentVersionRules: {
+          'smoke-test-components/matrix-asset-uri': {
+            renderableVersionPattern: '1.0.0',
+            editableVersions: [],
+            excludedVersions: [],
+          },
+        },
+      };
+      await addComponentSet(componentSet);
+      await addContentItem({
+        id: contentItemId,
+        schemaName: 'smoke-test-components/matrix-asset-uri/1.0.0/main',
+        content: {
+          text: 'matrix-asset://canary.uat.matrix.squiz.cloud/abc123',
+        },
+      });
+
+      const response = await renderService.get(
+        `/r/smoke-test-components/matrix-asset-uri/1.0.0?_componentSet=${webPath}&_contentItemId=${contentItemId}`,
+      );
+      expect(response.status).toEqual(200);
+      expect(response.data).toEqual(`<div>Input: matrix-asset://canary.uat.matrix.squiz.cloud/abc123</div>`);
+    });
+  });
+
   describe('Deploy basic component having a static file', () => {
     // component to deploy for this test
     const componentPath = path.join(__dirname, '/__components__/cmp-static-file-test');
 
     beforeAll(async () => {
-      await deleteComponentSet(webPath);
-      await deleteContentItem(contentItemId);
-      for (const manifest of await getTestComponents()) {
-        await managementService.delete(`/component/${manifest.getName()}`).catch(() => null);
-        await contentService
-          .delete(
+      try {
+        await deleteComponentSet(webPath);
+        await deleteContentItem(contentItemId);
+        for (const manifest of await getTestComponents()) {
+          await managementService.delete(`/component/${manifest.getName()}`);
+          await contentService.delete(
             `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
               manifest.getComponentFunctionByName().name
             }`,
-          )
-          .catch(() => null);
+          );
+        }
+      } catch (error) {
+        if ((error as AxiosError).response?.status !== 404) {
+          throw error;
+        }
       }
     });
 
@@ -265,10 +338,6 @@ describe('uploading a component', () => {
         },
       });
 
-      console.log(
-        `/r/smoke-test-components/cmp-static-file-test/1.0.0/?_componentSet=${webPath}&_contentItemId=${contentItemId}`,
-      );
-
       const response = await renderService.get(
         `/r/smoke-test-components/cmp-static-file-test/1.0.0/?_componentSet=${webPath}&_contentItemId=${contentItemId}`,
       );

package/src/upload-component-folder.ts

@@ -7,7 +7,6 @@ import path from 'path';
 import { AxiosResponse, AxiosError, AxiosInstance } from 'axios';
 import color from 'cli-color';
 import { getLogger, Logger } from '@squiz/dx-logger-lib';
-import { JsonValidationService } from '@squiz/dx-json-schema-lib';
 
 export const logger: Logger = getLogger({ name: 'upload-component', format: 'human' });
 
@@ -54,7 +53,7 @@ export async function uploadComponentFolder(
 }
 
 async function preUploadChecks(apiClient: AxiosInstance, managementURL: string, folderPath: string) {
-  const service = new ManifestServiceForDev(folderPath, logger, new JsonValidationService());
+  const service = new ManifestServiceForDev(folderPath, logger);
   const manifestPath = path.join(folderPath, `manifest.json`);
 
   const result = await service.readManifest(manifestPath);