fix: task status after next merge

webiny · Dec 27, 2023 · 8216b3b · 8216b3b
1 parent 19e5e5f
commit 8216b3b
Show file tree

Hide file tree

Showing 18 changed files with 49 additions and 42 deletions.
diff --git a/packages/api-elasticsearch-tasks/__tests__/mocks/task.ts b/packages/api-elasticsearch-tasks/__tests__/mocks/task.ts
@@ -8,11 +8,11 @@ export const createTaskMock = (task?: Partial<ITaskData>): ITaskData => {
         values: {},
         name: "A custom task defined via method",
         log: [],
-        createdOn: new Date(),
-        savedOn: new Date(),
-        status: TaskDataStatus.PENDING,
+        createdOn: new Date().toISOString(),
+        savedOn: new Date().toISOString(),
+        taskStatus: TaskDataStatus.PENDING,
         createdBy: createMockIdentity(),
-        eventResponse: {},
+        eventResponse: undefined,
         ...task
     };
 };
diff --git a/packages/api-elasticsearch-tasks/__tests__/tasks/reindexing/reindexing.test.ts b/packages/api-elasticsearch-tasks/__tests__/tasks/reindexing/reindexing.test.ts
@@ -53,7 +53,7 @@ describe("reindexing", () => {
             savedOn: expect.stringMatching(/^20/),
             startedOn: expect.stringMatching(/^20/),
             finishedOn: expect.stringMatching(/^20/),
-            status: TaskDataStatus.SUCCESS,
+            taskStatus: TaskDataStatus.SUCCESS,
             log: [
                 {
                     message: "Task started.",
@@ -92,7 +92,7 @@ describe("reindexing", () => {
             savedOn: expect.stringMatching(/^20/),
             startedOn: expect.stringMatching(/^20/),
             finishedOn: undefined,
-            status: TaskDataStatus.RUNNING,
+            taskStatus: TaskDataStatus.RUNNING,
             log: [
                 {
                     message: "Task started.",
@@ -126,7 +126,7 @@ describe("reindexing", () => {
             savedOn: expect.stringMatching(/^20/),
             startedOn: expect.stringMatching(/^20/),
             finishedOn: expect.stringMatching(/^20/),
-            status: TaskDataStatus.SUCCESS,
+            taskStatus: TaskDataStatus.SUCCESS,
             log: [
                 {
                     message: "Task started.",

diff --git a/packages/tasks/__tests__/crud/store.test.ts b/packages/tasks/__tests__/crud/store.test.ts
@@ -1,6 +1,6 @@
 import { useHandler } from "~tests/helpers/useHandler";
 import { createTaskDefinition } from "~/task";
-import { TaskDataStatus } from "~/types";
+import { ITaskData, TaskDataStatus } from "~/types";
 import { NotFoundError } from "@webiny/handler-graphql";
 import WebinyError from "@webiny/error";
 import { createMockIdentity } from "~tests/mocks/identity";
@@ -91,7 +91,7 @@ describe("store crud", () => {
                 someOtherValue: 123
             }
         });
-        const expectedCreatedTask = {
+        const expectedCreatedTask: ITaskData = {
             id: expect.any(String),
             createdOn: expect.stringMatching(/^20/),
             savedOn: expect.stringMatching(/^20/),
@@ -105,7 +105,8 @@ describe("store crud", () => {
             log: [],
             startedOn: undefined,
             finishedOn: undefined,
-            status: TaskDataStatus.PENDING
+            eventResponse: undefined,
+            taskStatus: TaskDataStatus.PENDING
         };
         expect(task).toEqual(expectedCreatedTask);
 
@@ -129,7 +130,7 @@ describe("store crud", () => {
                 addedNewValue: "yes!"
             }
         });
-        const expectedUpdatedTask = {
+        const expectedUpdatedTask: ITaskData = {
             id: expect.any(String),
             createdOn: expect.stringMatching(/^20/),
             savedOn: expect.stringMatching(/^20/),
@@ -144,7 +145,8 @@ describe("store crud", () => {
             log: [],
             startedOn: undefined,
             finishedOn: undefined,
-            status: TaskDataStatus.PENDING
+            eventResponse: undefined,
+            taskStatus: TaskDataStatus.PENDING
         };
         expect(updatedTask).toEqual(expectedUpdatedTask);
 

diff --git a/packages/tasks/__tests__/crud/trigger.test.ts b/packages/tasks/__tests__/crud/trigger.test.ts
@@ -47,7 +47,7 @@ describe("trigger crud", () => {
                 myAnotherCustomValue: "myAnotherCustomValue",
                 myCustomValue: "myCustomValue"
             },
-            status: TaskDataStatus.PENDING,
+            taskStatus: TaskDataStatus.PENDING,
             createdBy: createMockIdentity(),
             createdOn: expect.stringMatching(/^20/),
             savedOn: expect.stringMatching(/^20/),

diff --git a/packages/tasks/__tests__/graphql/tasks.test.ts b/packages/tasks/__tests__/graphql/tasks.test.ts
@@ -57,7 +57,7 @@ describe("graphql - tasks", () => {
                                     someOtherValue: 12345678
                                 },
                                 id: expect.any(String),
-                                status: TaskDataStatus.PENDING,
+                                taskStatus: TaskDataStatus.PENDING,
                                 startedOn: null,
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),
@@ -73,7 +73,7 @@ describe("graphql - tasks", () => {
                                     someOtherValue: 4321
                                 },
                                 id: expect.any(String),
-                                status: TaskDataStatus.PENDING,
+                                taskStatus: TaskDataStatus.PENDING,
                                 startedOn: null,
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),
@@ -89,7 +89,7 @@ describe("graphql - tasks", () => {
                                     someOtherValue: 123
                                 },
                                 id: expect.any(String),
-                                status: TaskDataStatus.PENDING,
+                                taskStatus: TaskDataStatus.PENDING,
                                 startedOn: null,
                                 finishedOn: null,
                                 createdBy: createMockIdentity(),

diff --git a/packages/tasks/__tests__/helpers/graphql/tasks.ts b/packages/tasks/__tests__/helpers/graphql/tasks.ts
@@ -12,7 +12,7 @@ export const createListTasksQuery = () => {
                         id
                         definitionId
                         name
-                        status
+                        taskStatus
                         createdOn
                         savedOn
                         eventResponse

diff --git a/packages/tasks/__tests__/mocks/task.ts b/packages/tasks/__tests__/mocks/task.ts
@@ -28,7 +28,7 @@ export const createMockTask = (task?: Partial<ITaskData>): ITaskData => {
         log: [],
         createdOn: new Date().toISOString(),
         savedOn: new Date().toISOString(),
-        status: TaskDataStatus.PENDING,
+        taskStatus: TaskDataStatus.PENDING,
         createdBy: createMockIdentity(),
         eventResponse: createMockTaskEventResponse(),
         ...task

diff --git a/packages/tasks/__tests__/runner/taskManager.test.ts b/packages/tasks/__tests__/runner/taskManager.test.ts
@@ -162,7 +162,7 @@ describe("task manager", () => {
                     id: "myCustomTaskDataId",
                     data: {
                         ...task,
-                        status: "running",
+                        taskStatus: "running",
                         log: [
                             {
                                 message: "Task started.",

diff --git a/packages/tasks/src/crud/crud.tasks.ts b/packages/tasks/src/crud/crud.tasks.ts
@@ -28,7 +28,7 @@ const convertToTask = (entry: CmsEntry<ITaskData>): ITaskData => {
         name: entry.values.name,
         definitionId: entry.values.definitionId,
         values: entry.values.values,
-        status: entry.values.status,
+        taskStatus: entry.values.taskStatus,
         eventResponse: entry.values.eventResponse,
         startedOn: entry.values.startedOn,
         finishedOn: entry.values.finishedOn,
@@ -89,7 +89,7 @@ export const createTaskCrud = (context: Context): ITasksContextCrudObject => {
             return await context.cms.createEntry(model, {
                 ...values,
                 log: [],
-                status: TaskDataStatus.PENDING
+                taskStatus: TaskDataStatus.PENDING
             });
         });
         return convertToTask(entry as unknown as CmsEntry<ITaskData>);

diff --git a/packages/tasks/src/crud/model.ts b/packages/tasks/src/crud/model.ts
@@ -53,9 +53,9 @@ const modelPlugin = createCmsModel({
             label: "Values"
         },
         {
-            id: "status",
-            fieldId: "status",
-            storageId: "text@status",
+            id: "taskStatus",
+            fieldId: "taskStatus",
+            storageId: "text@taskStatus",
             type: "text",
             label: "Status",
             predefinedValues: {

diff --git a/packages/tasks/src/crud/trigger.tasks.ts b/packages/tasks/src/crud/trigger.tasks.ts
@@ -87,8 +87,8 @@ export const createTriggerTasksCrud = (
             }
             try {
                 return await context.tasks.updateTask(task.id, {
-                    status: TaskDataStatus.ABORTED,
-                    log: (task.log || []).concat([
+                    taskStatus: TaskDataStatus.ABORTED,
+                    log: task.log.concat([
                         {
                             message: params.message || "Task aborted.",
                             createdOn: new Date().toISOString()

diff --git a/packages/tasks/src/graphql/index.ts b/packages/tasks/src/graphql/index.ts
@@ -69,7 +69,7 @@ export const createGraphQL = () => {
             fields: model.fields,
             type: "manage",
             fieldTypePlugins,
-            excludeFields: ["entryId", "status"]
+            excludeFields: ["entryId"]
         });
 
         const sortEnumRender = renderSortEnum({

diff --git a/packages/tasks/src/response/DatabaseResponse.ts b/packages/tasks/src/response/DatabaseResponse.ts
@@ -41,9 +41,9 @@ export class DatabaseResponse implements IResponseAsync {
         try {
             const task = this.store.getTask();
             await this.store.updateTask({
-                status: TaskDataStatus.SUCCESS,
+                taskStatus: TaskDataStatus.SUCCESS,
                 finishedOn: new Date().toISOString(),
-                log: (task.log || []).concat([
+                log: task.log.concat([
                     {
                         message: message || "Task done.",
                         createdOn: new Date().toISOString()
@@ -76,8 +76,8 @@ export class DatabaseResponse implements IResponseAsync {
                     ...task.values,
                     ...params.values
                 },
-                status: TaskDataStatus.RUNNING,
-                log: (task.log || []).concat([
+                taskStatus: TaskDataStatus.RUNNING,
+                log: task.log.concat([
                     {
                         message: "Task continuing.",
                         createdOn: new Date().toISOString(),
@@ -121,9 +121,9 @@ export class DatabaseResponse implements IResponseAsync {
         try {
             const task = this.store.getTask();
             await this.store.updateTask({
-                status: TaskDataStatus.FAILED,
+                taskStatus: TaskDataStatus.FAILED,
                 finishedOn: new Date().toISOString(),
-                log: (task.log || []).concat([
+                log: task.log.concat([
                     {
                         message: params.error.message,
                         createdOn: new Date().toISOString(),

diff --git a/packages/tasks/src/response/abstractions/ResponseContinueResult.ts b/packages/tasks/src/response/abstractions/ResponseContinueResult.ts
@@ -1,6 +1,11 @@
 import { ITaskDataValues, TaskResponseStatus } from "~/types";
 import { IResponseBaseResult } from "./ResponseBaseResult";
 
+/**
+ * Wait can be used to pause next iteration of the Lambda execution.
+ * For example, if the task is hammering the Elasticsearch cluster too much, you can use this to pause the execution for some time.
+ */
+
 export interface IResponseContinueParams<T = ITaskDataValues> {
     tenant?: string;
     locale?: string;

diff --git a/packages/tasks/src/runner/TaskControl.ts b/packages/tasks/src/runner/TaskControl.ts
@@ -35,7 +35,7 @@ export class TaskControl implements ITaskControl {
          * Make sure that task does not run if it is aborted.
          * This will effectively end the Step Function execution with a "success" status.
          */
-        if (task.status === TaskDataStatus.ABORTED) {
+        if (task.taskStatus === TaskDataStatus.ABORTED) {
             return this.response.aborted();
         }
 

diff --git a/packages/tasks/src/runner/TaskManager.ts b/packages/tasks/src/runner/TaskManager.ts
@@ -50,9 +50,9 @@ export class TaskManager<T = ITaskDataValues> implements ITaskManager<T> {
             try {
                 await this.store.updateTask(task => {
                     return {
-                        status: TaskDataStatus.RUNNING,
+                        taskStatus: TaskDataStatus.RUNNING,
                         startedOn: new Date().toISOString(),
-                        log: (task.log || []).concat([
+                        log: task.log.concat([
                             {
                                 message: "Task started.",
                                 createdOn: new Date().toISOString()

diff --git a/packages/tasks/src/runner/TaskManagerStore.ts b/packages/tasks/src/runner/TaskManagerStore.ts
@@ -43,7 +43,7 @@ export class TaskManagerStore implements ITaskManagerStore {
     }
 
     public getStatus(): TaskDataStatus {
-        return this.task.status;
+        return this.task.taskStatus;
     }
 
     public setTask(task: ITaskData): void {
@@ -89,7 +89,7 @@ export class TaskManagerStore implements ITaskManagerStore {
 
     public async addLog(log: ITaskDataLog): Promise<void> {
         this.task = await this.context.tasks.updateTask(this.task.id, {
-            log: (this.task.log || []).concat([log])
+            log: this.task.log.concat([log])
         });
     }
 }
diff --git a/packages/tasks/src/types.ts b/packages/tasks/src/types.ts
@@ -43,16 +43,16 @@ export interface ITaskIdentity {
 export interface ITaskData<T = any> {
     id: string;
     name: string;
-    status: TaskDataStatus;
+    taskStatus: TaskDataStatus;
     definitionId: string;
     values: T;
     createdOn: string;
     savedOn: string;
     createdBy: ITaskIdentity;
     startedOn?: string;
     finishedOn?: string;
-    eventResponse: EventBridgeClientSendResponse;
-    log?: ITaskDataLog[];
+    eventResponse: EventBridgeClientSendResponse | undefined;
+    log: ITaskDataLog[];
 }
 
 export type IGetTaskResponse<T = any> = ITaskData<T> | null;
@@ -77,7 +77,7 @@ export interface ITaskCreateData<T = ITaskDataValues> {
 export interface ITaskUpdateData<T = ITaskDataValues> {
     name?: string;
     values?: T;
-    status?: TaskDataStatus;
+    taskStatus?: TaskDataStatus;
     log?: ITaskDataLog[];
     startedOn?: string;
     finishedOn?: string;