@squiz/component-cli-lib 1.69.1 → 1.70.1

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

@@ -1,42 +0,0 @@
-{
-  "$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-asset://canary.uat.matrix.squiz.cloud/123"
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/src/integration-tests/__components__/test-page-render/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return `<div>component-html</div>`;
-};

package/src/integration-tests/__components__/test-page-render/manifest.json

@@ -1,46 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-  "name": "test-page-render",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "displayName": "some-display-name",
-  "namespace": "unit-test-components",
-  "description": "some-description",
-  "functions": [
-    {
-      "name": "main",
-      "entry": "main.js",
-      "input": {
-        "type": "object",
-        "properties": {
-          "text ": {
-            "type": "string"
-          }
-        },
-        "required": []
-      },
-      "output": {
-        "responseType": "html",
-        "staticFiles": [
-          {
-            "location": "header",
-            "file": {
-              "filepath": "static-library-styles.css",
-              "type": "css"
-            }
-          },
-          {
-            "location": "footer",
-            "file": {
-              "filepath": "static-library-script.js",
-              "type": "js"
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "staticFiles": {
-    "locationRoot": "public"
-  }
-}

package/src/integration-tests/__components__/test-page-render/public/static-library-script.js

@@ -1 +0,0 @@
-// static library frontend js

package/src/integration-tests/__components__/test-page-render/public/static-library-styles.css

@@ -1,3 +0,0 @@
-.component-class {
-  color: red;
-}

package/src/integration-tests/__jobs__/invalid-manifest/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return 'this is a test job';
-};

package/src/integration-tests/__jobs__/invalid-manifest/manifest.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "http://localhost:3040/schemas/JobV1.json#",
-  "name": "invalid manif@st",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "displayName": "some-displayName",
-  "description": "some-description",
-  "concurrency": 1,
-  "timeout": 10000,
-  "functions": [
-    {
-      "entry": "main.js",
-      "name": "main",
-      "input": {
-        "type": "object",
-        "properties": {
-          "something": {
-            "type": "string"
-          }
-        },
-        "required": ["something"]
-      },
-      "output": {
-        "responseType": "html"
-      }
-    }
-  ]
-}

package/src/integration-tests/__jobs__/invalid-upload/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return 'this is a test job';
-};

package/src/integration-tests/__jobs__/simple-job/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return 'this is a test job';
-};

package/src/integration-tests/__jobs__/simple-job/manifest.json

@@ -1,25 +0,0 @@
-{
-  "$schema": "http://localhost:3040/schemas/JobV1.json#",
-  "name": "simple-job",
-  "displayName": "Simple Job",
-  "version": "1.0.2",
-  "mainFunction": "main",
-  "description": "some-description",
-  "concurrency": 1,
-  "timeout": 10000,
-  "functions": [
-    {
-      "entry": "main.js",
-      "name": "main",
-      "input": {
-        "type": "object",
-        "properties": {
-          "something": {
-            "type": "string"
-          }
-        },
-        "required": ["something"]
-      }
-    }
-  ]
-}

package/src/integration-tests/helper.ts

@@ -1,227 +0,0 @@
-import axios, { AxiosError } from 'axios';
-import path from 'path';
-
-import fsp from 'fs/promises';
-import { randomBytes } from 'crypto';
-import { ComponentSetWebModelForCreate, Manifest, 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 { uploadComponentFolder } from '../upload-component-folder';
-import { buildDevelopmentJwt, DxpServiceId } from '@squiz/dxp-auth-lib';
-
-config();
-
-interface Config {
-  managementServiceUrl: string;
-  renderServiceUrl: string;
-  pageRenderServiceUrl: string;
-  contentServiceUrl: string;
-  tenantId: string;
-  jobServiceUrl: string;
-  ci_buildVersion: string;
-  ci_buildBranch: string;
-}
-
-const configObj: Config = {
-  managementServiceUrl: parseEnvVarForVar('COMPONENT_MANAGEMENT_SERVICE_URL').replace(/\/+$/, ''),
-  pageRenderServiceUrl: parseEnvVarForVar('PAGE_RENDER_SERVICE_URL').replace(/\/+$/, ''),
-  renderServiceUrl: parseEnvVarForVar('COMPONENT_RENDER_SERVICE_URL').replace(/\/+$/, ''),
-  contentServiceUrl: parseEnvVarForVar('CONTENT_API_URL').replace(/\/+$/, ''),
-  tenantId: parseEnvVarForVar('TENANT_ID'),
-  jobServiceUrl: parseEnvVarForVar('JOB_SERVICE_URL').replace(/\/+$/, ''),
-  ci_buildVersion: parseEnvVarForVar('CI_COMMIT_SHORT_SHA'),
-  ci_buildBranch: parseEnvVarForVar('CI_COMMIT_REF_NAME'),
-};
-
-if (!configObj.ci_buildVersion || configObj.ci_buildVersion === `undefined`) {
-  configObj.ci_buildVersion = execSync('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
-}
-
-if (!configObj.ci_buildBranch || configObj.ci_buildBranch === `undefined`) {
-  configObj.ci_buildBranch = execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
-}
-
-export default configObj;
-
-const authToken =
-  'Bearer ' +
-  buildDevelopmentJwt({
-    service: {
-      [DxpServiceId.contentStore]: {
-        privileges: [
-          'CONTENT_SCHEMA_READ',
-          'CONTENT_SCHEMA_WRITE',
-          'CONTENT_ITEM_READ',
-          'CONTENT_ITEM_WRITE',
-          'SETTINGS_READ',
-          'SETTINGS_WRITE',
-          'PAGE_CONTENTS_WRITE',
-          'PAGE_CONTENTS_READ',
-        ],
-      },
-      [DxpServiceId.components]: {
-        privileges: [
-          'COMPONENT_READ',
-          'COMPONENT_WRITE',
-          'COMPONENT_DEPLOY',
-          'COMPONENT_SET_WRITE',
-          'COMPONENT_DELETE',
-          'COMPONENT_SET_WRITE',
-          'COMPONENT_SET_READ',
-          'COMPONENT_SET_ENVIRONMENT_READ',
-          'COMPONENT_SET_ENVIRONMENT_WRITE',
-        ],
-      },
-      [DxpServiceId.segmentation]: {
-        privileges: ['SEGMENT_READ'],
-      },
-    },
-  });
-
-export const managementService = axios.create({
-  baseURL: configObj.managementServiceUrl + '/v1',
-  headers: {
-    Authorization: authToken,
-  },
-});
-
-export const managementServiceRoot = axios.create({
-  baseURL: configObj.managementServiceUrl,
-  headers: {
-    Authorization: authToken,
-  },
-});
-
-export const renderService = axios.create({
-  baseURL: configObj.renderServiceUrl,
-});
-
-export const contentService = axios.create({
-  baseURL: configObj.contentServiceUrl,
-  headers: {
-    Authorization: authToken,
-  },
-});
-
-export const pageRenderService = axios.create({
-  baseURL: configObj.pageRenderServiceUrl,
-});
-
-export const jobService = axios.create({
-  baseURL: configObj.jobServiceUrl,
-  headers: {
-    Authorization: authToken,
-  },
-});
-
-export const ci_buildVersion = configObj.ci_buildVersion;
-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' }));
-  return await manifestService.listAllComponentManifests();
-}
-
-export async function getTestComponent(componentFolderName: string) {
-  const componentsDir = path.join(__dirname, '/__components__/', componentFolderName);
-  const manifestService = new ManifestServiceForDev(componentsDir, getLogger({ name: 'getTestComponents' }));
-  return await manifestService.listAllComponentManifests();
-}
-
-export async function getTestJobs() {
-  const jobsDir = path.join(__dirname, '/__jobs__/');
-  const manifestService = new ManifestServiceForDev(jobsDir, getLogger({ name: 'getTestJobs' }));
-  return await manifestService.listAllComponentManifests();
-}
-
-export async function createFile(filePath: string, sizeInMB: number) {
-  const content = randomBytes(sizeInMB * 1000000);
-  await fsp.writeFile(`${filePath}`, content);
-}
-
-export function removeFile(filePath: string) {
-  fsp.unlink(filePath);
-}
-
-export async function deleteComponentSet(webPath: string) {
-  try {
-    await managementService.delete(`/component-set/${webPath}`);
-  } catch (error) {
-    // no ops
-  }
-}
-
-export async function addComponentSet(componentSet: ComponentSetWebModelForCreate) {
-  try {
-    await managementService.post(`/component-set`, componentSet);
-  } catch (error) {
-    //no ops
-  }
-}
-
-export async function addContentItem(contentItem: ContentApi.ContentItemWebModel) {
-  try {
-    await contentService.post(`/content-item`, contentItem);
-  } catch (error) {
-    //no ops
-  }
-}
-
-export async function deleteContentItem(contentItemId: string) {
-  try {
-    await contentService.delete(`/content-item/${contentItemId}`);
-  } catch (error) {
-    //no ops
-  }
-}
-
-export async function deleteContentSchema(contentSchemaName: string) {
-  try {
-    await contentService.delete(`/content-item/${contentSchemaName}`);
-  } catch (error) {
-    //no ops
-  }
-}
-
-export async function deleteComponent(manifest: Manifest) {
-  try {
-    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;
-    }
-  }
-}
-
-export async function deleteComponents(manifests: Manifest[]) {
-  await Promise.all(manifests.map((manifest) => deleteComponent(manifest)));
-}
-
-export async function uploadTestComponent(componentFolderPath: string, tempFolderPath: string): Promise<void> {
-  const componentPath = path.join(__dirname, componentFolderPath);
-  await uploadComponentFolder(managementServiceRoot, configObj.managementServiceUrl, componentPath, tempFolderPath);
-}
-
-export async function deleteJob(manifest: Manifest) {
-  try {
-    await jobService.delete(`/job/${manifest.getName()}/${manifest.getVersion()}`);
-  } catch (error) {
-    if ((error as AxiosError).response?.status === 404) {
-      const logger = getLogger({ name: 'delete job' });
-      logger.info('job not found');
-    } else {
-      throw error;
-    }
-  }
-}
-
-export async function deleteJobs(manifests: Manifest[]) {
-  await Promise.all(manifests.map((manifest) => deleteJob(manifest)));
-}

package/src/integration-tests/service-deployment.integration.spec.ts

@@ -1,74 +0,0 @@
-import {
-  renderService,
-  managementService,
-  contentService,
-  managementServiceRoot,
-  ci_buildVersion,
-  ci_buildBranch,
-} from './helper';
-
-interface HealthInfo {
-  status: string;
-  buildVersion: string;
-  buildBranch: string;
-}
-
-describe('Verify latest services deployments', () => {
-  it.skip('Should have latest Management API service', async () => {
-    const response: HealthInfo = (await managementServiceRoot.get('/health')).data;
-    expect(response.buildVersion).toBe(ci_buildVersion);
-    expect(response.buildBranch).toBe(ci_buildBranch);
-  });
-
-  it('Should return 200 for Management API docs', async () => {
-    const req = await managementService.get('/v1/docs', {
-      baseURL: managementService.defaults.baseURL?.replace(/v1\/?/, ''),
-    });
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('text/html; charset=utf-8');
-  });
-
-  it('Should return 200 for Management API docs.json', async () => {
-    const req = await managementService.get('/v1/docs.json', {
-      baseURL: managementService.defaults.baseURL?.replace(/v1\/?/, ''),
-    });
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('application/json; charset=UTF-8');
-  });
-
-  it.skip('Should have latest Render Runtime service', async () => {
-    const response: HealthInfo = (await renderService.get('/health')).data;
-    expect(response.buildVersion).toBe(ci_buildVersion);
-    expect(response.buildBranch).toBe(ci_buildBranch);
-  });
-
-  it('Should return 200 for Render Runtime API docs', async () => {
-    const req = await renderService.get('/docs');
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('text/html; charset=utf-8');
-  });
-
-  it('Should return 200 for Render Runtime API docs.json', async () => {
-    const req = await renderService.get('/docs.json');
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('application/json; charset=UTF-8');
-  });
-
-  it.skip('Should have latest Content API service', async () => {
-    const response: HealthInfo = (await contentService.get('/health')).data;
-    expect(response.buildVersion).toBe(ci_buildVersion);
-    expect(response.buildBranch).toBe(ci_buildBranch);
-  });
-
-  it('Should return 200 for Content API docs', async () => {
-    const req = await contentService.get('/docs');
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('text/html; charset=utf-8');
-  });
-
-  it('Should return 200 for Content API docs.json', async () => {
-    const req = await contentService.get('/docs.json');
-    expect(req.status).toBe(200);
-    expect(req.headers['content-type']).toEqual('application/json; charset=UTF-8');
-  });
-});

package/src/integration-tests/test-setup.ts

@@ -1 +0,0 @@
-jest.setTimeout(60_000);

package/src/upload-component-folder.ts

@@ -1,130 +0,0 @@
-import { uploadFile } from '@squiz/virus-scanner-lib';
-
-import { zipDirectory } from '@squiz/dx-common-lib';
-import { ManifestServiceForDev } from '@squiz/component-lib';
-import fsp from 'fs/promises';
-import path from 'path';
-import { AxiosInstance } from 'axios';
-import color from 'cli-color';
-import { getLogger, Logger } from '@squiz/dx-logger-lib';
-import {
-  watchAndWaitForUploadAndScanComplete,
-  checkIfVersionExists,
-  handleResponse,
-  isAxiosResponse,
-  isUserInOrganization,
-  assertComponentTypeAllowed,
-} from './utils';
-
-export const logger: Logger = getLogger({ name: 'upload-component', format: 'human' });
-
-export async function uploadComponentFolder(
-  apiClient: AxiosInstance,
-  componentServiceManagementUrl: string,
-  folderPath: string,
-  baseTempDir: string = '',
-): Promise<void> {
-  if (folderPath === '.') {
-    // Ensures that the cmp-upload folder and zipping process is consistent,
-    // whether the deploy was called outside or inside the component folder.
-    // eg: dxp-next-cli cmp deploy [componentFolder] || dxp-next-cli cmp deploy .
-    baseTempDir = '../';
-  }
-  const tmpDir = await fsp.mkdtemp(path.resolve(baseTempDir, 'cmp-upload'));
-
-  try {
-    const manifestService = new ManifestServiceForDev(folderPath, logger);
-    const manifestPath = path.join(folderPath, `manifest.json`);
-    const manifest = await manifestService.readManifest(manifestPath);
-
-    await assertComponentTypeAllowed(manifest.type, apiClient, '/health', componentServiceManagementUrl);
-
-    const shouldValidateNamespace = !isUserInOrganization();
-    await manifestService.assertManifestIsValid(manifestPath, manifest.getModel(), {
-      validateNamespace: shouldValidateNamespace,
-    });
-
-    if (
-      await checkIfVersionExists(
-        apiClient,
-        `/v1/component/${manifest.getName()}/${manifest.getVersion()}`,
-        componentServiceManagementUrl,
-      )
-    ) {
-      throw new Error(`Cannot upload component version, ${manifest.getName()} ${manifest.getVersion()} already exists`);
-    }
-    logger.info('Initial scanning');
-    const zip = await zipDirectory(folderPath, tmpDir);
-
-    const initialUpload = await handleResponse<any>(
-      apiClient.post('/v1/upload-component', {}, { baseURL: componentServiceManagementUrl }),
-    );
-
-    logger.info(`deployment id: ${initialUpload.id} status: transferring`);
-    await uploadFile(initialUpload, zip);
-
-    await watchAndWaitForUploadAndScanComplete(
-      apiClient,
-      '/v1/upload-component/status/',
-      initialUpload.id,
-      componentServiceManagementUrl,
-    );
-
-    logger.info(`deployment id: ${initialUpload.id} status: deploying component folder`);
-
-    //Rarely this call will return 504, while successfully uploading the component - the cause is currently unknown
-    let result = await handleResponse<any>(
-      apiClient.post(`/v1/upload-component/next/${initialUpload.id}`, {}, { baseURL: componentServiceManagementUrl }),
-    );
-
-    if (!isAxiosResponse(result)) {
-      let retriesAllowed = 12;
-      while (retriesAllowed > 0) {
-        logger.info(
-          `deployment id: ${initialUpload.id} status: ${color.yellow(
-            `unknown, retrying to check the upload status ${retriesAllowed} more times`,
-          )}`,
-        );
-        if (
-          await checkIfVersionExists(
-            apiClient,
-            `/v1/component/${manifest.getName()}/${manifest.getVersion()}`,
-            componentServiceManagementUrl,
-          )
-        ) {
-          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 to check the upload status')}`);
-        throw new Error(result.toString());
-      }
-    }
-
-    await fsp.rm(tmpDir, { force: true, recursive: true }).catch((error: any) => {
-      logger.error('failed to remove temp directory', error);
-    });
-
-    if (result.status === 'successful') {
-      logger.info(`deployment id: ${initialUpload.id} status: ${color.green('success')}`);
-      logger.info(`uploaded location: ${result.accessLink}`);
-    } else {
-      const message = result?.message ?? 'unknown';
-      logger.error(`failed due an unexpected reason: ${message}`);
-      await fsp.rm(tmpDir, { force: true, recursive: true }).catch((error: any) => {
-        logger.error('failed to remove temp directory', error);
-      });
-    }
-  } catch (e) {
-    await fsp.rm(tmpDir, { force: true, recursive: true }).catch((error: any) => {
-      logger.error('failed to remove temp directory', error);
-    });
-    throw e;
-  }
-}