@squiz/dx-json-schema-lib 1.39.0 → 1.39.1-alpha.1

package/lib/manifest/v1/v1.json

@@ -4,15 +4,28 @@
     "title": "ComponentManifest",
     "additionalProperties": false,
     "properties": {
-        "$schema": { "type": "string", "description": "the manifest schema version" },
+        "$schema": {
+            "type": "string",
+            "description": "the manifest schema version"
+        },
         "namespace": {
             "type": "string",
             "description": "Namespace of the component",
             "$ref": "#/definitions/name-pattern"
         },
-        "name": { "type": "string", "description": "Name of the component", "$ref": "#/definitions/name-pattern" },
-        "displayName": { "type": "string", "description": "Display name of the component" },
-        "description": { "type": "string", "description": "Description of the component" },
+        "name": {
+            "type": "string",
+            "description": "Name of the component",
+            "$ref": "#/definitions/name-pattern"
+        },
+        "displayName": {
+            "type": "string",
+            "description": "Display name of the component"
+        },
+        "description": {
+            "type": "string",
+            "description": "Description of the component"
+        },
         "mainFunction": {
             "type": "string",
             "description": "Name of the main function to be executed at the root of the access url"
@@ -84,7 +97,9 @@
                                 "additionalProperties": false,
                                 "description": "The HtmlResponse type is for returning html content. The response out of the function must be a string. This response object also includes references to resources (staticFiles) the component needs to execute correctly. It is up to the integrating system to respect this.",
                                 "properties": {
-                                    "responseType": { "const": "html" },
+                                    "responseType": {
+                                        "const": "html"
+                                    },
                                     "staticFiles": {
                                         "type": "array",
                                         "description": "A list of static resources that are required for the component to execute correctly",
@@ -251,8 +266,12 @@
                                 "type": "object",
                                 "additionalProperties": false,
                                 "properties": {
-                                    "responseType": { "const": "json" },
-                                    "definition": { "$ref": "http://json-schema.org/draft-07/schema#" },
+                                    "responseType": {
+                                        "const": "json"
+                                    },
+                                    "definition": {
+                                        "$ref": "http://json-schema.org/draft-07/schema#"
+                                    },
                                     "headers": {
                                         "title": "ResponseHeaders",
                                         "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.39.0",
+  "version": "1.39.1-alpha.1",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -31,5 +31,5 @@
     "@squiz/json-schema-library": "7.4.7",
     "ts-brand": "0.0.2"
   },
-  "gitHead": "ade72ff2cba5a65be6010587a58e8f49153fc806"
+  "gitHead": "16b9f02b751a923a71f96684bd46c781fc97dcbc"
 }

package/src/JsonValidationService.ts

@@ -11,6 +11,7 @@ import FormattedText from './formatted-text/v1/formattedText.json';
 import PageContentsSchema from './pageContents/v1/pageContents.json';
 
 import v1 from './manifest/v1/v1.json';
+import JobV1 from './manifest/v1/JobV1.json';
 import { SchemaValidationError, ValidationData, ValidationDataMap } from './errors/SchemaValidationError';
 import { Draft07, JSONError, JSONSchema, Draft, DraftConfig } from '@squiz/json-schema-library';
 
@@ -152,6 +153,9 @@ v1Schema.addRemoteSchema('/MatrixAssetSchema.json', MatrixAssetSchema);
 v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema', Draft07Schema);
 v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema#', Draft07Schema);
 
+const jobV1Schema = new Draft07(JobV1, defaultConfig);
+jobV1Schema.addRemoteSchema('/DxComponentInputSchema.json', ComponentInputSchema.getSchema());
+
 export const ComponentInputMetaSchema: MetaSchemaInput = {
   root: DxComponentInputSchema,
   remotes: {
@@ -282,12 +286,16 @@ export class JSONSchemaService<P extends AnyPrimitiveType, R extends AnyResolvab
 }
 
 export class JsonValidationService {
-  validateManifest(manifest: unknown, version: 'v1') {
+  validateManifest(manifest: unknown, version: 'v1' | 'JobV1') {
     switch (version) {
       case 'v1': {
         const validationResult = v1Schema.validate(manifest);
         return processValidationResult(validationResult);
       }
+      case 'JobV1': {
+        const validationResult = jobV1Schema.validate(manifest);
+        return processValidationResult(validationResult);
+      }
 
       default:
         throw new SchemaValidationError('Invalid manifest version');

package/src/manifest/v1/JobV1.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "JobManifest",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "the manifest schema version"
+    },
+    "name": {
+      "type": "string",
+      "description": "Name of the job",
+      "$ref": "#/definitions/name-pattern"
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Display name of the job"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the job"
+    },
+    "mainFunction": {
+      "type": "string",
+      "description": "Name of the main function to be executed at the root of the access url"
+    },
+    "version": {
+      "type": "string",
+      "description": "Semver version number",
+      "minLength": 5,
+      "maxLength": 14,
+      "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$"
+    },
+    "timeout": {
+      "type": "number",
+      "description": "Timeout in seconds before a job is stopped (min 5s, max 8h)",
+      "minimum": 5,
+      "maximum": 28800
+    },
+    "concurrency": {
+      "type": "number",
+      "description": "The number of these jobs that can be run at once",
+      "minimum": 1
+    },
+    "functions": {
+      "type": "array",
+      "minItems": 0,
+      "items": {
+        "title": "JobFunction",
+        "description": "Job function definition, this object provides the runtime with input validation and what to execute",
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "$ref": "#/definitions/name-pattern",
+            "description": "Function name"
+          },
+          "entry": {
+            "type": "string",
+            "description": "File path to the javascript file to execute. The file path must be relative to the manifest file and cannot be in a folder above the manifest file."
+          },
+          "input": {
+            "$ref": "DxComponentInputSchema.json"
+          }
+        },
+        "required": ["name", "entry", "input"]
+      }
+    }
+  },
+  "required": [
+    "name",
+    "displayName",
+    "description",
+    "version",
+    "functions",
+    "$schema",
+    "mainFunction",
+    "concurrency",
+    "timeout"
+  ],
+  "definitions": {
+    "name-pattern": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9_\\-]+$"
+    }
+  }
+}

package/src/manifest/v1/JobV1.spec.ts

@@ -0,0 +1,110 @@
+import { readFile } from 'fs/promises';
+import { resolve } from 'path';
+import { SchemaValidationError } from '../../errors/SchemaValidationError';
+import { JsonValidationService } from '../../JsonValidationService';
+
+const NAME_PATTERN = '^[a-z][a-z0-9_\\-]+$';
+
+async function fetchTestManifest(filename: string) {
+  const contents = await readFile(resolve(__dirname, '__test__', 'schemas', filename), {
+    encoding: 'utf-8',
+  });
+  return JSON.parse(contents);
+}
+// eslint-disable-next-line @typescript-eslint/ban-types
+function expectToThrowErrorMatchingTypeAndMessage(received: Function, errorType: Function, message: string) {
+  let error: null | Error = null;
+
+  try {
+    received();
+  } catch (e: any) {
+    error = e;
+  }
+
+  expect(error).toBeDefined();
+  expect(error?.message).toEqual(message);
+  expect(error).toBeInstanceOf(errorType);
+}
+
+describe('manifest/JobV1', () => {
+  let validationService: JsonValidationService;
+
+  beforeAll(() => {
+    validationService = new JsonValidationService();
+  });
+
+  it('succeeds on a valid manifest', async () => {
+    const manifest = await fetchTestManifest('validJob.json');
+    expect(validationService.validateManifest(manifest, 'JobV1')).toBeTruthy();
+  });
+
+  it('errors on invalid property types in function input', async () => {
+    const manifest = await fetchTestManifest('badFunctionInputJob.json');
+
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => {
+        validationService.validateManifest(manifest, 'JobV1');
+      },
+      SchemaValidationError,
+      'failed validation: Value `wrongType` at `#/functions/0/input/properties/something/type` does not match any schema',
+    );
+  });
+
+  it('errors on non-object top level input', async () => {
+    const manifest = await fetchTestManifest('nonObjectFunctionInputJob.json');
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => {
+        validationService.validateManifest(manifest, 'JobV1');
+      },
+      SchemaValidationError,
+      'failed validation: Expected value at `#/functions/0/input/type` to be `object`, but value given is `string`',
+    );
+  });
+
+  describe.each(['_my-name', '-my-name', 'MyName', 'myName', '0my-name'])(
+    'fails name-pattern validation for %s',
+    (propertyValue) => {
+      it.each(['name'])(`fails validation for manifests with %s of ${propertyValue}`, async (propertyName) => {
+        const manifest = await fetchTestManifest('validJob.json');
+
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            validationService.validateManifest(
+              {
+                ...manifest,
+                [propertyName]: propertyValue,
+              },
+              'JobV1',
+            );
+          },
+          SchemaValidationError,
+          `failed validation: Value in \`#/${propertyName}\` should match \`${NAME_PATTERN}\`, but received \`${propertyValue}\``,
+        );
+      });
+
+      it('fails validation for manifests with function names of %s', async () => {
+        const manifest = await fetchTestManifest('validJob.json');
+
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            validationService.validateManifest(
+              {
+                ...manifest,
+                functions: [
+                  {
+                    name: propertyValue,
+                    entry: 'main.js',
+                    input: {},
+                  },
+                ],
+              },
+              'JobV1',
+            );
+          },
+          SchemaValidationError,
+          `failed validation: Value in \`#/functions/0/name\` should match \`${NAME_PATTERN}\`, but received \`${propertyValue}\``,
+        );
+      });
+    },
+  );
+});