@squiz/component-cli-lib 1.2.1-alpha.106 → 1.2.1-alpha.17

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

@@ -1,21 +0,0 @@
-import { renderService, managementService, ci_buildVersion, ci_buildBranch } from './helper';
-
-interface HealthInfo {
-  status: string;
-  buildVersion: string;
-  buildBranch: string;
-}
-
-describe('Verify latest services deployments', () => {
-  it('Should have latest Management API service', async () => {
-    const response: HealthInfo = (await managementService.get('/health')).data;
-    expect(response.buildVersion).toBe(ci_buildVersion);
-    expect(response.buildBranch).toBe(ci_buildBranch);
-  });
-
-  it('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);
-  });
-});

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

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

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

@@ -1,141 +0,0 @@
-import { uploadComponentFolder } from '../index';
-import configObj, {
-  renderService,
-  managementService,
-  getTestComponents,
-  createFile,
-  removeFile,
-  addComponentSet,
-  deleteComponentSet,
-} from './helper';
-import color from 'cli-color';
-import path from 'path';
-import supertest from 'supertest';
-import { logger } from '../upload-component-folder';
-import { ComponentSetWebModel } from '@squiz/component-lib';
-
-const mockConsoleError = jest.fn();
-const mockConsoleLog = jest.fn();
-
-const orgConsoleError = console.error;
-const webPath = 'set';
-
-afterAll(async () => {
-  // clean up the component added by the test
-  await deleteComponentSet(webPath);
-
-  for (const componentName of getTestComponents()) {
-    try {
-      await managementService.delete(`/component/${componentName}`);
-    } catch {
-      // no op
-    }
-  }
-});
-
-describe('Test isolated test cases', () => {
-  beforeEach(() => {
-    jest.spyOn(logger, 'error').mockImplementation(mockConsoleError);
-    jest.spyOn(logger, 'info').mockImplementation(mockConsoleLog);
-  });
-
-  it('Should fail uploading a component without manifest.json', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/invalid-upload');
-    await uploadComponentFolder(componentPath, configObj.managementServiceUrl, configObj.renderServiceUrl);
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(color.red('manifest could not be found'));
-  });
-
-  it('Should fail uploading a component that has invalid manifest.json', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/invalid-manifest');
-    await uploadComponentFolder(componentPath, configObj.managementServiceUrl, configObj.renderServiceUrl);
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red('/name: pattern must match pattern "^[a-zA-Z0-9_\\-]+$"'),
-    );
-  });
-
-  it('Should fail uploading the component that has size more than 100MB', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/big-package');
-    const filePath = `${componentPath}/105mb-file`;
-    await createFile(filePath, 105); // Higher limit has been used because compression reduces the size if you use closer to 100MB
-    await uploadComponentFolder(componentPath, configObj.managementServiceUrl, configObj.renderServiceUrl);
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red(['File size exceeds the maximum limit of 100MB'].join('')),
-    );
-    removeFile(filePath);
-  });
-});
-
-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);
-    for (const componentName of getTestComponents()) {
-      try {
-        await managementService.delete(`/component/${componentName}`);
-      } catch {
-        // no op
-      }
-    }
-  });
-
-  beforeEach(() => {
-    console.error = mockConsoleError;
-    console.log = mockConsoleLog;
-  });
-
-  afterEach(() => {
-    console.error = orgConsoleError;
-  });
-
-  it('Should upload the component and return a valid url to preview', async () => {
-    mockConsoleLog.mockClear();
-    console.log(configObj.managementServiceUrl, configObj.renderServiceUrl);
-
-    await uploadComponentFolder(componentPath, configObj.managementServiceUrl, configObj.renderServiceUrl);
-
-    const url = /uploaded location: (.*)/.exec(mockConsoleLog.mock.lastCall)?.[1] || '';
-    const uploadedComponent = '<a href="/r/set/cmp-static-file-test/1.0.0">1.0.0</a>';
-    const get = await supertest(url).get('/');
-
-    expect(get.status).toEqual(200);
-    expect((get as any)?.res?.text).toContain(uploadedComponent);
-  });
-
-  it('Should fail upload the component with same version', async () => {
-    mockConsoleError.mockClear();
-    await uploadComponentFolder(componentPath, configObj.managementServiceUrl, configObj.renderServiceUrl);
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red('Cannot upload component version, cmp-static-file-test 1.0.0 already exists'),
-    );
-  });
-
-  it('Should render component', async () => {
-    const componentSet: ComponentSetWebModel = {
-      webPath,
-      displayName: 'Set',
-      description: 'Set description',
-      headers: {},
-      envVars: {},
-      components: {
-        'cmp-static-file-test': [{ envVars: {}, version: '1.0.0' }],
-      },
-    };
-
-    await addComponentSet(componentSet);
-
-    const response = await renderService.get('/r/set/cmp-static-file-test/1.0.0/?something=hello');
-    expect(response.status).toEqual(200);
-    expect(response.data).toEqual(
-      [
-        '<div>Input: hello</div>',
-        '<div>cmp-static-file-test 1.0.0 ',
-        `${configObj.renderServiceUrl}/s/cmp-static-file-test/1.0.0/birthday-cake.png</div>`,
-      ].join(''),
-    );
-  });
-});

