@squiz/component-cli-lib 1.2.13-alpha.2 → 1.2.13-alpha.4

package/lib/integration-tests/helper.d.ts

@@ -16,7 +16,7 @@ export declare const renderService: import("axios").AxiosInstance;
 export declare const contentService: import("axios").AxiosInstance;
 export declare const ci_buildVersion: string;
 export declare const ci_buildBranch: string;
-export declare function getTestComponents(): string[];
+export declare function getTestComponents(): Promise<import("@squiz/component-lib").ManifestV1[]>;
 export declare function createFile(filePath: string, sizeInMB: number): Promise<void>;
 export declare function removeFile(filePath: string): void;
 export declare function deleteComponentSet(webPath: string): Promise<void>;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@squiz/component-cli-lib",
-  "version": "1.2.13-alpha.2",
+  "version": "1.2.13-alpha.4",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
-    "compile": "tsc",
+    "compile": "node ./build.js && tsc",
     "lint": "eslint ./src --ext .ts",
     "test": "jest -c jest.config.ts",
     "test:integration": "jest -c jest.integration.config.ts",
@@ -13,12 +13,19 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@squiz/component-lib": "1.2.13-alpha.4",
+    "@squiz/component-web-api-lib": "1.2.13-alpha.4",
+    "@squiz/dx-common-lib": "1.2.13-alpha.4",
+    "@squiz/dx-json-schema-lib": "1.2.13-alpha.4",
+    "@squiz/dx-logger-lib": "1.2.13-alpha.4",
+    "@squiz/virus-scanner-lib": "1.2.13-alpha.4",
     "@types/cli-color": "2.0.2",
     "@types/express": "4.17.14",
     "@types/jest": "28.1.8",
     "@types/node": "17.0.27",
     "@types/supertest": "2.0.12",
     "dotenv": "16.0.3",
+    "esbuild": "0.16.17",
     "eslint": "8.22.0",
     "jest": "28.1.3",
     "ts-jest": "28.0.8",
@@ -27,18 +34,13 @@
     "typescript": "4.9.3"
   },
   "dependencies": {
-    "@squiz/component-lib": "1.2.13-alpha.2",
-    "@squiz/component-web-api-lib": "1.2.13-alpha.2",
-    "@squiz/dx-common-lib": "1.2.13-alpha.2",
-    "@squiz/dx-json-schema-lib": "1.2.13-alpha.2",
-    "@squiz/dx-logger-lib": "1.2.13-alpha.2",
-    "@squiz/render-runtime-lib": "1.2.13-alpha.2",
-    "@squiz/virus-scanner-lib": "1.2.13-alpha.2",
+    "@squiz/render-runtime-lib": "1.2.13-alpha.4",
     "archiver": "5.3.1",
     "axios": "0.27.2",
     "cli-color": "^2.0.2",
+    "esbuild": "^0.17.0",
     "open": "^8.4.0",
     "supertest": "^6.2.3"
   },
-  "gitHead": "f93643bf518d1d92d7ea3b44bd9114ca43358bf3"
+  "gitHead": "af8baa311cec5b438ccd989b261fd139149d9a0e"
 }

package/src/component-dev.ts

@@ -24,7 +24,11 @@ export function startDevelopmentRender(
   componentPath: string,
   options: { port: number; loggingFormat?: LoggerOptions['format']; noBrowser?: boolean },
 ) {
-  const logger = getLogger({ name: 'component-dev', format: options.loggingFormat || 'human' });
+  const logger = getLogger({
+    name: 'component-dev',
+    format: options.loggingFormat || 'human',
+    silent: process.env.NODE_ENV === 'test',
+  });
   const dataMountPoint = path.resolve(process.cwd(), componentPath);
 
   const rootUrl = `http://localhost:${options.port}`;
@@ -34,6 +38,7 @@ export function startDevelopmentRender(
       dataMountPoint,
       shouldCacheResponses: false,
       workerTimeout: 5_000,
+      numOfWorkers: 2,
     },
     logger,
   );

