@squiz/component-cli-lib 1.69.0 → 1.70.0

package/jest.config.ts

@@ -1,28 +0,0 @@
-import type { Config } from 'jest';
-import path from 'path';
-
-process.env.DATA_MOUNT_POINT = path.join(__dirname, '..', '..', 'test-components');
-process.env.SQUIZ_REGION = 'au';
-process.env.DEPLOYMENT_ENVIRONMENT = 'dev';
-
-// Sync object
-const config: Config = {
-  preset: 'ts-jest',
-  testTimeout: 60_000,
-  testEnvironment: 'node',
-  passWithNoTests: true,
-  testPathIgnorePatterns: [
-    '<rootDir>/lib/',
-    '<rootDir>/src/integration-tests',
-    '<rootDir>/src/test.ts',
-    '.*\\.integration\\.spec\\.ts$',
-  ],
-  maxWorkers: 1,
-  globals: {
-    'ts-jest': {
-      tsconfig: 'tsconfig.json',
-    },
-  },
-};
-
-export default config;

package/jest.integration.config.ts

@@ -1,27 +0,0 @@
-import { execSync } from 'child_process';
-import type { Config } from 'jest';
-import { defaultIntegrationConfig } from '../../jest.config';
-import { config as dotEnvConfig } from 'dotenv';
-dotEnvConfig();
-
-process.env.CI_COMMIT_SHORT_SHA ??= execSync('git rev-parse --short=8 HEAD', { encoding: 'utf-8' }).trim();
-process.env.CI_COMMIT_REF_NAME ??= execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
-process.env.SQUIZ_REGION = 'au';
-process.env.DEPLOYMENT_ENVIRONMENT = 'dev';
-process.env.TENANT_ID ??= 'my-tenant';
-
-// Sync object
-const config: Config = {
-  ...defaultIntegrationConfig,
-  maxWorkers: 1,
-
-  setupFiles: ['./src/integration-tests/test-setup.ts'],
-  detectOpenHandles: true,
-
-  globals: {
-    BUILD_VERSION: process.env.CI_COMMIT_SHORT_SHA,
-    BUILD_BRANCH: process.env.CI_COMMIT_REF_NAME,
-  },
-};
-
-export default config;

package/localStart.ts

@@ -1,11 +0,0 @@
-import path from 'path';
-import { startDevelopmentRender } from './src';
-
-async function startRender() {
-  const componentPath = path.resolve(process.cwd(), process.argv[2]);
-
-  console.log('Starting render for ' + componentPath);
-  const _server = startDevelopmentRender(componentPath, { port: 3101, loggingFormat: 'human' });
-}
-
-startRender();

package/src/component-dev-folder-structures.integration.spec.ts

@@ -1,91 +0,0 @@
-import supertest from 'supertest';
-import path from 'path';
-import fsp from 'fs/promises';
-
-import { TestHelpers } from '@squiz/render-runtime-lib/test-helpers';
-import { startDevelopmentRender } from './component-dev';
-import { Server } from 'http';
-
-jest.setTimeout(20_000);
-
-describe('component-dev', () => {
-  describe('production style folder structure', () => {
-    let server: Server;
-    let request: supertest.SuperTest<supertest.Test>;
-    beforeAll(async () => {
-      server = startDevelopmentRender(TestHelpers.getTestComponentFolder(), { port: 0, noBrowser: true });
-      request = supertest(server);
-    });
-
-    afterAll(async () => {
-      server.close();
-    });
-
-    it('should find the component', async () => {
-      const response = await request.get(
-        `/r/unit-test-components/test-component/1.0.10?_componentSet=set&something=hello`,
-      );
-      expect(response.text).toEqual('<div>hello - {}</div>');
-    });
-  });
-
-  describe('local developer style folders', () => {
-    let version: string;
-    let componentName: string;
-    let fixtureDirectory: string;
-    let server: Server;
-    let request: supertest.SuperTest<supertest.Test>;
-
-    beforeAll(async () => {
-      const {
-        fixtureDirectory: createdFixtureDirectory,
-        version: createdVersion,
-        componentName: createdName,
-      } = await TestHelpers.ComponentFixture.setupFullComponentDirectory('<h1>Hello World</h1>');
-
-      version = createdVersion;
-      fixtureDirectory = createdFixtureDirectory;
-      componentName = createdName;
-
-      server = startDevelopmentRender(fixtureDirectory, { port: 0, noBrowser: true });
-      request = supertest(server);
-    });
-    afterAll(async () => {
-      server.close();
-    });
-
-    afterAll(async () => {
-      await fsp.rm(path.join(fixtureDirectory, componentName), { force: true, recursive: true });
-    });
-
-    it('should handle recursing folders to find the component', async () => {
-      const response = await request.get(`/r/some-namespace/${componentName}/${version}?_componentSet=set`);
-      expect(response.text).toEqual('<h1>Hello World</h1>');
-    }, 30_000);
-
-    it('should handle serving static files from single component directory', async () => {
-      const response = await request.get(
-        `/s/some-namespace/${componentName}/${version}/static.txt?_componentSet=set-x`,
-      );
-      expect(response.text).toEqual('hello');
-    });
-  });
-
-  describe('It should pass a simple test and not launch the browser if the -nb flag is present', () => {
-    let server: Server;
-    let request: supertest.SuperTest<supertest.Test>;
-    beforeAll(async () => {
-      server = startDevelopmentRender(TestHelpers.getTestComponentFolder(), { port: 0, noBrowser: true });
-      request = supertest(server);
-    });
-    afterAll(async () => {
-      server.close();
-    });
-    it('should find the component', async () => {
-      const response = await request.get(
-        `/r/unit-test-components/test-component/1.0.10?_componentSet=set&something=hello`,
-      );
-      expect(response.text).toEqual('<div>hello - {}</div>');
-    });
-  });
-});

