fix(tests): validate task definition id

webiny · Pavel910 · Jan 9, 2024 · Nov 29, 2023 · Nov 30, 2023 · Dec 4, 2023
commit 1bf99e20f1d6e9ffa7b4c1eecec207ba383eb4ff
diff --git a/packages/tasks/__tests__/mocks/context.ts b/packages/tasks/__tests__/mocks/context.ts
@@ -2,6 +2,7 @@ import { PluginsContainer } from "@webiny/plugins";
 import { Context, ITaskUpdateData, IUpdateTaskResponse } from "~/types";
 import { MOCK_TASK_DEFINITION_ID } from "~tests/mocks/definition";
 import { PartialDeep } from "type-fest";
+import { createMockIdentity } from "~tests/mocks/identity";
 
 export const createMockContext = (params?: PartialDeep<Context>): Context => {
     return {
@@ -15,9 +16,12 @@ export const createMockContext = (params?: PartialDeep<Context>): Context => {
                 return {
                     ...data,
                     id,
+                    startedOn: new Date(),
+                    finishedOn: undefined,
                     createdOn: new Date(),
                     savedOn: new Date(),
-                    definitionId: MOCK_TASK_DEFINITION_ID
+                    definitionId: MOCK_TASK_DEFINITION_ID,
+                    createdBy: createMockIdentity()
                 };
             },
             ...params?.tasks

diff --git a/packages/tasks/__tests__/task/plugin.test.ts b/packages/tasks/__tests__/task/plugin.test.ts
@@ -1,6 +1,8 @@
+import WebinyError from "@webiny/error";
 import { Context } from "../types";
 import { ITaskDefinition, ITaskDefinitionField, ITaskRunParams } from "~/types";
 import { createTaskDefinition, createTaskDefinitionField } from "~/task/plugin";
+import { createMockTaskDefinition } from "~tests/mocks/definition";
 
 const taskField: ITaskDefinitionField = {
     fieldId: "url",
@@ -46,7 +48,7 @@ class MyTask implements ITaskDefinition<Context, MyInput> {
     }
 }
 
-describe("task definition", () => {
+describe("task plugin", () => {
     it("should properly create a task - plain object", async () => {
         const task: ITaskDefinition<Context, MyInput> = {
             id: "myCustomTask",
@@ -138,4 +140,19 @@ describe("task definition", () => {
         expect(task.onDone).toBeInstanceOf(Function);
         expect(task.onError).toBeInstanceOf(Function);
     });
+
+    it("should fail on invalid task id", async () => {
+        let error: WebinyError | undefined;
+        try {
+            createMockTaskDefinition({
+                id: "id-whichIsNotValid"
+            });
+        } catch (ex) {
+            error = ex;
+        }
+
+        expect(error?.message).toEqual(
+            `Task ID "id-whichIsNotValid" is invalid. It must be in camelCase format, for example: "myCustomTask".`
+        );
+    });
 });
diff --git a/packages/tasks/package.json b/packages/tasks/package.json
@@ -24,6 +24,7 @@
     "@webiny/pubsub": "0.0.0",
     "@webiny/utils": "0.0.0",
     "aws-lambda": "^1.0.7",
+    "lodash": "^4.17.21",
     "zod": "^3.21.4"
   },
   "devDependencies": {
@@ -39,7 +40,7 @@
     "@webiny/project-utils": "0.0.0",
     "rimraf": "^3.0.2",
     "ttypescript": "^1.5.13",
-    "type-fest": "^4.8.3",
+    "type-fest": "^2.19.0",
     "typescript": "4.7.4"
   },
   "publishConfig": {

diff --git a/packages/tasks/src/task/plugin.ts b/packages/tasks/src/task/plugin.ts
@@ -1,3 +1,5 @@
+import camelCase from "lodash/camelCase";
+import WebinyError from "@webiny/error";
 import { Plugin } from "@webiny/plugins";
 import { Context, ITaskDefinition, ITaskDefinitionField } from "~/types";
 
@@ -51,6 +53,7 @@ export class TaskDefinitionPlugin<C extends Context = Context, I = any>
         if (typeof task.config === "function") {
             task.config(this);
         }
+        this.validate();
     }
 
     public getTask() {
@@ -65,6 +68,16 @@ export class TaskDefinitionPlugin<C extends Context = Context, I = any>
     public addField(field: ITaskDefinitionField) {
         this.task.fields = (this.task.fields || []).concat([field]);
     }
+    /**
+     * TODO implement zod validation if validation becomes too complex
+     */
+    private validate(): void {
+        if (camelCase(this.task.id) !== this.task.id) {
+            throw new WebinyError(
+                `Task ID "${this.task.id}" is invalid. It must be in camelCase format, for example: "myCustomTask".`
+            );
+        }
+    }
 }
 
 export const createTaskDefinition = <C extends Context = Context, I = any>(

diff --git a/packages/tasks/src/types.ts b/packages/tasks/src/types.ts
@@ -212,6 +212,7 @@ export interface ITaskBeforeTriggerParams<C extends Context = Context, I = ITask
 export interface ITaskDefinition<C extends Context = Context, I = ITaskDataValues> {
     /**
      * ID of the task must be unique in the system.
+     * It should be in camelCase format, for example: "myCustomTask".
      */
     id: string;
     /**

diff --git a/yarn.lock b/yarn.lock
@@ -17944,9 +17944,10 @@ __metadata:
     "@webiny/pubsub": 0.0.0
     "@webiny/utils": 0.0.0
     aws-lambda: ^1.0.7
+    lodash: ^4.17.21
     rimraf: ^3.0.2
     ttypescript: ^1.5.13
-    type-fest: ^4.8.3
+    type-fest: ^2.19.0
     typescript: 4.7.4
     zod: ^3.21.4
   languageName: unknown
@@ -44222,6 +44223,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"type-fest@npm:^2.19.0":
+  version: 2.19.0
+  resolution: "type-fest@npm:2.19.0"
+  checksum: a4ef07ece297c9fba78fc1bd6d85dff4472fe043ede98bd4710d2615d15776902b595abf62bd78339ed6278f021235fb28a96361f8be86ed754f778973a0d278
+  languageName: node
+  linkType: hard
+
 "type-fest@npm:^3.10.0":
   version: 3.10.0
   resolution: "type-fest@npm:3.10.0"
@@ -44231,13 +44239,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"type-fest@npm:^4.8.3":
-  version: 4.8.3
-  resolution: "type-fest@npm:4.8.3"
-  checksum: cd8c9a20a32b9d813f5f6d84bd81e52e22fb779a7ef0ae53974bae5baac427974bc8243269e9832b22ce2b6277d857b44769b3664f97dcac344e600bdd95f186
-  languageName: node
-  linkType: hard
-
 "type-is@npm:~1.6.17, type-is@npm:~1.6.18":
   version: 1.6.18
   resolution: "type-is@npm:1.6.18"