package/src/integration-tests/__components__/cmp-format-string/manifest.json

@@ -5,7 +5,7 @@
   "version": "1.0.0",
   "mainFunction": "main",
   "displayName": "some-display-name",
-  "namespace": "fixtures",
+  "namespace": "smoke-test-components",
   "description": "some-description",
   "functions": [
     {

package/src/integration-tests/helper.ts

@@ -1,14 +1,15 @@
 import axios from 'axios';
-import fs from 'fs';
 import path from 'path';
 
 import fsp from 'fs/promises';
 import { randomBytes } from 'crypto';
-import { ComponentSetWebModelForCreate } from '@squiz/component-lib';
+import { ComponentSetWebModelForCreate, ManifestServiceForDev } from '@squiz/component-lib';
 import { parseEnvVarForVar } from '@squiz/dx-common-lib';
 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();
 
@@ -52,6 +53,13 @@ const ALL_PERMISSIONS_ROLE = {
 
     'COMPONENT_SET_ENVIRONMENT_READ',
     'COMPONENT_SET_ENVIRONMENT_WRITE',
+
+    'CONTENT_SCHEMA_READ',
+    'CONTENT_SCHEMA_WRITE',
+    'CONTENT_ITEM_READ',
+    'CONTENT_ITEM_WRITE',
+    'SETTINGS_READ',
+    'SETTINGS_WRITE',
   ],
 };
 
@@ -102,17 +110,14 @@ export const contentService = axios.create({
 export const ci_buildVersion = configObj.ci_buildVersion;
 export const ci_buildBranch = configObj.ci_buildBranch;
 
-export function getTestComponents(): string[] {
-  const componets = [];
+export async function getTestComponents() {
   const componentsDir = path.join(__dirname, '/__components__/');
-  const files = fs.readdirSync(componentsDir);
-  for (const file of files) {
-    const stat = fs.statSync(path.join(componentsDir, file));
-    if (stat.isDirectory() && file.substring(0, 4) === 'cmp-') {
-      componets.push(file);
-    }
-  }
-  return componets;
+  const manifestService = new ManifestServiceForDev(
+    componentsDir,
+    getLogger({ name: 'getTestComponents' }),
+    new JsonValidationService(),
+  );
+  return await manifestService.listAllComponentManifests();
 }
 export async function createFile(filePath: string, sizeInMB: number) {
   const content = randomBytes(sizeInMB * 1000000);

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

@@ -10,6 +10,7 @@ import configObj, {
   addContentItem,
   deleteContentItem,
   managementServiceRoot,
+  contentService,
 } from './helper';
 import color from 'cli-color';
 import path from 'path';
@@ -31,6 +32,7 @@ describe('uploading a component', () => {
   beforeAll(async () => {
     await fsp.rm(testFilesDir, { force: true, recursive: true });
     await fsp.mkdir(testFilesDir);
+    logger.silent = true;
   });
 
   afterAll(async () => {
@@ -38,16 +40,19 @@ describe('uploading a component', () => {
     await deleteComponentSet(webPath);
     await deleteContentItem(contentItemId);
 
-    for (const componentName of getTestComponents()) {
-      try {
-        await managementService.delete(`/component/smoke-test-components/${componentName}`);
-      } catch {
-        // no op
-      }
+    for (const manifest of await getTestComponents()) {
+      await managementService.delete(`/component/${manifest.getName()}`).catch(() => null);
+      await contentService
+        .delete(
+          `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
+            manifest.getComponentFunctionByName().name
+          }`,
+        )
+        .catch(() => null);
     }
-
     // clean up the test componnet files
     await fsp.rm(testFilesDir, { force: true, recursive: true });
+    logger.silent = false;
   });
 
   describe('Test isolated test cases', () => {
@@ -74,7 +79,9 @@ describe('uploading a component', () => {
         testFilesDir,
       );
       expect(mockConsoleError.mock.calls[0][0]).toEqual(
-        color.red('failed validation: /name: pattern must match pattern "^[a-zA-Z0-9_\\-]+$"'),
+        color.red(
+          'failed validation: Value in `#/name` should match `^[a-zA-Z0-9_\\-]+$`, but received `invalid-manifes@t`',
+        ),
       );
     });
 
@@ -101,12 +108,15 @@ describe('uploading a component', () => {
     beforeAll(async () => {
       await deleteComponentSet(webPath);
       await deleteContentItem(contentItemId);
-      for (const componentName of getTestComponents()) {
-        try {
-          await managementService.delete(`/component/${componentName}`);
-        } catch {
-          // no op
-        }
+      for (const manifest of await getTestComponents()) {
+        await managementService.delete(`/component/${manifest.getName()}`).catch(() => null);
+        await contentService
+          .delete(
+            `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
+              manifest.getComponentFunctionByName().name
+            }`,
+          )
+          .catch(() => null);
       }
     });
 
@@ -122,7 +132,8 @@ describe('uploading a component', () => {
     it('Should upload the component and return a valid url to preview', async () => {
       const componentPath = path.join(__dirname, '/__components__/cmp-format-string');
       await uploadComponentFolder(managementServiceRoot, configObj.managementServiceUrl, componentPath, testFilesDir);
-      const uploadedComponent = '<a href="/r/fixtures/cmp-format-string/1.0.0?_previewKey=test-preview">1.0.0</a>';
+      const uploadedComponent =
+        '<a href="/r/smoke-test-components/cmp-format-string/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);
@@ -136,20 +147,20 @@ describe('uploading a component', () => {
         headers: {},
         environmentVariables: {},
         components: {
-          'fixtures/cmp-format-string': [{ environmentVariables: {}, version: '1.0.0' }],
+          'smoke-test-components/cmp-format-string': [{ environmentVariables: {}, version: '1.0.0' }],
         },
         componentVersionRules: {},
       };
       await addComponentSet(componentSet);
       await addContentItem({
         id: contentItemId,
-        schemaName: 'fixtures/cmp-format-string/1.0.0/main',
+        schemaName: 'smoke-test-components/cmp-format-string/1.0.0/main',
         content: {
           text: 'from-content-item-service',
         },
       });
       const response = await renderService.get(
-        `/r/fixtures/cmp-format-string/1.0.0/?_contentItemId=${contentItemId}&_componentSet=${webPath}`,
+        `/r/smoke-test-components/cmp-format-string/1.0.0/?_contentItemId=${contentItemId}&_componentSet=${webPath}`,
       );
       expect(response.status).toEqual(200);
       expect(response.data).toEqual(`<div>Input: from-content-item-service</div>`);
@@ -163,12 +174,15 @@ describe('uploading a component', () => {
     beforeAll(async () => {
       await deleteComponentSet(webPath);
       await deleteContentItem(contentItemId);
-      for (const componentName of getTestComponents()) {
-        try {
-          await managementService.delete(`/component/${componentName}`);
-        } catch {
-          // no op
-        }
+      for (const manifest of await getTestComponents()) {
+        await managementService.delete(`/component/${manifest.getName()}`).catch(() => null);
+        await contentService
+          .delete(
+            `/content-schema/${manifest.getName()}/${manifest.getVersion()}/${
+              manifest.getComponentFunctionByName().name
+            }`,
+          )
+          .catch(() => null);
       }
     });
 

package/tsconfig.json

@@ -2,11 +2,13 @@
   "extends": "../../tsconfig.json",
 
   "compilerOptions": {
-    "outDir": "lib/",
+    "outDir": "lib",
     "resolveJsonModule": true,
     "composite": true,
     "rootDir": "./src",
-    "sourceMap": true
+    "sourceMap": true,
+    "declaration": true,
+    "emitDeclarationOnly": true
   },
 
   "references": [