package/src/upload-component-folder.ts

@@ -1,137 +0,0 @@
-import { ScanStatus, uploadFile } from '@squiz/virus-scanner-lib';
-import { loadManifest } from '@squiz/component-lib';
-import { zipDirectory } from '@squiz/dx-common-lib';
-import { V1 } from '@squiz/component-lib';
-import fsp from 'fs/promises';
-import path from 'path';
-import axios, { AxiosResponse, AxiosError, AxiosInstance } from 'axios';
-import color from 'cli-color';
-import { getLogger, Logger } from '@squiz/dx-logger-lib';
-
-export const logger: Logger = getLogger({ name: 'upload-component', format: 'human' });
-
-export async function uploadComponentFolder(
-  folderPath: string,
-  componentServiceManagementUrl: string,
-  componentRenderServiceUrl: string,
-): Promise<void> {
-  const tmpDir = path.resolve(await fsp.mkdtemp('cmp-upload'));
-
-  try {
-    const axiosInstance = axios.create({
-      baseURL: componentServiceManagementUrl,
-      headers: {
-        'content-type': 'application/json',
-      },
-    });
-
-    await preUploadChecks(folderPath, componentRenderServiceUrl);
-    logger.info('Initial scanning');
-    const zip = await zipDirectory(folderPath, tmpDir);
-
-    const initialUpload = await handleResponse<any>(axiosInstance.post('upload-component'));
-
-    logger.info(`deployment id: ${initialUpload.id} status: transferring`);
-    await uploadFile(initialUpload, zip);
-
-    await watchAndWaitForUploadAndScanComplete(initialUpload.id, axiosInstance);
-
-    logger.info(`deployment id: ${initialUpload.id} status: deploying component folder`);
-    const result = await handleResponse<any>(axiosInstance.post(`upload-component/next/${initialUpload.id}`));
-
-    await fsp.rm(tmpDir, { force: true, recursive: true });
-
-    if (result.status === 'successful') {
-      logger.info(`deployment id: ${initialUpload.id} status: ${color.green('success')}`);
-      logger.info(`uploaded location: ${result.accessLink}`);
-    } else {
-      logger.error('failed for an unknown reason', color.red(result));
-    }
-  } catch (e) {
-    await fsp.rm(tmpDir, { force: true, recursive: true });
-
-    if (e instanceof Error) {
-      logger.error(color.red(e.message));
-    } else {
-      throw e;
-    }
-  }
-}
-
-async function preUploadChecks(folderPath: string, renderService: string) {
-  const result = await loadManifest(path.join(folderPath, `manifest.json`));
-  if (await checkIfVersionExists(result, renderService)) {
-    throw new Error(`Cannot upload component version, ${result.name} ${result.version} already exists`);
-  }
-}
-
-async function checkIfVersionExists(inputManifest: V1, renderService: string) {
-  const axiosInstance = axios.create({
-    baseURL: renderService,
-  });
-
-  try {
-    const response = await axiosInstance.get(`d/${inputManifest.name}/${inputManifest.version}/manifest.json`);
-    if (response.status === 200) {
-      return true;
-    }
-    throw new Error(`Unexpected response code ${response.status}`);
-  } catch (error) {
-    if (isAxiosError(error)) {
-      const { response } = error;
-      if (response?.status === 404) {
-        return false;
-      }
-    }
-    throw error;
-  }
-}
-
-async function watchAndWaitForUploadAndScanComplete(id: string, axiosInstance: AxiosInstance): Promise<void> {
-  const poll = () => handleResponse<ScanStatus>(axiosInstance.get('upload-component/status/' + id));
-
-  return new Promise((resolve, reject) => {
-    const recurse = () =>
-      poll().then(async (req) => {
-        if (req.status == 'Success') {
-          resolve();
-        } else if (req.status == 'Flagged') {
-          reject(new Error('upload has been flagged as a virus'));
-        } else if (req.status == 'Error') {
-          reject(new Error('there has been an error'));
-        } else {
-          setTimeout(async () => {
-            await recurse();
-          }, 1000);
-        }
-      });
-
-    recurse();
-  });
-}
-
-async function handleResponse<T>(axiosInstance: Promise<AxiosResponse<T>>): Promise<T> {
-  try {
-    const response = await axiosInstance;
-    return response.data;
-  } catch (error) {
-    throw handleError(error);
-  }
-}
-
-function handleError(error: any): Error {
-  const { response } = error;
-  if (!response || !isAxiosError(error)) {
-    return error;
-  }
-  const message = (response.data as any).message;
-  if (message) {
-    return new Error(`Unexpected response code ${response.status}. message: ${message}`);
-  } else {
-    return new Error(`Unexpected response code ${response.status}.`);
-  }
-}
-
-function isAxiosError(error: any): error is AxiosError {
-  return error && error.isAxiosError === true;
-}