@squiz/component-cli-lib 1.32.1-alpha.8 → 1.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/component-cli-lib",
-  "version": "1.32.1-alpha.8",
+  "version": "1.33.0",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -13,12 +13,12 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@squiz/component-lib": "1.32.1-alpha.8",
-    "@squiz/component-web-api-lib": "1.32.1-alpha.8",
-    "@squiz/dx-common-lib": "1.32.1-alpha.8",
-    "@squiz/dx-json-schema-lib": "1.32.1-alpha.8",
-    "@squiz/dx-logger-lib": "1.32.1-alpha.8",
-    "@squiz/virus-scanner-lib": "1.32.1-alpha.8",
+    "@squiz/component-lib": "1.33.0",
+    "@squiz/component-web-api-lib": "1.33.0",
+    "@squiz/dx-common-lib": "1.33.0",
+    "@squiz/dx-json-schema-lib": "1.33.0",
+    "@squiz/dx-logger-lib": "1.33.0",
+    "@squiz/virus-scanner-lib": "1.33.0",
     "@types/cli-color": "2.0.2",
     "@types/express": "4.17.17",
     "@types/jest": "28.1.8",
@@ -32,12 +32,12 @@
     "typescript": "4.9.4"
   },
   "dependencies": {
-    "@squiz/render-runtime-lib": "1.32.1-alpha.8",
+    "@squiz/render-runtime-lib": "1.33.0",
     "archiver": "5.3.1",
     "axios": "1.3.2",
     "cli-color": "^2.0.2",
     "open": "^8.4.0",
     "supertest": "^6.2.3"
   },
-  "gitHead": "f414d74f3820748d760e202bb9e4fe9fae4f31c7"
+  "gitHead": "39f24b55ea7d5077df241753f723d549a117e91d"
 }

package/src/component-dev.ts

@@ -9,6 +9,7 @@ import path from 'path';
 import { ComponentFunctionService, ComponentSetServiceForLocalDev, ManifestServiceForDev } from '@squiz/component-lib';
 import open from 'open';
 import { DevelopmentApiKeyService } from '@squiz/dx-common-lib';
