@squiz/job-runner-lib 1.66.1

package/src/domains/component-set/repositories/ComponentSetComponentVersionEditableRepository.integration.spec.ts

@@ -0,0 +1,172 @@
+import { ComponentSetComponentVersionEditableRepository } from './ComponentSetComponentVersionEditableRepository';
+import { randomUUID } from 'crypto';
+import { createConnectionManager } from '../../db/createConnectionManager';
+import { ComponentConnectionManager } from '../../db/ComponentConnectionManager';
+import path from 'path';
+import { ComponentSet } from '../models/ComponentSet';
+import { ComponentSetComponentVersionEditable } from '../models/ComponentSetComponentVersionEditable';
+
+describe('ComponentSetComponentVersionEditableRepository', () => {
+  let manager: ComponentConnectionManager;
+  let repository: ComponentSetComponentVersionEditableRepository;
+
+  beforeAll(async () => {
+    manager = await createConnectionManager(
+      'component-lib-test',
+      {
+        databaseConnectionString: process.env.COMPONENT_DB_CONNECTION_STRING!,
+      },
+      path.join(__dirname, '../../../../migrations'),
+    );
+    repository = new ComponentSetComponentVersionEditableRepository(manager);
+
+    await manager.applyMigrations();
+  });
+
+  afterAll(() => {
+    manager.close();
+  });
+
+  describe('CRUD', () => {
+    const componentName = 'component-set-component-version-editable-repository - test comp';
+    const componentSetWebPath = randomUUID().substring(0, 5);
+
+    beforeAll(async () => {
+      await manager.repositories.component.addComponent(componentName);
+      await manager.repositories.componentSet.create(
+        new ComponentSet({ webPath: componentSetWebPath, displayName: 'foo' }),
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '1.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '2.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '3.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+    });
+
+    afterAll(async () => {
+      await repository.delete({ componentName });
+      await manager.repositories.componentSet.delete({ webPath: componentSetWebPath });
+      await manager.repositories.componentVersion.delete({ componentName });
+      await manager.repositories.component.delete({ name: componentName });
+    });
+
+    it('should insert', async () => {
+      const result = await repository.create({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+    });
+
+    it('should be able to find one', async () => {
+      const result = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+    });
+
+    it('should throw an error if no properties passed to findOne', async () => {
+      await expect(repository.findOne({})).rejects.toThrowError(
+        new Error('Values cannot be an empty object. It must have at least one property'),
+      );
+    });
+
+    it('should be able to update properties', async () => {
+      const result = await repository.update(
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '1.0.0',
+        },
+        {
+          componentVersion: '2.0.0',
+        },
+      );
+
+      expect(result).toEqual([
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '2.0.0',
+        },
+      ]);
+
+      const updated = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+      });
+      expect(updated).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+      });
+    });
+
+    it('should return component versions grouped by components - getComponentSetEditableVersions', async () => {
+      await repository.create({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      const result = await repository.getComponentSetEditableVersions(componentSetWebPath);
+      expect(result).toMatchInlineSnapshot(`
+        {
+          "component-set-component-version-editable-repository - test comp": [
+            "2.0.0",
+            "1.0.0",
+          ],
+        }
+      `);
+    });
+
+    it('should be able to find many rows', async () => {
+      await repository.create(
+        new ComponentSetComponentVersionEditable({
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '3.0.0',
+        }),
+      );
+      const result = await repository.find({
+        componentSetWebPath: componentSetWebPath,
+      });
+      expect(result).toHaveLength(3);
+
+      const deleteResult = await repository.delete({
+        componentName: componentName,
+      });
+      expect(deleteResult).toEqual(3);
+    });
+  });
+});

package/src/domains/component-set/repositories/ComponentSetComponentVersionEditableRepository.ts

@@ -0,0 +1,47 @@
+import {
+  ComponentSetComponentVersionEditableInterface,
+  ComponentSetComponentVersionEditable,
+} from '../models/ComponentSetComponentVersionEditable';
+import { ComponentRepositories } from '../../db/ComponentRepositories';
+import { AbstractRepository, Pool } from '@squiz/db-lib';
+
+export class ComponentSetComponentVersionEditableRepository extends AbstractRepository<
+  ComponentSetComponentVersionEditableInterface,
+  ComponentSetComponentVersionEditable
+> {
+  constructor(options: { repositories: ComponentRepositories; pool: Pool }) {
+    super(
+      options.repositories,
+      options.pool,
+      'component_set_component_version_editable',
+      {
+        componentSetWebPath: 'component_set_web_path',
+        componentName: 'component_name',
+        componentVersion: 'component_version',
+      },
+      ComponentSetComponentVersionEditable,
+    );
+  }
+
+  async getComponentSetEditableVersions(componentSet: string): Promise<Record<string, string[]>> {
+    const rows = await this.find({ componentSetWebPath: componentSet });
+    const componentVersions: Record<string, string[]> = {};
+    for (const cv of rows) {
+      if (componentVersions[cv.componentName] === undefined) {
+        componentVersions[cv.componentName] = [];
+      }
+      componentVersions[cv.componentName].push(cv.componentVersion);
+    }
+
+    // sort the entries by version, latest at the top
+    Object.entries(componentVersions).forEach(([key, versions]) => {
+      componentVersions[key] = versions.sort((a, b) => {
+        if (a < b) return 1;
+        if (a > b) return -1;
+        return 0;
+      });
+    });
+
+    return componentVersions;
+  }
+}

package/src/domains/component-set/repositories/ComponentSetComponentVersionExcludedRepository.integration.spec.ts

@@ -0,0 +1,172 @@
+import { ComponentSetComponentVersionExcludedRepository } from './ComponentSetComponentVersionExcludedRepository';
+import { randomUUID } from 'crypto';
+import { createConnectionManager } from '../../db/createConnectionManager';
+import { ComponentConnectionManager } from '../../db/ComponentConnectionManager';
+import path from 'path';
+import { ComponentSet } from '../models/ComponentSet';
+import { ComponentSetComponentVersionExcluded } from '../models/ComponentSetComponentVersionExcluded';
+
+describe('ComponentSetComponentVersionExcludedRepository', () => {
+  let manager: ComponentConnectionManager;
+  let repository: ComponentSetComponentVersionExcludedRepository;
+
+  beforeAll(async () => {
+    manager = await createConnectionManager(
+      'component-lib-test',
+      {
+        databaseConnectionString: process.env.COMPONENT_DB_CONNECTION_STRING!,
+      },
+      path.join(__dirname, '../../../../migrations'),
+    );
+    repository = new ComponentSetComponentVersionExcludedRepository(manager);
+
+    await manager.applyMigrations();
+  });
+
+  afterAll(() => {
+    manager.close();
+  });
+
+  describe('CRUD', () => {
+    const componentName = 'component-set-component-version-excluded-repository - test comp';
+    const componentSetWebPath = randomUUID().substring(0, 5);
+
+    beforeAll(async () => {
+      await manager.repositories.component.addComponent(componentName);
+      await manager.repositories.componentSet.create(
+        new ComponentSet({ webPath: componentSetWebPath, displayName: 'foo' }),
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '1.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '2.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '3.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+    });
+
+    afterAll(async () => {
+      await repository.delete({ componentName });
+      await manager.repositories.componentSet.delete({ webPath: componentSetWebPath });
+      await manager.repositories.componentVersion.delete({ componentName });
+      await manager.repositories.component.delete({ name: componentName });
+    });
+
+    it('should insert', async () => {
+      const result = await repository.create({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+    });
+
+    it('should be able to find one', async () => {
+      const result = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+    });
+
+    it('should throw an error if no properties passed to findOne', async () => {
+      await expect(repository.findOne({})).rejects.toThrowError(
+        new Error('Values cannot be an empty object. It must have at least one property'),
+      );
+    });
+
+    it('should be able to update properties', async () => {
+      const result = await repository.update(
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '1.0.0',
+        },
+        {
+          componentVersion: '2.0.0',
+        },
+      );
+
+      expect(result).toEqual([
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '2.0.0',
+        },
+      ]);
+
+      const updated = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+      });
+      expect(updated).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+      });
+    });
+
+    it('should return component versions grouped by components - getComponentSetEditableVersions', async () => {
+      await repository.create({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      const result = await repository.getComponentSetExcludedVersions(componentSetWebPath);
+      expect(result).toMatchInlineSnapshot(`
+        {
+          "component-set-component-version-excluded-repository - test comp": [
+            "2.0.0",
+            "1.0.0",
+          ],
+        }
+      `);
+    });
+
+    it('should be able to find many rows', async () => {
+      await repository.create(
+        new ComponentSetComponentVersionExcluded({
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '3.0.0',
+        }),
+      );
+      const result = await repository.find({
+        componentSetWebPath: componentSetWebPath,
+      });
+      expect(result).toHaveLength(3);
+
+      const deleteResult = await repository.delete({
+        componentName: componentName,
+      });
+      expect(deleteResult).toEqual(3);
+    });
+  });
+});

package/src/domains/component-set/repositories/ComponentSetComponentVersionExcludedRepository.ts

@@ -0,0 +1,47 @@
+import {
+  ComponentSetComponentVersionExcludedInterface,
+  ComponentSetComponentVersionExcluded,
+} from '../models/ComponentSetComponentVersionExcluded';
+import { ComponentRepositories } from '../../db/ComponentRepositories';
+import { AbstractRepository, Pool } from '@squiz/db-lib';
+
+export class ComponentSetComponentVersionExcludedRepository extends AbstractRepository<
+  ComponentSetComponentVersionExcludedInterface,
+  ComponentSetComponentVersionExcluded
+> {
+  constructor(options: { repositories: ComponentRepositories; pool: Pool }) {
+    super(
+      options.repositories,
+      options.pool,
+      'component_set_component_version_excluded',
+      {
+        componentSetWebPath: 'component_set_web_path',
+        componentName: 'component_name',
+        componentVersion: 'component_version',
+      },
+      ComponentSetComponentVersionExcluded,
+    );
+  }
+
+  async getComponentSetExcludedVersions(componentSet: string): Promise<Record<string, string[]>> {
+    const rows = await this.find({ componentSetWebPath: componentSet });
+    const componentVersions: Record<string, string[]> = {};
+    for (const cv of rows) {
+      if (componentVersions[cv.componentName] === undefined) {
+        componentVersions[cv.componentName] = [];
+      }
+      componentVersions[cv.componentName].push(cv.componentVersion);
+    }
+
+    // sort the entries by version, latest at the top
+    Object.entries(componentVersions).forEach(([key, versions]) => {
+      componentVersions[key] = versions.sort((a, b) => {
+        if (a < b) return 1;
+        if (a > b) return -1;
+        return 0;
+      });
+    });
+
+    return componentVersions;
+  }
+}

package/src/domains/component-set/repositories/ComponentSetComponentVersionRepository.integration.spec.ts

@@ -0,0 +1,229 @@
+import { ComponentSetComponentVersionRepository } from './ComponentSetComponentVersionRepository';
+import { randomUUID } from 'crypto';
+import { createConnectionManager } from '../../db/createConnectionManager';
+import { ComponentConnectionManager } from '../../db/ComponentConnectionManager';
+import path from 'path';
+import { ComponentSet } from '../../component-set/models/ComponentSet';
+import {
+  ComponentSetComponentVersion,
+  ComponentSetComponentVersionStatus,
+} from '../../component-set/models/ComponentSetComponentVersion';
+
+describe('ComponentSetComponentVersionRepository', () => {
+  let manager: ComponentConnectionManager;
+  let repository: ComponentSetComponentVersionRepository;
+
+  beforeAll(async () => {
+    manager = await createConnectionManager(
+      'component-lib-test',
+      {
+        databaseConnectionString: process.env.COMPONENT_DB_CONNECTION_STRING!,
+      },
+      path.join(__dirname, '../../../../migrations'),
+    );
+    repository = new ComponentSetComponentVersionRepository(manager);
+
+    await manager.applyMigrations();
+  });
+
+  afterAll(() => {
+    manager.close();
+  });
+
+  describe('CRUD', () => {
+    const componentName = randomUUID().substring(0, 5);
+    const componentSetWebPath = randomUUID().substring(0, 5);
+
+    beforeAll(async () => {
+      await manager.repositories.component.addComponent(componentName);
+      await manager.repositories.componentSet.create(
+        new ComponentSet({ webPath: componentSetWebPath, displayName: 'foo' }),
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '1.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '2.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '3.0.0',
+        'display-' + componentName,
+        'description',
+        { id: 'approval', color: { type: 'hex', value: '#f00' } },
+      );
+    });
+
+    afterAll(async () => {
+      await repository.delete({ componentName });
+      await manager.repositories.componentSet.delete({ webPath: componentSetWebPath });
+      await manager.repositories.componentVersion.delete({ componentName });
+      await manager.repositories.component.delete({ name: componentName });
+    });
+
+    it('should insert', async () => {
+      const result = await repository.create({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+        environmentVariables: {
+          foo: 'foo-val',
+        },
+        status: ComponentSetComponentVersionStatus.active,
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+        environmentVariables: {
+          foo: 'foo-val',
+        },
+        status: ComponentSetComponentVersionStatus.active,
+      });
+    });
+
+    it('should be able to find one', async () => {
+      const result = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+      });
+
+      expect(result).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '1.0.0',
+        environmentVariables: {
+          foo: 'foo-val',
+        },
+        status: ComponentSetComponentVersionStatus.active,
+      });
+    });
+
+    it('should throw an error if no properties passed to findOne', async () => {
+      await expect(repository.findOne({})).rejects.toThrowError(
+        new Error('Values cannot be an empty object. It must have at least one property'),
+      );
+    });
+
+    it('should be able to update properties', async () => {
+      const result = await repository.update(
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '1.0.0',
+        },
+        {
+          componentVersion: '2.0.0',
+          environmentVariables: {
+            foo: 'foo-val',
+            foo2: 'foo2-val',
+          },
+        },
+      );
+
+      expect(result).toEqual([
+        {
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '2.0.0',
+          environmentVariables: {
+            foo: 'foo-val',
+            foo2: 'foo2-val',
+          },
+          status: ComponentSetComponentVersionStatus.active,
+        },
+      ]);
+
+      const updated = await repository.findOne({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+      });
+      expect(updated).toEqual({
+        componentSetWebPath: componentSetWebPath,
+        componentName: componentName,
+        componentVersion: '2.0.0',
+        environmentVariables: {
+          foo: 'foo-val',
+          foo2: 'foo2-val',
+        },
+        status: ComponentSetComponentVersionStatus.active,
+      });
+    });
+
+    it('should be able to find many rows', async () => {
+      await repository.create(
+        new ComponentSetComponentVersion({
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '3.0.0',
+        }),
+      );
+      const result = await repository.find({
+        componentSetWebPath: componentSetWebPath,
+      });
+      expect(result).toHaveLength(2);
+
+      const deleteResult = await repository.delete({
+        componentName: componentName,
+      });
+      expect(deleteResult).toEqual(2);
+    });
+  });
+
+  describe('componentSetComponentVersionExists', () => {
+    const componentName = randomUUID().substring(0, 5);
+    const componentSetWebPath = randomUUID().substring(0, 5);
+
+    beforeAll(async () => {
+      await manager.repositories.component.addComponent(componentName);
+      await manager.repositories.componentSet.create(
+        new ComponentSet({ webPath: componentSetWebPath, displayName: 'foo' }),
+      );
+      await manager.repositories.componentVersion.addComponentVersion(
+        componentName,
+        '1.0.0',
+        'display-' + componentName,
+        'description',
+        undefined,
+      );
+
+      await repository.create(
+        new ComponentSetComponentVersion({
+          componentSetWebPath: componentSetWebPath,
+          componentName: componentName,
+          componentVersion: '1.0.0',
+        }),
+      );
+    });
+
+    afterAll(async () => {
+      await repository.delete({ componentName });
+      await manager.repositories.componentSet.delete({ webPath: componentSetWebPath });
+      await manager.repositories.componentVersion.delete({ componentName });
+      await manager.repositories.component.delete({ name: componentName });
+    });
+
+    it('should return true if component exists', async () => {
+      expect(await repository.componentSetComponentVersionExists(componentSetWebPath, componentName, '1.0.0')).toEqual(
+        true,
+      );
+    });
+
+    it("should return false if component doesn't exist", async () => {
+      expect(await repository.componentSetComponentVersionExists(componentSetWebPath, componentName, '1.1.1')).toEqual(
+        false,
+      );
+    });
+  });
+});