@squiz/job-runner-lib 1.66.1 → 2.1.0

package/src/domains/manifest/services/ManifestServiceForDev.spec.ts

@@ -1,159 +1,25 @@
-import { getLogger } from '@squiz/dx-logger-lib';
-import path from 'path';
 import { ManifestServiceForDev } from './ManifestServiceForDev';
-import fs from 'fs-extra';
-
-const COMPONENT_ROOT = process.env.DATA_MOUNT_POINT!;
 
-const logger = getLogger({ name: 'test', format: 'json' });
-
-const warnSpy = jest.spyOn(logger, 'warn');
+import path from 'path';
+import { ManifestValidationError } from '../errors/ManifestValidationError';
+import { ResourceNotFoundError } from '@squiz/dx-common-lib';
+import { getLogger } from '@squiz/dx-logger-lib';
 
 describe('ManifestServiceForDev', () => {
-  const service = new ManifestServiceForDev(COMPONENT_ROOT, logger);
-
-  beforeAll(() => {
-    if (fs.existsSync(path.join(COMPONENT_ROOT, 'unit-test-components/test-component/1.1.4/bad-dir'))) {
-      fs.rmSync(path.join(COMPONENT_ROOT, 'unit-test-components/test-component/1.1.4/bad-dir'), { recursive: true });
-    }
-  });
-
-  it('finds a component in subdirectory including version', async () => {
-    const componentDirectory = path.resolve(COMPONENT_ROOT, 'unit-test-components', 'test-component', '1.0.0');
-    const resolvedComponents = await service.getManifestPath('unit-test-components', 'test-component', '1.0.0');
-    expect(resolvedComponents).toEqual(path.join(componentDirectory, 'manifest.json'));
-  });
+  const service = new ManifestServiceForDev(getLogger({ name: 'ManifestServiceForDev' }));
 
-  it('finds a component in a sub directory not including version', async () => {
-    const componentDirectory = path.resolve(COMPONENT_ROOT, 'unit-test-components', 'no-version-struct');
-    const resolvedComponents = await service.getManifestPath('unit-test-components', 'no-version-struct', '1.0.0');
-    expect(resolvedComponents).toEqual(path.join(componentDirectory, 'manifest.json'));
-  });
-
-  it('finds all components in the root directory', async () => {
-    const resolvedComponents = await service.listAllComponentManifests();
-
-    const allowedPrefixes = [
-      'test-component',
-      'test-environment-variables',
-      'test-malicious-code',
-      'test-npm-modules',
-      'test-static-files',
-    ];
-
-    expect(
-      resolvedComponents
-        .filter((a) => allowedPrefixes.some((b) => a.getName().startsWith(`unit-test-components/${b}`)))
-        .map((a) => `${a.getName()} ${a.getVersion()}`)
-        .sort(),
-    ).toEqual([
-      'unit-test-components/test-component 0.0.0',
-      'unit-test-components/test-component 1.0.0',
-      'unit-test-components/test-component 1.0.10',
-      'unit-test-components/test-component 1.0.3',
-      'unit-test-components/test-component 1.0.4',
-      'unit-test-components/test-component 1.0.5',
-      'unit-test-components/test-component 1.0.6',
-      'unit-test-components/test-component 1.0.7',
-      'unit-test-components/test-component 1.0.8',
-      'unit-test-components/test-component 1.0.9',
-      'unit-test-components/test-component 1.1.0',
-      'unit-test-components/test-component 1.1.2',
-      'unit-test-components/test-component 1.1.4',
-      'unit-test-components/test-component 1.2.0',
-      'unit-test-components/test-component 1.3.0',
-      'unit-test-components/test-environment-variables 1.0.0',
-      'unit-test-components/test-environment-variables 1.0.1',
-      'unit-test-components/test-environment-variables 1.0.2',
-      'unit-test-components/test-environment-variables 1.0.3',
-      'unit-test-components/test-environment-variables 1.0.4',
-      'unit-test-components/test-malicious-code 1.0.0',
-      'unit-test-components/test-malicious-code 1.1.0',
-      'unit-test-components/test-malicious-code 1.2.0',
-      'unit-test-components/test-malicious-code 1.3.0',
-      'unit-test-components/test-npm-modules 1.0.0',
-      'unit-test-components/test-npm-modules 2.0.0',
-      'unit-test-components/test-npm-modules 3.0.0',
-      'unit-test-components/test-npm-modules 3.1.0',
-      'unit-test-components/test-static-files 1.0.0',
-      'unit-test-components/test-static-files 1.0.1',
-      'unit-test-components/test-static-files 1.0.2',
-      'unit-test-components/test-static-files 1.0.3',
-      'unit-test-components/test-static-files 1.0.4',
-      'unit-test-components/test-static-files 1.0.5',
-      'unit-test-components/test-static-files 1.0.6',
-      'unit-test-components/test-static-files 1.0.7',
-      'unit-test-components/test-static-files 1.0.8',
-    ]);
-  });
+  describe('readJobManifest', () => {
+    it('should read and validate a job manifest from a file path', async () => {
+      const p = path.join(__dirname, '../../../../../..', 'test-jobs/unit-test-jobs/test-job/1.0.0/manifest.json');
+      const res = await service.readJobManifest(p);
 
-  it('should find log warnings on all manifests that fail validation', async () => {
-    await service.listAllComponentManifests();
-
-    expect(
-      warnSpy.mock.calls
-        .filter((a) => {
-          // Get rid of the random fixtures
-          const message = a[0] as unknown as string;
-          return !message.includes('/fixtures/');
-        })
-        .map((a) => {
-          const message = a[0] as unknown as string;
-          // get rid of user specific paths from test snapshot
-          return message.replace(COMPONENT_ROOT, '');
-        })
-        .sort(),
-    ).toMatchInlineSnapshot(`
-      [
-        "found manifest /dx-team/cornponent/0.0.3/manifest.json, but failed to load manifest because: Invalid preview data for preview "render-with-data": failed validation: Value \`[{"tag":"p","type":"tag","children":[{"type":"text","value":"This is some "},{"type":"text","value":"text"}]}]\` in \`#/my-prop/formattedText\` does not match any given oneof schema,
-      Value \`{"text":[{"tag":"p","type":"tag","children":[{"type":"text","value":"This is some "},{"type":"text","value":"text"}]}]}\` in \`#/my-prop/arr\` does not match any given oneof schema",
-        "found manifest /unit-test-components/test-component/1.0.2/manifest.json, but failed schema validation because: Could not determine manifest version. Your manifest must have a $schema property defined.",
-        "found manifest /unit-test-components/test-component/1.0.3/manifest.json, but failed to load manifest because: "main's" entry file "missing-entry-file.js" is inaccessible",
-        "found manifest /unit-test-components/test-component/1.0.5/manifest.json, but failed to load manifest because: "test-component 1.0.5" main function could not be found in function list",
-        "found manifest /unit-test-components/test-component/1.0.6/manifest.json, but failed to load manifest because: access to component "file-accessing-outside-parent-func's" entry file "../1.0.4/render-json.js" outside the parent directory in "test-component 1.0.6" is not allowed",
-        "found manifest /unit-test-components/test-component/1.1.1/manifest.json, but failed schema validation because: failed validation: Value in \`#/functions/0/name\` should match \`^[a-z][a-z0-9_\\-]+$\`, but received \`invalid-function-name-!!!!\`",
-        "found manifest /unit-test-components/test-component/1.1.2/manifest.json, but failed to load manifest because: function main-output-has-static defines static files but manifest has no staticFiles.locationRoot defined",
-        "found manifest /unit-test-components/test-component/1.1.4/manifest.json, but failed to load manifest because: static root bad-dir from "test-component 1.1.4" is not accessible",
-        "found manifest /unit-test-components/test-component/1.2.0/manifest.json, but failed to load manifest because: Invalid preview data for preview "test-preview": failed validation: The required property \`something\` is missing at \`#\`",
-        "found manifest /unit-test-components/test-icon-component/1.0.1/manifest.json, but failed schema validation because: failed validation: Expected given value \`not_a_valid_id\` in #/icon/id\` to be one of \`[10k, 10mp, 11mp, 123, 12mp, ... 2233 more]\`,
-      Value \`{"type":"hex","value":"(255,255,255)"}\` in \`#/icon/color\` does not match any given oneof schema",
-        "found manifest /unit-test-components/test-icon-component/1.0.2/manifest.json, but failed schema validation because: failed validation: Expected given value \`not_a_valid_id\` in #/icon/id\` to be one of \`[10k, 10mp, 11mp, 123, 12mp, ... 2233 more]\`,
-      The required property \`color\` is missing at \`#/icon\`",
-        "found manifest /unit-test-components/test-load/1.0.7/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview1": Unknown Preview Configuration Type",
-        "found manifest /unit-test-components/test-preview-component/1.0.0/manifest.json, but failed to load manifest because: Invalid preview data for preview "invalid-preview-data": failed validation: Expected \`not-an-integer\` (string) in \`#/integerValue\` to be of type \`number\`,
-      The required property \`nested\` is missing at \`#\`",
-        "found manifest /unit-test-components/test-preview-component/1.0.7/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview-json-doesnt-exist": Preview inputData file "missing.json" does not exist",
-        "found manifest /unit-test-components/test-preview-component/1.1.0/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview-inline": failed validation: Value \`[{"type":"tag","tag":"p","children":[{"type":"text","value":"This is a paragraph"},{"type":"tag","tag":"span","children":[{"type":"text","value":" with a span"}]}]}]\` in \`#/formattedText\` does not match any given oneof schema",
-        "found manifest /unit-test-components/test-preview-component/1.1.2/manifest.json, but failed to load manifest because: Mocked URI object file "./non-existent-uri.json" does not exist",
-        "found manifest /unit-test-components/test-preview-component/1.1.3/manifest.json, but failed to load manifest because: Mocked URI object file "../1.0.0/manifest.json" is outside the component directory",
-        "found manifest /unit-test-components/test-preview-component/1.2.1/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview-js-doesnt-exist": Preview inputData file "missing.js" does not exist",
-        "found manifest /unit-test-components/test-preview-component/1.2.2/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview-json-doesnt-exist": Preview inputData file "missing.json" does not exist",
-        "found manifest /unit-test-components/test-preview-component/1.2.3/manifest.json, but failed to load manifest because: Invalid preview data for preview "preview-json-outside-of-root": Preview inputData file "../preview-data.json" is outside the component directory",
-        "found manifest /unit-test-components/test-static-files/1.0.2/manifest.json, but failed to load manifest because: "main's" static file "static-files-library/static-file-does-not-exist.js" is inaccessible",
-        "found manifest /unit-test-components/test-static-files/1.0.3/manifest.json, but failed to load manifest because: access to a static file locationRoot outside the parent directory in "test-static-files 1.0.3" is not allowed",
-        "found manifest /unit-test-components/test-static-files/1.0.4/manifest.json, but failed to load manifest because: access to a static file "../../static-files-library/static-library-file.js" for "main" outside the parent directory in "test-static-files 1.0.4" is not allowed",
-        "found manifest /unit-test-components/test-static-files/1.0.5/manifest.json, but failed to load manifest because: function main defines static files but manifest has no staticFiles.locationRoot defined",
-        "found manifest /unit-test-components/test-static-files/1.0.6/manifest.json, but failed to load manifest because: function main defines static files but manifest has no staticFiles.locationRoot defined",
-        "found manifest /unit-test-components/test-static-files/1.0.8/manifest.json, but failed to load manifest because: function main defines static files but manifest has no staticFiles.locationRoot defined",
-      ]
-    `);
-  });
-
-  describe('Manifest refreshes correctly', () => {
-    it('should update data on loadManifest when given manifest data is valid', async () => {
-      const manifestPath = await service.getManifestPath('refresh-test-components', 'test-refresh', '1.0.0');
-      const componentDirectory = path.resolve(COMPONENT_ROOT, 'unit-test-components', 'test-refresh', '1.0.0');
-      const originalManifestData = fs.readFileSync(componentDirectory + '/manifest.json', 'utf8');
-      const newManifestData = fs.readFileSync(componentDirectory + '/manifest-modified.json', 'utf8');
-      fs.writeFileSync(manifestPath, newManifestData);
-      const manifest = await service.loadManifest('refresh-test-components', 'test-refresh', '1.0.0');
-      expect(manifest.getName()).toEqual('refresh-test-components/test-refresh');
-      expect(manifest.getVersion()).toEqual('1.0.0');
-      expect(manifest.getModel()).toMatchInlineSnapshot(`
-        {
-          "$schema": "http://localhost:3000/schemas/v1.json#",
-          "description": "some-description-modified",
-          "displayName": "some-display-name-modified",
+      expect(res).toMatchInlineSnapshot(`
+      JobManifestV1 {
+        "manifest": {
+          "$schema": "http://localhost:3040/schemas/JobV1.json#",
+          "concurrency": 2,
+          "description": "some-description",
+          "displayName": "Test Job",
           "functions": [
             {
               "entry": "main.js",
@@ -168,32 +34,62 @@ describe('ManifestServiceForDev', () => {
                 ],
                 "type": "object",
               },
-              "name": "main-modified",
-              "output": {
-                "responseType": "html",
+              "name": "main",
+            },
+            {
+              "entry": "promise.js",
+              "input": {
+                "properties": {
+                  "something": {
+                    "type": "string",
+                  },
+                },
+                "required": [
+                  "something",
+                ],
+                "type": "object",
               },
+              "name": "promise-func",
             },
           ],
-          "mainFunction": "main-modified",
-          "name": "test-refresh",
-          "namespace": "refresh-test-components",
+          "mainFunction": "main",
+          "name": "test-job",
+          "timeout": 600,
           "version": "1.0.0",
-        }
-      `);
-      fs.writeFileSync(manifestPath, originalManifestData);
+        },
+        "manifestPath": "${p}",
+      }
+    `);
+    });
+
+    it("should throw a ResourceNotFoundError error if manifest doesn't exist", async () => {
+      const p = path.join(__dirname, '../../../../../..', 'test-jobs/unit-test-jobs/not-real/manifest.json');
+
+      await expect(service.readJobManifest(p)).rejects.toThrowError(
+        new ResourceNotFoundError(`manifest could not be found`),
+      );
     });
-    it('should not update data correctly on loadManifest when given manifest data is invalid', async () => {
-      const manifestPath = await service.getManifestPath('refresh-test-components', 'test-refresh', '1.0.1');
-      const componentDirectory = path.resolve(COMPONENT_ROOT, 'unit-test-components', 'test-refresh', '1.0.1');
-      const originalManifestData = fs.readFileSync(componentDirectory + '/manifest.json', 'utf8');
-      const newManifestData = fs.readFileSync(componentDirectory + '/manifest-invalid.json', 'utf8');
-      fs.writeFileSync(manifestPath, newManifestData);
-      await expect(
-        service.loadManifest('refresh-test-components', 'test-refresh', '1.0.1'),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `""test-refresh 1.0.1" main function could not be found in function list"`,
+    it("should error if manifest doesn't meet schema version", async () => {
+      const p = path.join(
+        __dirname,
+        '../../../../../..',
+        'test-jobs/unit-test-jobs/invalid-schema-job/1.0.0/manifest.json',
+      );
+
+      await expect(service.readJobManifest(p)).rejects.toThrowError(
+        new ManifestValidationError(`Could not determine manifest version from $schema value.`),
       );
-      fs.writeFileSync(manifestPath, originalManifestData);
     });
   });
+  it('should error if manifest is invalid', async () => {
+    const p = path.join(
+      __dirname,
+      '../../../../../..',
+      'test-jobs/unit-test-jobs/invalid-manifest-job/1.0.0/manifest.json',
+    );
+
+    await expect(service.readJobManifest(p)).rejects.toThrowError(
+      new ManifestValidationError('failed validation: The required property `concurrency` is missing at `#`'),
+    );
+  });
 });

package/src/domains/manifest/services/ManifestServiceForDev.ts

@@ -1,96 +1,37 @@
-import path from 'path';
-import fsp from 'fs/promises';
-import { AbstractManifestService } from './AbstractManifestService';
-import { Logger } from '@squiz/dx-logger-lib';
-import { Manifest } from '../ManifestModel';
 import { ResourceNotFoundError } from '@squiz/dx-common-lib';
-import { getComponentName } from '../../component/utils/getComponentName';
+import { ManifestValidationError } from '../errors/ManifestValidationError';
+import { JobManifestModel } from '../ManifestModel';
+import { getAndAssertJobManifestVersion } from '../utils/getAndAssertJobManifestVersion';
+import { JobManifestV1 } from '../../job/manifest/JobManifestV1';
+import { JsonValidationService } from '@squiz/dx-json-schema-lib';
 
-type ManifestAndPath = { directory: string; manifest: Manifest };
+import fsExtra from 'fs-extra';
+import { Logger } from '@squiz/dx-logger-lib';
 
-export class ManifestServiceForDev extends AbstractManifestService {
-  protected foundManifests: ManifestAndPath[] = [];
+export class ManifestServiceForDev {
+  protected jobValidationService: JsonValidationService = new JsonValidationService();
 
-  constructor(protected componentMountPoint: string, protected logger: Logger) {
-    super(logger);
-  }
+  constructor(protected logger: Logger) {}
 
-  async listAllComponentManifests(): Promise<Manifest[]> {
-    if (this.foundManifests.length === 0) {
-      this.foundManifests = await this.recursivelyLookForManifests(this.componentMountPoint);
+  protected getJobManifest(manifestModel: JobManifestModel, manifestPath: string): JobManifestV1 {
+    const schemaVersion = getAndAssertJobManifestVersion(manifestModel, JobManifestV1.getJobSchemaVersionRegex());
+    if (schemaVersion === 'JobV1') {
+      return new JobManifestV1(manifestModel, manifestPath);
     }
-
-    return this.foundManifests.map((a) => a.manifest);
+    throw new ManifestValidationError(`Unsupported manifest schema version ${schemaVersion}`);
   }
 
-  async getManifestPath(namespace: string, componentName: string, version: string): Promise<string> {
-    if (this.foundManifests.length === 0) {
-      this.foundManifests = await this.recursivelyLookForManifests(this.componentMountPoint);
-    }
-
-    const manifest = this.foundManifests.find(
-      (m) => m.manifest.getName() === getComponentName(namespace, componentName) && m.manifest.getVersion() === version,
-    );
-
-    if (manifest) {
-      return path.join(manifest.directory, 'manifest.json');
+  public async readJobManifest(manifestPath: string): Promise<JobManifestV1> {
+    if (await fsExtra.pathExists(manifestPath)) {
+      const manifest = JSON.parse(await fsExtra.readFile(manifestPath, { encoding: 'utf-8' })) as JobManifestModel;
+      await this.assertJobManifestMeetsSchemaVersion(manifest, JobManifestV1.getJobSchemaVersionRegex());
+      return this.getJobManifest(manifest, manifestPath);
     }
-
-    throw new ResourceNotFoundError('manifest could not be found');
+    throw new ResourceNotFoundError(`manifest could not be found`);
   }
 
-  protected async recursivelyLookForManifests(directory: string, nesting = 10): Promise<ManifestAndPath[]> {
-    if (await this.isComponentDirectory(directory)) {
-      const manifest = await this.tryToReadManifest(path.join(directory, 'manifest.json'));
-
-      if (manifest) {
-        return [{ directory, manifest }];
-      }
-
-      return [];
-    }
-
-    if (nesting === 0) {
-      return [];
-    }
-
-    const files = await fsp.readdir(directory, { withFileTypes: true, encoding: 'utf-8' });
-    const nestedDirectories = files.filter((file) => file.isDirectory());
-
-    const otherManifests = await Promise.all(
-      nestedDirectories.map((d) => this.recursivelyLookForManifests(path.join(directory, d.name), nesting - 1)),
-    );
-
-    return otherManifests.flat();
-  }
-
-  protected async tryToReadManifest(manifestPath: string): Promise<Manifest | undefined> {
-    let manifest: Manifest | undefined = undefined;
-
-    try {
-      // wrap inside try-catch as manifest reading can fail
-      // if schema version is not specifed in the manifest
-      manifest = await this.readManifest(manifestPath);
-    } catch (e: any) {
-      if (e && e.message) {
-        this.logger.warn(`found manifest ${manifestPath}, but failed schema validation because: ${e.message}`);
-      } else {
-        throw e;
-      }
-    }
-
-    if (manifest) {
-      try {
-        await this.assertManifestIsValid(manifestPath, manifest.getModel());
-      } catch (e: any) {
-        if (e && e.message) {
-          this.logger.warn(`found manifest ${manifestPath}, but failed to load manifest because: ${e.message}`);
-        } else {
-          throw e;
-        }
-      }
-    }
-
-    return manifest;
+  protected async assertJobManifestMeetsSchemaVersion(manifest: JobManifestModel, schemaVersionRegex: RegExp) {
+    getAndAssertJobManifestVersion(manifest, schemaVersionRegex);
+    this.jobValidationService.validateManifest(manifest, 'JobV1');
   }
 }

package/src/domains/manifest/utils/getAndAssertJobManifestVersion.ts

@@ -1,8 +1,6 @@
-import { SchemaVersions } from '../AbstractManifest';
 import { ManifestValidationError } from '../errors/ManifestValidationError';
-import { JobManifestModel } from '../ManifestModel';
+import { SchemaVersions, JobManifestModel, JOB_SCHEMA_VERSIONS } from '../ManifestModel';
 import { isValidManifestVersion } from './isValidManifestVersion';
-import { MANIFEST_MODELS } from '@squiz/dx-json-schema-lib';
 
 export function getAndAssertJobManifestVersion(manifest: JobManifestModel, schemaRegexp?: RegExp): SchemaVersions {
   if (!manifest['$schema']) {
@@ -23,9 +21,7 @@ export function getAndAssertJobManifestVersion(manifest: JobManifestModel, schem
   if (isValidManifestVersion(version)) {
     return version as SchemaVersions;
   }
-  const allModels = Object.keys(MANIFEST_MODELS);
-  const validJobVersions = allModels.filter((model) => model.includes('JobV'));
   throw new ManifestValidationError(
-    `manifest version "${version}" isn't a valid version. Valid versions are "${validJobVersions.toString()}"`,
+    `manifest version "${version}" isn't a valid version. Valid versions are "${JOB_SCHEMA_VERSIONS.toString()}"`,
   );
 }

package/src/domains/manifest/utils/isValidManifestVersion.spec.ts

@@ -1,9 +1,9 @@
-import { SCHEMA_VERSIONS } from '../AbstractManifest';
+import { JOB_SCHEMA_VERSIONS } from '../ManifestModel';
 import { isValidManifestVersion } from './isValidManifestVersion';
 
 describe('isValidManifestVersion', () => {
   it('should return true if the input value is a valid schema version', () => {
-    for (const validVersion of SCHEMA_VERSIONS) {
+    for (const validVersion of JOB_SCHEMA_VERSIONS) {
       expect(isValidManifestVersion(validVersion)).toEqual(true);
     }
   });
@@ -12,6 +12,10 @@ describe('isValidManifestVersion', () => {
     expect(isValidManifestVersion('bad-version')).toEqual(false);
   });
 
+  it('should return false if a component version is entered', () => {
+    expect(isValidManifestVersion('v1')).toEqual(false);
+  });
+
   it('should not exception if arbitrary objects are added', () => {
     expect(isValidManifestVersion({ 'bad-version': 123 })).toEqual(false);
     expect(isValidManifestVersion(undefined)).toEqual(false);

package/src/domains/manifest/utils/isValidManifestVersion.ts

@@ -1,8 +1,8 @@
-import { SchemaVersions, SCHEMA_VERSIONS } from '../AbstractManifest';
+import { SchemaVersions, JOB_SCHEMA_VERSIONS } from '../ManifestModel';
 
 export function isValidManifestVersion(item: unknown): item is SchemaVersions {
   if (typeof item === 'string') {
-    return SCHEMA_VERSIONS.includes(item);
+    return JOB_SCHEMA_VERSIONS.includes(item);
   }
 
   return false;

package/src/index.ts

@@ -1,10 +1,4 @@
 export * from './domains/manifest/ManifestModel';
-export * from './domains/db';
-export * from './domains/component-set';
 export * from './domains/component';
 export * from './domains/job';
-export * from './domains/content';
-export * from './domains/url';
 export * from './domains/manifest';
-
-export * as TestHelpers from './TestHelpers';

package/src/jest-global-setup.ts

@@ -7,14 +7,3 @@ import { getLogger } from '@squiz/dx-logger-lib';
 export const testLogger = getLogger({
   name: 'component-lib-test',
 });
-
-export default async (): Promise<void> => {
-  process.env.TZ = 'UTC';
-  process.env.DYNAMODB_TABLE = 'jobs-test';
-  process.env.ENVIRONMENT = 'local';
-  process.env.CLUSTER_ARN = '1234';
-  process.env.RUNTIME_TASK_DEFINITION_ARN = '5678';
-  process.env.SUBNETS_STRING = 'subnet1_subnet2';
-  process.env.S3_BUCKET = 'jobs';
-  process.env.JOB_RUNNER_API_URL = 'http://localhost:3040';
-};

package/src/{domains/job/repository/mocks → mocks}/mockIoc.ts

@@ -2,9 +2,9 @@ import { Container, decorate, injectable } from 'inversify';
 import { Controller } from 'tsoa';
 import { buildProviderModule } from 'inversify-binding-decorators';
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import color from 'cli-color';
 
 import { Logger } from '@squiz/dx-logger-lib';
+import { S3Client } from '@aws-sdk/client-s3';
 
 // Makes tsoa's Controller injectable
 decorate(injectable(), Controller);
@@ -20,12 +20,14 @@ function initIocContainer(log: Logger): void {
 
   // Init DynamoDB and S3 clients
   let dynamoDbClient: DynamoDBClient;
+  let s3Client: S3Client;
 
   if (process.env.ENVIRONMENT !== 'local') {
     dynamoDbClient = new DynamoDBClient({ region: 'ap-southeast-2' });
+    s3Client = new S3Client({ region: 'ap-southeast-2' });
   } else {
     // eslint-disable-next-line no-console
-    console.log(`environment: '${color.red(process.env.ENVIRONMENT)}'`);
+    console.log(`environment: '${process.env.ENVIRONMENT}'`);
 
     // eslint-disable-next-line no-console
     console.log(`table: '${process.env.DYNAMODB_TABLE}'`);
@@ -33,10 +35,18 @@ function initIocContainer(log: Logger): void {
       credentials: { accessKeyId: 'key', secretAccessKey: 'key' },
       endpoint: 'http://localhost:8000',
     });
+    s3Client = new S3Client({
+      credentials: { accessKeyId: 'key', secretAccessKey: 'key' },
+      endpoint: 'http://localhost:8000',
+    });
   }
 
   iocContainer.bind<DynamoDBClient>(DynamoDBClient).toConstantValue(dynamoDbClient);
   iocContainer.bind<Logger>('Logger').toConstantValue(log);
+  iocContainer.bind<S3Client>(S3Client).toConstantValue(s3Client);
+
+  iocContainer.bind<string>('JobDetailsBucketName').toConstantValue('configObj.jobDetailsBucketName');
+  iocContainer.bind<string>('S3RepositoryBucketName').toConstantValue('configObj.bucketName');
 }
 
 export { iocContainer, initIocContainer };

package/tsconfig.json

@@ -6,11 +6,13 @@
     "resolveJsonModule": true,
     "composite": true,
     "rootDir": "./src",
-    "sourceMap": true
+    "sourceMap": true,
+    "emitDeclarationOnly": true,
+    "declaration": true
   },
 
   "references": [],
 
   "include": ["src/**/*.ts", "src/**/*.json"],
-  "exclude": ["jest.config.ts", "src/migrations/**/*"]
+  "exclude": ["jest.config.ts"]
 }

package/.env.example

@@ -1 +0,0 @@
-COMPONENT_DB_CONNECTION_STRING=postgresql://postgres:postgres@127.0.0.1:5433/cmp?schema=public

package/jest.integration.config.ts

@@ -1,27 +0,0 @@
-import type { Config } from 'jest';
-import path from 'path';
-import { defaultIntegrationConfig } from '../../jest.config';
-import { config as dotEnvConfig } from 'dotenv';
-dotEnvConfig();
-
-process.env.PORT = '3010';
-process.env.ROOT_URL = 'http://localhost:3010';
-process.env.DATA_MOUNT_POINT = path.join(__dirname, '..', '..', 'test-components');
-
-if (!process.env.COMPONENT_DB_CONNECTION_STRING) {
-  throw new Error(`COMPONENT_DB_CONNECTION_STRING needs to be set`);
-}
-
-// Sync object
-const config: Config = {
-  ...defaultIntegrationConfig,
-  testPathIgnorePatterns: ['<rootDir>/lib/', '<rootDir>/cdk.out/', 'test.ts'],
-  maxWorkers: 1,
-  detectOpenHandles: true,
-  globals: {
-    BUILD_VERSION: 'undefined',
-    BUILD_BRANCH: 'undefined',
-  },
-};
-
-export default config;

package/lib/TestHelpers.d.ts

@@ -1,18 +0,0 @@
-type ComponentReturn = string | object;
-export declare class ComponentFixture {
-    static fixtureRootDirectory: string;
-    static namespace: string;
-    static setupFullComponentDirectory(returnObj: ComponentReturn, { raw }?: {
-        raw?: boolean | undefined;
-    }): Promise<{
-        fixtureDirectory: string;
-        componentDirectory: string;
-        version: string;
-        manifest: import("@squiz/dx-json-schema-lib/lib/manifest/v1/v1").ComponentManifest;
-        componentName: string;
-    }>;
-    static createFixtureDirectory(): Promise<string>;
-    private static createVersionDirectory;
-    private static createManifest;
-}
-export {};