test(tasks): trigger crud

webiny · Pavel910 · Jan 9, 2024 · Nov 29, 2023 · Nov 30, 2023 · Dec 4, 2023
commit 7a110d490d8b2c5fed5b44442c027984b9a74a8e
diff --git a/packages/aws-sdk/src/client-eventbridge/index.ts b/packages/aws-sdk/src/client-eventbridge/index.ts
@@ -1,5 +1,6 @@
 export {
     EventBridgeClient,
     PutEventsRequestEntry,
-    PutEventsCommand
+    PutEventsCommand,
+    PutEventsCommandInput
 } from "@aws-sdk/client-eventbridge";
diff --git a/packages/tasks/__tests__/crud/trigger.test.ts b/packages/tasks/__tests__/crud/trigger.test.ts
@@ -0,0 +1,60 @@
+import { useHandler } from "~tests/helpers/useHandler";
+import { createMockTaskDefinitions } from "~tests/mocks/definition";
+import { createMockIdentity } from "~tests/mocks/identity";
+import { TaskDataStatus } from "~/types";
+
+jest.mock("@webiny/aws-sdk/client-eventbridge", () => {
+    return {
+        EventBridgeClient: class EventBridgeClient {
+            async send(cmd: any) {
+                return {
+                    input: cmd.input
+                };
+            }
+        },
+        PutEventsCommand: class PutEventsCommand {
+            public readonly input: any;
+
+            constructor(input: any) {
+                this.input = input;
+            }
+        }
+    };
+});
+
+describe("trigger crud", () => {
+    const handler = useHandler({
+        plugins: [...createMockTaskDefinitions()]
+    });
+
+    it("should trigger a task", async () => {
+        const context = await handler.handle();
+
+        const result = await context.tasks.trigger({
+            definition: "myCustomTask-1",
+            name: "A test of triggering task",
+            values: {
+                myAnotherCustomValue: "myAnotherCustomValue",
+                myCustomValue: "myCustomValue"
+            }
+        });
+
+        expect(result).toEqual({
+            id: expect.any(String),
+            name: "A test of triggering task",
+            definitionId: "myCustomTask-1",
+            values: {
+                myAnotherCustomValue: "myAnotherCustomValue",
+                myCustomValue: "myCustomValue"
+            },
+            status: TaskDataStatus.PENDING,
+            createdBy: createMockIdentity(),
+            createdOn: expect.any(Date),
+            savedOn: expect.any(Date),
+            startedOn: undefined,
+            finishedOn: undefined,
+            log: [],
+            eventResponse: expect.any(Object)
+        });
+    });
+});
diff --git a/packages/tasks/__tests__/graphql/tasks.test.ts b/packages/tasks/__tests__/graphql/tasks.test.ts
@@ -62,7 +62,8 @@ describe("graphql - tasks", () => {
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),
                                 createdOn: expect.any(String),
-                                savedOn: expect.any(String)
+                                savedOn: expect.any(String),
+                                eventResponse: null
                             },
                             {
                                 name: "My Custom Task #2",
@@ -77,7 +78,8 @@ describe("graphql - tasks", () => {
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),
                                 createdOn: expect.any(String),
-                                savedOn: expect.any(String)
+                                savedOn: expect.any(String),
+                                eventResponse: null
                             },
                             {
                                 name: "My Custom Task #1",
@@ -92,7 +94,8 @@ describe("graphql - tasks", () => {
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),
                                 createdOn: expect.any(String),
-                                savedOn: expect.any(String)
+                                savedOn: expect.any(String),
+                                eventResponse: null
                             }
                         ],
                         meta: {

diff --git a/packages/tasks/__tests__/helpers/graphql/tasks.ts b/packages/tasks/__tests__/helpers/graphql/tasks.ts
@@ -15,6 +15,7 @@ export const createListTasksQuery = () => {
                         status
                         createdOn
                         savedOn
+                        eventResponse
                         createdBy {
                             id
                             displayName

diff --git a/packages/tasks/package.json b/packages/tasks/package.json
@@ -24,7 +24,7 @@
     "@webiny/pubsub": "0.0.0",
     "@webiny/utils": "0.0.0",
     "aws-lambda": "^1.0.7",
-    "zod": "^3.22.4"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.6",

diff --git a/packages/tasks/src/crud/crud.tasks.ts b/packages/tasks/src/crud/crud.tasks.ts
@@ -42,6 +42,7 @@ const convertToTask = (entry: CmsEntry<ITaskData>): ITaskData => {
         definitionId: entry.values.definitionId,
         values: entry.values.values,
         status: entry.values.status,
+        eventResponse: entry.values.eventResponse,
         startedOn: getDate(entry.values.startedOn),
         finishedOn: getDate(entry.values.finishedOn),
         log: entry.values.log

diff --git a/packages/tasks/src/crud/model.ts b/packages/tasks/src/crud/model.ts
@@ -104,6 +104,13 @@ const modelPlugin = createCmsModel({
             type: "json",
             label: "Log",
             multipleValues: true
+        },
+        {
+            id: "eventResponse",
+            fieldId: "eventResponse",
+            storageId: "object@eventResponse",
+            type: "json",
+            label: "Event Response"
         }
     ],
     layout: [],

diff --git a/packages/tasks/src/crud/trigger.tasks.ts b/packages/tasks/src/crud/trigger.tasks.ts
@@ -54,9 +54,19 @@ export const createTriggerTasksCrud = (
 
             const task = await context.tasks.createTask<T>(input);
 
+            let event: Record<string, any> | null = null;
             try {
-                const event = await createEventBridgeEvent(task);
-                console.log("EVENT: ", JSON.stringify(event));
+                event = await createEventBridgeEvent(task);
+
+                if (!event) {
+                    throw new WebinyError(
+                        `Could not create the Event Bridge Event!`,
+                        "CREATE_EVENT_BRIDGE_EVENT_ERROR",
+                        {
+                            task
+                        }
+                    );
+                }
             } catch (ex) {
                 /**
                  * In case of failure to create the Event Bridge Event, we need to delete the task that was meant to be created.
@@ -65,7 +75,10 @@ export const createTriggerTasksCrud = (
                 await context.tasks.deleteTask(task.id);
                 throw ex;
             }
-            return task;
+
+            return await context.tasks.updateTask(task.id, {
+                eventResponse: event
+            });
         },
         stop: async (params: ITaskStopParams): Promise<ITaskData> => {
             const task = await context.tasks.getTask(params.id);

diff --git a/packages/tasks/src/types.ts b/packages/tasks/src/types.ts
@@ -47,6 +47,7 @@ export interface ITaskData<T = any> {
     createdBy: ITaskIdentity;
     startedOn?: Date;
     finishedOn?: Date;
+    eventResponse: Record<string, any>;
     log?: ITaskDataLog[];
 }
 
@@ -76,6 +77,7 @@ export interface ITaskUpdateData<T = ITaskDataValues> {
     log?: ITaskDataLog[];
     startedOn?: string;
     finishedOn?: string;
+    eventResponse?: Record<string, any>;
 }
 
 export interface OnTaskBeforeCreateTopicParams {

diff --git a/yarn.lock b/yarn.lock
@@ -17948,7 +17948,7 @@ __metadata:
     ttypescript: ^1.5.13
     type-fest: ^4.8.3
     typescript: 4.7.4
-    zod: ^3.22.4
+    zod: ^3.21.4
   languageName: unknown
   linkType: soft