package/src/component-dev.integration.spec.ts

@@ -1,71 +0,0 @@
-import { routeTests, TestHelpers } from '@squiz/render-runtime-lib/test-helpers';
-import { startDevelopmentRender } from './component-dev';
-import supertest from 'supertest';
-import { Server } from 'http';
-
-jest.setTimeout(20_000);
-
-describe('component-dev', () => {
-  describe('accessing local dev routes', () => {
-    let server: Server;
-    let request: supertest.SuperTest<supertest.Test>;
-
-    beforeAll(async () => {
-      server = startDevelopmentRender(TestHelpers.getTestComponentFolder(), { port: 0, noBrowser: true });
-      request = supertest(server);
-    });
-
-    afterAll(async () => {
-      server.close();
-    });
-
-    it('should fail validation when requesting a function with a missing entry file', async () => {
-      const response = await request.get(
-        '/r/unit-test-components/test-component/1.0.3/main?_componentSet=set&something=not-used',
-      );
-
-      expect(response.body).toEqual({
-        message: '"main\'s" entry file "missing-entry-file.js" is inaccessible',
-      });
-      expect(response.statusCode).toEqual(500);
-    });
-
-    describe('definition routes', () => {
-      routeTests.definition(() => request, 'http://localhost:0');
-    });
-
-    describe('static routes', () => {
-      routeTests.static(() => request);
-    });
-
-    describe('render routes', () => {
-      routeTests.render(() => request, 'http://localhost:0');
-    });
-
-    describe('preview tests', () => {
-      routeTests.preview(() => request, 'http://localhost:0');
-    });
-
-    describe('development tests', () => {
-      routeTests.development(() => request, true);
-    });
-
-    describe('user experience', () => {
-      describe('on navigation to a component without preview from home page it should still try and render by default', () => {
-        it('should successfully try to render a component with a dummy set', async () => {
-          const listingResponse = await request.get('/');
-          // Component with no preview
-          expect(listingResponse.text).toContain(
-            '/r/unit-test-components/test-component/1.0.10?_componentSet=local-development-only',
-          );
-
-          const renderResponse = await request.get(
-            '/r/unit-test-components/test-component/1.0.10?_componentSet=local-development-only',
-          );
-
-          expect(renderResponse.statusCode).toEqual(200);
-        });
-      });
-    });
-  });
-});

package/src/component-dev.ts