+import { ComponentLogger } from '@squiz/component-logger-lib';
 
 /**
  * startDevelopmentRender starts a dev-mode render stack for any
@@ -27,6 +28,15 @@ export function startDevelopmentRender(
     format: options.loggingFormat || 'human',
     silent: process.env.NODE_ENV === 'test',
   });
+
+  const devComponentLogger = new ComponentLogger({
+    enabled: false,
+    tenantId: 'dev-tenant-id',
+    logUrl: '',
+    key: '',
+    tags: 'tag-foo tag-foo2',
+  });
+
   const dataMountPoint = path.resolve(process.cwd(), componentPath);
 
   const rootUrl = `http://localhost:${options.port}`;
@@ -40,6 +50,7 @@ export function startDevelopmentRender(
       maxWorkers: 2,
     },
     logger,
+    devComponentLogger,
   );
   const componentFunctionService = new ComponentFunctionService(rootUrl);
   const componentSetService = new ComponentSetServiceForLocalDev(logger);

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

@@ -32,7 +32,7 @@
           "inputData": {
             "type": "inline",
             "value": {
-              "text": "matrix-asset://canary.uat.matrix.squiz.cloud/abc123"
+              "text": "matrix-asset://canary.uat.matrix.squiz.cloud/123"
             }
           }
         }

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

@@ -191,7 +191,7 @@ describe('uploading a component', () => {
         id: contentItemId,
         schemaName: 'smoke-test-components/matrix-asset-uri/1.0.0/main',
         content: {
-          text: 'matrix-asset://canary.uat.matrix.squiz.cloud/abc123',
+          text: 'matrix-asset://canary.uat.matrix.squiz.cloud/123',
         },
       });
 
@@ -199,7 +199,7 @@ describe('uploading a component', () => {
         `/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>`);
+      expect(response.data).toEqual(`<div>Input: matrix-asset://canary.uat.matrix.squiz.cloud/123</div>`);
     });
   });
 

package/src/upload-component-folder.ts

@@ -19,7 +19,12 @@ export async function uploadComponentFolder(
   const tmpDir = await fsp.mkdtemp(path.resolve(baseTempDir, 'cmp-upload'));
 
   try {
-    await preUploadChecks(apiClient, componentServiceManagementUrl, folderPath);
+    const manifestService = new ManifestServiceForDev(folderPath, logger);
+    const manifestPath = path.join(folderPath, `manifest.json`);
+    const manifest = await manifestService.readManifest(manifestPath);
+    await manifestService.assertManifestIsValid(manifestPath, manifest.getModel());
+
+    await preUploadChecks(apiClient, componentServiceManagementUrl, manifest);
     logger.info('Initial scanning');
     const zip = await zipDirectory(folderPath, tmpDir);
 
@@ -39,28 +44,27 @@ export async function uploadComponentFolder(
       apiClient.post(`/v1/upload-component/next/${initialUpload.id}`, {}, { baseURL: componentServiceManagementUrl }),
     );
 
-    if (result.toString().includes('504 Gateway Time-out')) {
-      let retriesAllowed = 3;
-      while (retriesAllowed > 0 && result.toString().includes('504 Gateway Time-out')) {
+    if (!isAxiosResponse(result)) {
+      let retriesAllowed = 12;
+      while (retriesAllowed > 0) {
         logger.info(
           `deployment id: ${initialUpload.id} status: ${color.yellow(
-            `timed out, retrying ${retriesAllowed} more times`,
+            `unknown, retrying to check the upload status ${retriesAllowed} more times`,
           )}`,
         );
-        result = await handleResponse<any>(
-          apiClient.post(
-            `/v1/upload-component/next/${initialUpload.id}`,
-            {},
-            {
-              baseURL: componentServiceManagementUrl,
-            },
-          ),
-        );
+        if (await checkIfVersionExists(apiClient, componentServiceManagementUrl, manifest)) {
+          result = {
+            status: 'successful',
+            accessLink: 'unknown',
+          };
+          break;
+        }
+        await new Promise((r) => setTimeout(r, 10000));
         retriesAllowed--;
       }
       if (retriesAllowed === 0) {
-        logger.error(`deployment id: ${initialUpload.id} status: ${color.red('failed due to timeout')}`);
-        throw new Error('504 Gateway Time-out');
+        logger.error(`deployment id: ${initialUpload.id} status: ${color.red('failed to check the upload status')}`);
+        throw new Error(result.toString());
       }
     }
 
@@ -86,16 +90,9 @@ export async function uploadComponentFolder(
   }
 }
 
-async function preUploadChecks(apiClient: AxiosInstance, managementURL: string, folderPath: string) {
-  const service = new ManifestServiceForDev(folderPath, logger);
-  const manifestPath = path.join(folderPath, `manifest.json`);
-
-  const result = await service.readManifest(manifestPath);
-
-  await service.assertManifestIsValid(manifestPath, result.getModel());
-
-  if (await checkIfVersionExists(apiClient, managementURL, result)) {
-    throw new Error(`Cannot upload component version, ${result.getName()} ${result.getVersion()} already exists`);
+async function preUploadChecks(apiClient: AxiosInstance, managementURL: string, manifest: Manifest) {
+  if (await checkIfVersionExists(apiClient, managementURL, manifest)) {
+    throw new Error(`Cannot upload component version, ${manifest.getName()} ${manifest.getVersion()} already exists`);
   }
 }
 
@@ -185,3 +182,7 @@ function handleError(error: any): Error {
 function isAxiosError(error: any): error is AxiosError {
   return error && error.isAxiosError === true;
 }
+
+function isAxiosResponse(response: unknown): response is AxiosResponse {
+  return response instanceof Object && Object.prototype.hasOwnProperty.call(response, 'status');
+}