webiny · Pavel910 · Jan 9, 2024 · Nov 29, 2023 · Nov 30, 2023 · Dec 4, 2023
diff --git a/.gitignore b/.gitignore
@@ -48,3 +48,5 @@ lerna.json
 
 # TODO remove after moving traffic splitting config to WPC
 gateway.*.json
+
+packages/tasks/tpl/*
diff --git a/.prettierignore b/.prettierignore
@@ -8,3 +8,4 @@
 .webiny/**
 packages/ui/src/RichTextEditor/editorjs/**
 lerna.json
+coverage/**
diff --git a/apps/api/graphql/package.json b/apps/api/graphql/package.json
@@ -12,6 +12,7 @@
     "@webiny/api-apw": "0.0.0",
     "@webiny/api-apw-scheduler-so-ddb": "0.0.0",
     "@webiny/api-audit-logs": "0.0.0",
+    "@webiny/api-background-tasks-ddb": "0.0.0",
     "@webiny/api-file-manager": "0.0.0",
     "@webiny/api-file-manager-ddb": "0.0.0",
     "@webiny/api-file-manager-s3": "0.0.0",
@@ -43,7 +44,8 @@
     "@webiny/handler-db": "0.0.0",
     "@webiny/handler-graphql": "0.0.0",
     "@webiny/handler-logs": "0.0.0",
-    "@webiny/project-utils": "0.0.0"
+    "@webiny/project-utils": "0.0.0",
+    "@webiny/tasks": "0.0.0"
   },
   "devDependencies": {
     "@webiny/cli-plugin-deploy-pulumi": "0.0.0",

diff --git a/apps/api/graphql/src/index.ts b/apps/api/graphql/src/index.ts
@@ -35,10 +35,13 @@ import { createStorageOperations as createApwSaStorageOperations } from "@webiny
 import { createAco } from "@webiny/api-aco";
 import { createAcoPageBuilderContext } from "@webiny/api-page-builder-aco";
 import { createAuditLogs } from "@webiny/api-audit-logs";
+import { createBackgroundTasks } from "@webiny/api-background-tasks-ddb";
 
 // Imports plugins created via scaffolding utilities.
 import scaffoldsPlugins from "./plugins/scaffolds";
 import { createBenchmarkEnablePlugin } from "~/plugins/benchmarkEnable";
+import { createCountDynamoDbTask } from "~/plugins/countDynamoDbTask";
+import { createContinuingTask } from "~/plugins/continuingTask";
 
 const debug = process.env.DEBUG === "true";
 const documentClient = getDocumentClient();
@@ -65,6 +68,7 @@ export const handler = createHandler({
             })
         }),
         createHeadlessCmsGraphQL(),
+        createBackgroundTasks(),
         createFileManagerContext({
             storageOperations: createFileManagerStorageOperations({
                 documentClient
@@ -119,7 +123,9 @@ export const handler = createHandler({
                 }
             });
         }),
-        createAuditLogs()
+        createAuditLogs(),
+        createCountDynamoDbTask(),
+        createContinuingTask()
     ],
     debug
 });
diff --git a/apps/api/graphql/src/plugins/continuingTask.ts b/apps/api/graphql/src/plugins/continuingTask.ts
@@ -0,0 +1,58 @@
+import { createTaskDefinition } from "@webiny/tasks";
+import { Context } from "../types";
+import { ITaskResponseContinueOptions } from "@webiny/tasks/response/abstractions";
+
+const MAX_RUNS = 5;
+
+const getMaxRuns = (input?: string | number) => {
+    const value = Number(input);
+    if (isNaN(value)) {
+        return MAX_RUNS;
+    }
+    return value > 0 && value < 50 ? value : MAX_RUNS;
+};
+
+interface TaskValues {
+    run?: number;
+    maxRuns?: string | number;
+    seconds?: number | string;
+}
+
+const getOptions = (values: TaskValues): ITaskResponseContinueOptions | undefined => {
+    if (!values.seconds || typeof values.seconds !== "number" || values.seconds < 1) {
+        return undefined;
+    }
+    return {
+        seconds: values.seconds
+    };
+};
+
+export const createContinuingTask = () => {
+    return createTaskDefinition<Context, TaskValues>({
+        id: "continuingTask",
+        title: "Mock Continuing Task",
+        description:
+            "This is a mock task which will continue to run until it reaches the defined run limit.",
+        async run(params) {
+            const { response, isAborted, input } = params;
+            const run = input.run || 0;
+            const maxRuns = getMaxRuns(input.maxRuns);
+            if (run >= maxRuns) {
+                return response.done("Got to the run limit.");
+            }
+            if (isAborted()) {
+                return response.aborted();
+            }
+
+            await new Promise(resolve => setTimeout(resolve, 10000));
+
+            return response.continue(
+                {
+                    ...(input || {}),
+                    run: run + 1
+                },
+                getOptions(input)
+            );
+        }
+    });
+};
diff --git a/apps/api/graphql/src/plugins/countDynamoDbTask.ts b/apps/api/graphql/src/plugins/countDynamoDbTask.ts
@@ -0,0 +1,25 @@
+import { createTaskDefinition } from "@webiny/tasks";
+import { getDocumentClient } from "@webiny/aws-sdk/client-dynamodb";
+
+export const createCountDynamoDbTask = () => {
+    return createTaskDefinition({
+        id: "countDdb",
+        title: "Count DynamoDB",
+        description: "Counts DynamoDB items.",
+        run: async params => {
+            const { response, isAborted, isCloseToTimeout } = params;
+            if (isAborted()) {
+                return response.aborted();
+            } else if (isCloseToTimeout()) {
+                return response.continue({});
+            }
+            const documentClient = getDocumentClient();
+
+            const results = await documentClient.scan({
+                TableName: process.env.DB_TABLE
+            });
+
+            return response.done(`Count: ${results.Count}`);
+        }
+    });
+};
diff --git a/apps/api/graphql/src/types.ts b/apps/api/graphql/src/types.ts
@@ -7,6 +7,7 @@ import { FormBuilderContext } from "@webiny/api-form-builder/types";
 import { CmsContext } from "@webiny/api-headless-cms/types";
 import { AcoContext } from "@webiny/api-aco/types";
 import { PbAcoContext } from "@webiny/api-page-builder-aco/types";
+import { Context as TasksContext } from "@webiny/tasks/types";
 
 // When working with the `context` object (for example while defining a new GraphQL resolver function),
 // you can import this interface and assign it to it. This will give you full autocomplete functionality
@@ -23,4 +24,5 @@ export interface Context
         CmsContext,
         FormBuilderContext,
         AcoContext,
+        TasksContext,
         PbAcoContext {}
diff --git a/apps/api/graphql/tsconfig.json b/apps/api/graphql/tsconfig.json
@@ -112,6 +112,12 @@
     },
     {
       "path": "../../../packages/api-apw-scheduler-so-ddb"
+    },
+    {
+      "path": "../../../packages/api-background-tasks-ddb/tsconfig.build.json"
+    },
+    {
+      "path": "../../../packages/tasks/tsconfig.build.json"
     }
   ],
   "compilerOptions": {
@@ -188,7 +194,11 @@
       "@webiny/handler-graphql/*": ["../../../packages/handler-graphql/src/*"],
       "@webiny/handler-graphql": ["../../../packages/handler-graphql/src"],
       "@webiny/handler-logs/*": ["../../../packages/handler-logs/src/*"],
-      "@webiny/handler-logs": ["../../../packages/handler-logs/src"]
+      "@webiny/handler-logs": ["../../../packages/handler-logs/src"],
+      "@webiny/api-background-tasks-ddb/*": ["../../../packages/api-background-tasks-ddb/src/*"],
+      "@webiny/api-background-tasks-ddb": ["../../../packages/api-background-tasks-ddb/src"],
+      "@webiny/tasks/*": ["../../../packages/tasks/src/*"],
+      "@webiny/tasks": ["../../../packages/tasks/src"]
     },
     "baseUrl": "."
   }

diff --git a/packages/api-background-tasks-ddb/.babelrc.js b/packages/api-background-tasks-ddb/.babelrc.js
@@ -0,0 +1 @@
+module.exports = require("@webiny/project-utils").createBabelConfigForNode({ path: __dirname });
diff --git a/packages/api-background-tasks-ddb/LICENSE b/packages/api-background-tasks-ddb/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/api-background-tasks-ddb/README.md b/packages/api-background-tasks-ddb/README.md
@@ -0,0 +1,6 @@
+# @webiny/api-background-tasks-ddb
+
+[![](https://img.shields.io/npm/dw/@webiny/api-background-tasks-ddb.svg)](https://www.npmjs.com/package/@webiny/api-background-tasks-ddb)
+[![](https://img.shields.io/npm/v/@webiny/api-background-tasks-ddb.svg)](https://www.npmjs.com/package/@webiny/api-background-tasks-ddb)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
diff --git a/packages/api-background-tasks-ddb/package.json b/packages/api-background-tasks-ddb/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "@webiny/api-background-tasks-ddb",
+  "version": "0.0.0",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webiny/webiny-js.git"
+  },
+  "description": "Wrapper for background tasks initialization for DynamoDB.",
+  "author": "Webiny LTD",
+  "license": "MIT",
+  "dependencies": {
+    "@webiny/plugins": "0.0.0",
+    "@webiny/tasks": "0.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.22.6",
+    "@babel/core": "^7.22.8",
+    "@webiny/cli": "0.0.0",
+    "@webiny/project-utils": "0.0.0",
+    "rimraf": "^3.0.2",
+    "ttypescript": "^1.5.12",
+    "typescript": "4.7.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "scripts": {
+    "build": "yarn webiny run build",
+    "watch": "yarn webiny run watch"
+  }
+}
diff --git a/packages/api-background-tasks-ddb/src/index.ts b/packages/api-background-tasks-ddb/src/index.ts
@@ -0,0 +1,6 @@
+import { Plugin } from "@webiny/plugins/types";
+import { createBackgroundTaskContext, createBackgroundTaskGraphQL } from "@webiny/tasks";
+
+export const createBackgroundTasks = (): Plugin[] => {
+    return [...createBackgroundTaskContext(), ...createBackgroundTaskGraphQL()];
+};
diff --git a/packages/api-background-tasks-ddb/tsconfig.build.json b/packages/api-background-tasks-ddb/tsconfig.build.json
@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "include": ["src"],
+  "references": [
+    { "path": "../plugins/tsconfig.build.json" },
+    { "path": "../tasks/tsconfig.build.json" }
+  ],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "declarationDir": "./dist",
+    "paths": { "~/*": ["./src/*"], "~tests/*": ["./__tests__/*"] },
+    "baseUrl": "."
+  }
+}
diff --git a/packages/api-background-tasks-ddb/tsconfig.json b/packages/api-background-tasks-ddb/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src", "__tests__"],
+  "references": [{ "path": "../plugins" }, { "path": "../tasks" }],
+  "compilerOptions": {
+    "rootDirs": ["./src", "./__tests__"],
+    "outDir": "./dist",
+    "declarationDir": "./dist",
+    "paths": {
+      "~/*": ["./src/*"],
+      "~tests/*": ["./__tests__/*"],
+      "@webiny/plugins/*": ["../plugins/src/*"],
+      "@webiny/plugins": ["../plugins/src"],
+      "@webiny/tasks/*": ["../tasks/src/*"],
+      "@webiny/tasks": ["../tasks/src"]
+    },
+    "baseUrl": "."
+  }
+}
diff --git a/packages/api-background-tasks-ddb/webiny.config.js b/packages/api-background-tasks-ddb/webiny.config.js
@@ -0,0 +1,8 @@
+const { createWatchPackage, createBuildPackage } = require("@webiny/project-utils");
+
+module.exports = {
+    commands: {
+        build: createBuildPackage({ cwd: __dirname }),
+        watch: createWatchPackage({ cwd: __dirname })
+    }
+};
diff --git a/packages/api-background-tasks-es/.babelrc.js b/packages/api-background-tasks-es/.babelrc.js
@@ -0,0 +1 @@
+module.exports = require("@webiny/project-utils").createBabelConfigForNode({ path: __dirname });
diff --git a/packages/api-background-tasks-es/LICENSE b/packages/api-background-tasks-es/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/api-background-tasks-es/README.md b/packages/api-background-tasks-es/README.md
@@ -0,0 +1,6 @@
+# @webiny/api-background-tasks-es
+
+[![](https://img.shields.io/npm/dw/@webiny/api-background-tasks-es.svg)](https://www.npmjs.com/package/@webiny/api-background-tasks-es)
+[![](https://img.shields.io/npm/v/@webiny/api-background-tasks-es.svg)](https://www.npmjs.com/package/@webiny/api-background-tasks-es)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
diff --git a/packages/api-background-tasks-es/package.json b/packages/api-background-tasks-es/package.json
@@ -0,0 +1,34 @@
+{
+  "name": "@webiny/api-background-tasks-es",
+  "version": "0.0.0",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webiny/webiny-js.git"
+  },
+  "description": "Wrapper for background tasks initialization for Elasticsearch.",
+  "author": "Webiny LTD",
+  "license": "MIT",
+  "dependencies": {
+    "@webiny/api-elasticsearch-tasks": "0.0.0",
+    "@webiny/plugins": "0.0.0",
+    "@webiny/tasks": "0.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.22.6",
+    "@babel/core": "^7.22.8",
+    "@webiny/cli": "0.0.0",
+    "@webiny/project-utils": "0.0.0",
+    "rimraf": "^3.0.2",
+    "ttypescript": "^1.5.12",
+    "typescript": "4.7.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "scripts": {
+    "build": "yarn webiny run build",
+    "watch": "yarn webiny run watch"
+  }
+}
diff --git a/packages/api-background-tasks-es/src/index.ts b/packages/api-background-tasks-es/src/index.ts
@@ -0,0 +1,11 @@
+import { Plugin } from "@webiny/plugins/types";
+import { createBackgroundTaskGraphQL, createBackgroundTaskContext } from "@webiny/tasks";
+import { createElasticsearchBackgroundTasks } from "@webiny/api-elasticsearch-tasks";
+
+export const createBackgroundTasks = (): Plugin[] => {
+    return [
+        ...createBackgroundTaskContext(),
+        ...createBackgroundTaskGraphQL(),
+        ...createElasticsearchBackgroundTasks()
+    ];
+};
diff --git a/packages/api-background-tasks-es/tsconfig.build.json b/packages/api-background-tasks-es/tsconfig.build.json
@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "include": ["src"],
+  "references": [
+    { "path": "../api-elasticsearch-tasks/tsconfig.build.json" },
+    { "path": "../plugins/tsconfig.build.json" },
+    { "path": "../tasks/tsconfig.build.json" }
+  ],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "declarationDir": "./dist",
+    "paths": { "~/*": ["./src/*"], "~tests/*": ["./__tests__/*"] },
+    "baseUrl": "."
+  }
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,3 +48,5 @@ lerna.json

		# TODO remove after moving traffic splitting config to WPC
		gateway.*.json

		packages/tasks/tpl/*
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = require("@webiny/project-utils").createBabelConfigForNode({ path: __dirname });