@@ -1,102 +0,0 @@
-import {
-  ComponentRootUrlResolver,
-  ComponentPreviewService,
-  ComponentRunnerServiceWithWorkers,
-  RenderInputService,
-  setupRenderRuntimeServer,
-} from '@squiz/render-runtime-lib';
-import { NodeSandbox } from '@squiz/runtime-sandbox-node';
-import { getLogger, LoggerOptions } from '@squiz/dx-logger-lib';
-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
- * local directory. This should start an express server on a random unused port
- * which can be accessed for viewing the component in development.
- * @param {string} componentPath - The directory with the component to be rendered
- * @param {object} options - Additional configuration for the dev stack
- * @returns a function to stop the render stack
- */
-export function startDevelopmentRender(
-  componentPath: string,
-  options: { port: number; loggingFormat?: LoggerOptions['format']; noBrowser?: boolean },
-) {
-  const logger = getLogger({
-    name: 'component-dev',
-    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',
-    serviceName: 'component-dev',
-  });
-
-  const dataMountPoint = path.resolve(process.cwd(), componentPath);
-
-  const rootUrl = `http://localhost:${options.port}`;
-  const componentRootUrlResolver: ComponentRootUrlResolver = () => rootUrl;
-
-  const apiKeyService = new DevelopmentApiKeyService();
-  const sandbox = new NodeSandbox({
-    workerPool: {
-      shouldCacheResponses: false,
-      workerLimits: {
-        minWorkers: 2,
-        maxWorkers: 2,
-      },
-    },
-  });
-  const componentRunnerService = new ComponentRunnerServiceWithWorkers(sandbox, logger, devComponentLogger);
-  const componentFunctionService = new ComponentFunctionService();
-  const componentSetService = new ComponentSetServiceForLocalDev(logger);
-  const manifestService = new ManifestServiceForDev(dataMountPoint, logger);
-  const contentItemService = undefined;
-  const renderInputService = new RenderInputService(
-    apiKeyService,
-    componentSetService,
-    manifestService,
-    componentFunctionService,
-    contentItemService,
-    componentRootUrlResolver,
-  );
-  const webServer = setupRenderRuntimeServer(
-    {
-      logger,
-      componentRunnerService,
-      componentFunctionService,
-      componentPreviewService: new ComponentPreviewService(),
-      componentSetService,
-      manifestService,
-      renderInputService,
-      apiKeyService,
-      sandbox,
-      componentRootUrlResolver,
-    },
-    {
-      enableDevMode: true,
-    },
-  );
-
-  const server = webServer.listen(options.port, () => {
-    logger.info(`Component development webserver started on port ${rootUrl}`);
-  });
-
-  if (options?.noBrowser !== true) {
-    open(rootUrl);
-  }
-
-  server.on('close', async () => {
-    await componentRunnerService.stop();
-  });
-
-  return server;
-}

package/src/component-edge-dev.ts

@@ -1,75 +0,0 @@
-import {
-  ComponentRootUrlResolver,
-  ComponentPreviewService,
-  RenderInputService,
-  setupRenderRuntimeServer,
-  DevelopmentComponentRunnerService,
-} from '@squiz/edge-dev-render-runtime-lib';
-import { getLogger, LoggerOptions } from '@squiz/dx-logger-lib';
-import path from 'path';
-import { ComponentFunctionService, ComponentSetServiceForLocalDev, ManifestServiceForDev } from '@squiz/component-lib';
-import open from 'open';
-
-/**
- * startDevelopmentRender starts a dev-mode render stack for any
- * local directory. This should start an express server on a random unused port
- * which can be accessed for viewing the component in development.
- * @param {string} componentPath - The directory with the component to be rendered
- * @param {object} options - Additional configuration for the dev stack
- * @returns a function to stop the render stack
- */
-export function startEdgeDevelopmentRender(
-  componentPath: string,
-  options: { port: number; loggingFormat?: LoggerOptions['format']; noBrowser?: boolean },
-) {
-  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}`;
-  const componentRootUrlResolver: ComponentRootUrlResolver = () => rootUrl;
-
-  const developmentComponentRunnerService = new DevelopmentComponentRunnerService();
-  const componentFunctionService = new ComponentFunctionService();
-  const componentSetService = new ComponentSetServiceForLocalDev(logger);
-  const manifestService = new ManifestServiceForDev(dataMountPoint, logger);
-  const renderInputService = new RenderInputService(
-    componentSetService,
-    manifestService,
-    componentFunctionService,
-    componentRootUrlResolver,
-  );
-  const webServer = setupRenderRuntimeServer(
-    {
-      logger,
-      developmentComponentRunnerService,
-      componentFunctionService,
-      componentPreviewService: new ComponentPreviewService(),
-      componentSetService,
-      manifestService,
-      renderInputService,
-      componentRootUrlResolver,
-    },
-    {
-      enableDevMode: true,
-    },
-  );
-
-  const server = webServer.listen(options.port, () => {
-    logger.info(`Edge Component development webserver started on port ${rootUrl}`);
-  });
-
-  if (options?.noBrowser !== true) {
-    open(rootUrl);
-  }
-
-  server.on('close', async () => {
-    // nothing to do
-  });
-
-  return server;
-}

package/src/component-init.spec.ts

@@ -1,258 +0,0 @@
-import componentInit from './component-init';
-import fs from 'fs-extra';
-import * as logger from '@squiz/dx-logger-lib';
-import path from 'path';
-
-jest.mock('fs-extra');
-jest.mock('path', () => {
-  return {
-    ...jest.requireActual('path'),
-  };
-});
-
-const fsMocked = jest.mocked(fs);
-
-beforeEach(() => {
-  jest.restoreAllMocks();
-  fsMocked.readJSON.mockResolvedValue({});
-
-  // Reset our process.env.NODE_ENV variable
-  process.env.NODE_ENV = 'test';
-});
-
-describe('componentInit', () => {
-  it('should setup a new logger instance with the correct options', async () => {
-    const loggerSpy = jest.spyOn(logger, 'getLogger');
-
-    // Mock the process.env.NODE_ENV variable to be "development"
-    process.env.NODE_ENV = 'development';
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(loggerSpy).toHaveBeenCalledWith({
-      name: 'component-dev',
-      format: 'human',
-      silent: false,
-    });
-  });
-
-  it('path.resolve should be called with __dirname to get the current script directory', async () => {
-    const pathResolveSpy = jest.spyOn(path, 'resolve');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(pathResolveSpy).toHaveBeenCalledWith(__dirname);
-  });
-
-  it('path.join should be called with the current script directory and the component type to get the source folder', async () => {
-    const pathJoinSpy = jest.spyOn(path, 'join');
-
-    jest
-      .spyOn(path, 'resolve')
-      .mockReturnValue('/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(pathJoinSpy).toHaveBeenCalledWith(
-      '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src',
-      'templates',
-      'basic',
-    );
-  });
-
-  it('path.resolve should be called with the destination folder to get the destination folder', async () => {
-    const pathResolveSpy = jest.spyOn(path, 'resolve');
-
-    jest.spyOn(path, 'resolve').mockReturnValue('/Users/username/Projects/squiz/new-component');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(pathResolveSpy).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component');
-  });
-
-  it('should fail if the destination folder already exists and there are files in it', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdirSync function to return an array of files
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve(['file1.txt', 'file2.txt']);
-    });
-
-    await expect(
-      componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      }),
-    ).rejects.toThrowError('The destination folder already exists and is not empty.');
-  });
-
-  it('should create the destination folder if it does not exist', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return false
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(false);
-    });
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(fs.mkdirp).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component');
-  });
-
-  it('should not fail if the destination folder already exists and there are no files in it', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdir function to return an empty array
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve([]);
-    });
-
-    await expect(
-      componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      }),
-    ).resolves.toBeUndefined();
-  });
-
-  it('fs.copy should be called with the source folder and the destination folder', async () => {
-    // Mock the fs.copy function
-    const fsCopySpy = jest.spyOn(fs, 'copy');
-
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the source folder
-    jest.spyOn(path, 'join').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/templates/basic';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdir function to return an empty array
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve([]);
-    });
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(fsCopySpy).toHaveBeenCalledWith(
-      '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/templates/basic',
-      '/Users/username/Projects/squiz/new-component',
-    );
-  });
-
-  describe('prompts', () => {
-    it('should default when no prompts provided', async () => {
-      await componentInit({ componentType: 'basic', destination: '' });
-
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        expect.any(String),
-        expect.objectContaining({
-          name: 'default',
-          namespace: 'default-namespace',
-          displayName: 'Default',
-        }),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-
-    it('should overwrite default values with provided values', async () => {
-      await componentInit({
-        componentType: 'basic',
-        destination: '',
-        prompts: {
-          name: 'my-component',
-          namespace: 'my-namespace',
-          displayName: 'My Component',
-        },
-      });
-
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        expect.any(String),
-        expect.objectContaining({
-          name: 'my-component',
-          namespace: 'my-namespace',
-          displayName: 'My Component',
-        }),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-
-    it('should read and write the destination manifest file', async () => {
-      await componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      });
-
-      expect(fsMocked.readJSON).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component/manifest.json');
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        '/Users/username/Projects/squiz/new-component/manifest.json',
-        expect.any(Object),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-  });
-});