psdev-task-manager 1.1.4 → 1.1.6

package/.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+build
+coverage
+*.min.js
+package-lock.json
+

package/.prettierrc.json

@@ -0,0 +1,16 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "requirePragma": false,
+  "insertPragma": false,
+  "proseWrap": "preserve"
+}

package/README.md

@@ -1,2 +1,3 @@
 # task-manager
+
 Task manager library

package/backend/tasks/index.js

@@ -7,5 +7,4 @@ module.exports = {
   ...require('./taskManager'),
   ...require('./utils'),
   ...require('./tasks'),
-  
 };

package/backend/tasks/parentChildTasks/index.js

@@ -2,5 +2,5 @@ module.exports = {
   ...require('./handler'),
   ...require('./childScheduler'),
   ...require('./parentStatusManager'),
-  ...require('./utils')
+  ...require('./utils'),
 };

package/backend/tasks/taskManager.js

@@ -1,6 +1,6 @@
 const { withDuration, withSuccessRateLogs } = require('psdev-utils');
 
-const { TASK_STATUS, CRON_JOB_MAX_DURATION_SEC } = require('./consts');
+const { TASK_STATUS, CRON_JOB_MAX_DURATION_SEC, TASK_MAX_TRIES } = require('./consts');
 const { scheduleChildTasksAndUpdateParent } = require('./parentChildTasks/handler');
 const {
   saveTaskResultToAdditionalCollection,
@@ -136,7 +136,7 @@ function taskManager() {
   return {
     schedule: insertNewTask,
     scheduleInBulk: bulkInsertTasks,
-    processTask : (...args) => {
+    processTask: (...args) => {
       const requestName = `processTask_${args[0].name}`; //To get success rate analysis per task
       return withSuccessRateLogs(requestName, () => processTask(...args));
     },

package/backend/tasks/tasks.js

@@ -1,29 +1,29 @@
 const TASKS = {
-    TEST_TASK: {
-      name: 'TestTask',
-      getIdentifier: (task) => (task),
-      process: (task) => {
-        const data = task.data || {};
-        let error;
-        if (data.retries){
-          error = task.error ? Number(task.error) - 1 : data.retries - 1;
-        }
-        if (data.shouldFail && (!error || error > 0)){
-            throw new Error(error?.toString() || 'Test error'); 
-        }
-        return 'test';
-      },
-      shouldSkipCheck: (task) => task.data.shouldSkip,
-      estimatedDurationSec:2,
+  TEST_TASK: {
+    name: 'TestTask',
+    getIdentifier: task => task,
+    process: task => {
+      const data = task.data || {};
+      let error;
+      if (data.retries) {
+        error = task.error ? Number(task.error) - 1 : data.retries - 1;
+      }
+      if (data.shouldFail && (!error || error > 0)) {
+        throw new Error(error?.toString() || 'Test error');
+      }
+      return 'test';
     },
-    BAD_TASK: {
-      name: 'BadTask',
-      getIdentifier: () => true,
-      process: () => 'test',
-      shouldSkipCheck: () => false,
-    },
-  };
+    shouldSkipCheck: task => task.data.shouldSkip,
+    estimatedDurationSec: 2,
+  },
+  BAD_TASK: {
+    name: 'BadTask',
+    getIdentifier: () => true,
+    process: () => 'test',
+    shouldSkipCheck: () => false,
+  },
+};
 
-  module.exports = {
-    TASKS,
-  };
+module.exports = {
+  TASKS,
+};

package/backend/tasks/utils.js

@@ -44,7 +44,7 @@ async function createCollectionIfMissing(
       if (collectionType === 'singleItem') {
         createDataCollectionOptions.plugins = [
           {
-            type: "SINGLE_ITEM",
+            type: 'SINGLE_ITEM',
             singleItemOptions: {},
           },
         ];
@@ -171,15 +171,13 @@ const filterScheduledTasksByStatus = (tasks, tasksConfig) => {
   console.log(
     `filterScheduledTasksByStatus: tasks count: ${tasks.length} tasksConfig: ${JSON.stringify(tasksConfig)}`
   );
-  const shouldIncludeTask = (task, tasksConfig) => {
+  const shouldIncludeTask = (task, taskConfig) => {
     console.log(`filterScheduledTasksByStatus: task: ${JSON.stringify(task)}`);
-    console.log(
-      `filterScheduledTasksByStatus: taskConfig: ${JSON.stringify(taskConfig)}`
-    );
+    console.log(`filterScheduledTasksByStatus: taskConfig: ${JSON.stringify(taskConfig)}`);
     const { status } = task;
     if (status === TASK_STATUS.IN_PROGRESS) {
       //Only include parent tasks that are in progress, to continue running next children
-      return isParentTask(task, tasksConfig[task.name]);
+      return isParentTask(task, taskConfig);
     }
     if (status === TASK_STATUS.FAILED) {
       // Exclude if it's a parent task, if parent task failed, we don't retry it anymore
@@ -233,7 +231,11 @@ const getTaskScheduledChildren = async parentTaskId => {
 };
 
 const getTasksToProcess = ({ scheduledTasks, tasksConfig, maxDuration }) => {
-  console.log('getTasksToProcess:', { scheduledTasksCount: scheduledTasks.length, tasksConfig, maxDuration });
+  console.log('getTasksToProcess:', {
+    scheduledTasksCount: scheduledTasks.length,
+    tasksConfig,
+    maxDuration,
+  });
   const tasksToProcess = [];
   let totalDuration = 0;
   console.log(`tasksConfig is : ${JSON.stringify(tasksConfig)}`);

package/eslint.config.js

@@ -0,0 +1,113 @@
+const js = require('@eslint/js');
+const prettierConfig = require('eslint-config-prettier');
+const importPlugin = require('eslint-plugin-import');
+const prettier = require('eslint-plugin-prettier');
+const promisePlugin = require('eslint-plugin-promise');
+const globals = require('globals');
+
+module.exports = [
+  // Recommended base configurations
+  js.configs.recommended,
+  prettierConfig,
+
+  // Main configuration
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'commonjs',
+      globals: {
+        ...globals.node,
+        ...globals.es2021,
+        ...globals.jest,
+      },
+    },
+    plugins: {
+      prettier,
+      import: importPlugin,
+      promise: promisePlugin,
+    },
+    rules: {
+      // Error prevention
+      'no-var': 'error',
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+      'no-console': ['warn', { allow: ['warn', 'error', 'log', 'info'] }],
+      'no-debugger': 'warn',
+      'no-duplicate-imports': 'error',
+      'no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true }],
+      'no-use-before-define': ['error', { functions: false }],
+
+      // Best practices
+      'prefer-const': 'error',
+      'no-const-assign': 'error',
+      'prefer-arrow-callback': 'error',
+      'arrow-body-style': ['error', 'as-needed'],
+      'no-return-await': 'off',
+      'require-await': 'warn',
+
+      // Import rules
+      'import/order': [
+        'error',
+        {
+          groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+          'newlines-between': 'always',
+          alphabetize: { order: 'asc', caseInsensitive: true },
+        },
+      ],
+      'import/no-unresolved': 'error',
+      'import/no-duplicates': 'error',
+      'import/no-commonjs': 'off',
+      'import/no-dynamic-require': 'off',
+
+      // Promise rules
+      'promise/always-return': 'off',
+      'promise/no-return-wrap': 'error',
+      'promise/param-names': 'error',
+      'promise/catch-or-return': 'error',
+      'promise/no-native': 'off',
+      'promise/no-callback-in-promise': 'warn',
+      'promise/no-promise-in-callback': 'warn',
+      'promise/no-nesting': 'warn',
+
+      // Prettier rules
+      'prettier/prettier': [
+        'error',
+        {
+          singleQuote: true,
+          trailingComma: 'es5',
+          printWidth: 100,
+          tabWidth: 2,
+          semi: true,
+          bracketSpacing: true,
+          arrowParens: 'avoid',
+          endOfLine: 'lf',
+        },
+      ],
+    },
+    settings: {
+      'import/resolver': {
+        node: {
+          extensions: ['.js', '.jsx', '.ts', '.tsx'],
+        },
+      },
+    },
+  },
+
+  // Test files override
+  {
+    files: ['**/*.test.js', '**/*.spec.js'],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+    rules: {
+      'no-console': 'off',
+    },
+  },
+
+  // Ignore patterns
+  {
+    ignores: ['node_modules/**', 'dist/**', 'build/**', 'coverage/**', '*.min.js'],
+  },
+];

package/index.js

@@ -1,4 +1,4 @@
 module.exports = {
   ...require('./backend'),
-  ...require('./public')
+  ...require('./public'),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "psdev-task-manager",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Task manager library",
   "keywords": [
     "task-manager"
@@ -18,11 +18,27 @@
   "type": "commonjs",
   "main": "index.js",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"**/*.{js,json,md}\"",
+    "format:check": "prettier --check \"**/*.{js,json,md}\"",
+    "prepare": "husky"
   },
   "dependencies": {
     "@wix/data": "^1.0.273",
     "@wix/essentials": "^0.1.27",
-    "psdev-utils": "1.0.2"
+    "psdev-utils": "1.1.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "eslint": "^9.12.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "globals": "^15.10.0",
+    "husky": "^9.1.6",
+    "prettier": "^3.3.3"
   }
 }

package/public/consts.js

@@ -26,4 +26,4 @@ const COLLECTIONS_FIELDS = {
 module.exports = {
   COLLECTIONS,
   COLLECTIONS_FIELDS,
-};
+};

package/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["plugin:@wix/cli/recommended"]
-}

package/src/backend/README.md

@@ -1,115 +0,0 @@
-# The Backend Code Folder
-
-This folder contains the backend code files for your site. These files correspond to the ones found in the [**Backend**](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar#backend) section of the **Public & Backend** 
-![image](https://user-images.githubusercontent.com/89579857/184862813-e55cdd98-b723-4d64-b73c-593eb9af21c7.png) tab in the Velo sidebar. Add the following files to this folder to include them in your site:
-+ [**Web Modules:**](https://support.wix.com/en/article/velo-web-modules-calling-backend-code-from-the-frontend)  
-  These are files that allow you to expose functions in your site's backend that you can run in your frontend code. These files require a `.jsw` file extension.
-  >**Note:**  
-  >You can't change [web module permissions](https://support.wix.com/en/article/velo-about-web-module-permissions) in Wix editors when using Git Integration & Wix CLI. Instead, use the [permissions.json](#permissionsjson) file to set function permissions.
-
-+ **data.js**  
-  A file for [adding data hooks](https://support.wix.com/en/article/velo-using-data-hooks) to your site's collections.
-
-+ **routers.js**  
-  A file for implementing [routing and sitemap](https://support.wix.com/en/article/velo-about-routers#routing-code) functionality for your site.
-
-+ **events.js**  
-  A file for implementing your site's [backend event handlers](https://support.wix.com/en/article/velo-backend-events). 
-
-+ **http-functions.js**  
-  A file for implementing [HTTP endpoints](https://www.wix.com/velo/reference/wix-http-functions/introduction) that are exposed on your site.
-
-+ **jobs.config**  
-  A file for [scheduling recurring jobs](https://support.wix.com/en/article/velo-scheduling-recurring-jobs). Jobs consist of other backend code that's run at regular intervals.
-  
-+ **General backend files**  
-  JavaScript code files. You can import code from these files into any other backend file on your site. These files require a `.js` file extension.
-
-Use the following syntax to import code from backend files: 
-```js 
-import { myFunctionName } from 'backend/myFileName';
-```  
-Trying to import from the relative path in your site's repo doesn't work.
-
-Learn more about [this repo's file structure](https://support.wix.com/en/article/velo-understanding-your-sites-github-repository-beta).
-
-## permissions.json
-This file defines [permissions](https://support.wix.com/en/article/velo-about-web-module-permissions) for the functions in your web module files. The file contains a key, `"web-methods"`, whose value is an object that can contain keys named after the web module files in your `backend` folder. Name these keys with the following syntax: `"backend/{path to file}myFile.jsw"`. The value for each file name key is an object that can contain keys named after the functions in that file. Each function key has a value with the following format:
-```js
-"backend/myFile.jsw": {
-  "siteOwner" : {
-    "invoke" : // Boolean
-  },
-  "siteMember" : {
-    "invoke" : // Boolean
-  },
-  "anonymous" : {
-    "invoke" : // Boolean
-  }  
-}
-```
-These values reflect the different levels of web module function permissions. You can set them using the following options:
-| |`siteOwner`|`siteMember`|`anonymous`|
-|-|-----------|------------|-----------|
-|Owner-only access| `true` | `false` | `false`|
-|Site member access| `true` | `true` | `false`|
-|Anyone can access| `true` | `true`| `true`|
-
-The `"web-methods"` object must also contain a `"*"` key. The value for this key defines the default permissions that are applied to any function whose permissions you don't set manually.
-
-Here is an example `permissions.json` file for a site with a backend file called `helperFunctions.jsw`. The file's functions are called `calculate`, `fetchData`, and `syncWithServer`. In this case anyone can call `calculate`, site members can call `syncWithServer`, and only site owners can call `fetchData`.
-
-```json
-{
-  "web-methods": {
-    "*": {
-      "*": {
-        "siteOwner": {
-          "invoke": true
-        },
-        "siteMember": {
-          "invoke": true
-        },
-        "anonymous": {
-          "invoke": true
-        }
-      }
-    },
-    "backend/helperFunctions.jsw": {
-      "calculate": {
-        "siteOwner": {
-          "invoke": true
-        },
-        "siteMember": {
-          "invoke": true
-        },
-        "anonymous": {
-          "invoke": true
-        }
-      },
-      "fetchData": {
-        "siteOwner": {
-          "invoke": true
-        },
-        "siteMember": {
-          "invoke": false
-        },
-        "anonymous": {
-          "invoke": false
-        }
-      },
-      "syncWithServer": {
-        "siteOwner": {
-          "invoke": true
-        },
-        "siteMember": {
-          "invoke": true
-        },
-        "anonymous": {
-          "invoke": false
-        }
-      }
-    }
-  }
-}
-```

package/src/backend/http-functions.js

@@ -1,40 +0,0 @@
-import { response } from "wix-http-functions";
-import { rootMethods } from './rootMethods';
-
-export async function post_getResult(request) {
-    let options = {
-        headers: { "Content-Type": "application/json" }
-    };
-
-    try {
-        const methodsToExecute = await request.body.text();
-        /**
-         * Dynamically executes a method string from the request body.
-         *
-         * - `methodsToExecute` is expected to be a string, e.g.:
-         *      "taskManager().schedule({ name: 'BadTask', data: {}, type: 'scheduled' })"
-         * - Only root methods defined in `rootMethods` are allowed.
-         * - We use `new Function(...)` to create a scoped function so that the
-         *   root methods (taskManager, wixData, etc.) are available in the execution context.
-         * - The result of executing the string is returned and sent in the response.
-         *
-         * ⚠️ Warning: This executes arbitrary code strings, so only trusted input
-         * should be passed here.
-         */
-        const result = await (new Function(...Object.keys(rootMethods), `return ${methodsToExecute}`))(
-            ...Object.values(rootMethods)
-        );
-
-
-        options.body = { result };
-        options.status = 200;
-
-    } catch (err) {
-        options.body = {
-            message: err.message
-        };
-        options.status = 500;
-    }
-
-    return response(options);
-}

package/src/backend/permissions.json

@@ -1,17 +0,0 @@
-{
-  "web-methods": {
-    "*": {
-      "*": {
-        "siteOwner": {
-          "invoke": true
-        },
-        "siteMember": {
-          "invoke": true
-        },
-        "anonymous": {
-          "invoke": true
-        }
-      }
-    }
-  }
-}

package/src/backend/rootMethods.js

@@ -1,8 +0,0 @@
-// rootMethods.js
-import { taskManager } from 'psdev-task-manager';
-import wixData from 'wix-data';
-
-export const rootMethods = {
-    taskManager,
-    wixData
-};

package/src/pages/Home.c1dmp.js

@@ -1,10 +0,0 @@
-// API Reference: https://www.wix.com/velo/reference/api-overview/introduction
-// “Hello, World!” Example: https://learn-code.wix.com/en/article/hello-world
-
-$w.onReady(function () {
-    // Write your JavaScript here
-
-    // To select an element by ID use: $w('#elementID')
-
-    // Click 'Preview' to run your code
-});

package/src/pages/README.md

@@ -1,21 +0,0 @@
-# The Page Code Folder
-
-This folder contains code files for each of the pages on your site as well as the [masterpage.js](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar#global-site) file. The code you add to these files runs when visitors open pages on your site. These files correspond to the ones found in the [**Main Pages**](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar#main-pages) section of the **Page Code** ![image](https://user-images.githubusercontent.com/89579857/184645988-6d4ee6d3-34ab-45bc-b914-5779a7de0cad.png) tab in the Velo sidebar.
-
-When you add a page to your site in a Wix editor in your browser, a code file for that page gets added to your repo. The name of the file has 2 components: the name of the page that you define when you create it, and an internal ID string. The sections are separated by a period. 
-
-![image](https://user-images.githubusercontent.com/89579857/188305074-6e2ee718-13b8-435d-9c75-bcb126f35718.png)
-
-When you [add a dynamic page](https://support.wix.com/en/article/content-manager-about-dynamic-pages#adding-dynamic-pages) to your site 2 code files are added to the site's repo corresponding to the dynamic list and dynamic item pages.
-
-When you open a page's code file, you see the same sample code that appears in these code files in Wix editors in your browser.  
-
-![image](https://user-images.githubusercontent.com/89579857/184646571-1e14f166-2b86-4f21-bf57-83468251bca8.png)
-
-When you delete a page in a Wix editor in your browser, the page's corresponding code file is deleted from your repo.
-
-> **Note:**
-> * You can't create new code files for pages from your IDE. To add a file, create a new page for your site in a Wix editor in your browser, and [sync](https://support.wix.com/en/article/velo-working-with-the-local-editor-beta#sync-design-changes-to-your-ide) your site with your local IDE.
-> * Do not rename code files for pages. Wix uses these file names to associate the files with the appropriate pages on your site. If you rename a file, your code is ignored and a new code file is created for the page.
-
-Learn more about [this repo's file structure](https://support.wix.com/en/article/velo-understanding-your-sites-github-repository-beta).

package/src/pages/masterPage.js

@@ -1,10 +0,0 @@
-// API Reference: https://www.wix.com/velo/reference/api-overview/introduction
-// “Hello, World!” Example: https://learn-code.wix.com/en/article/hello-world
-
-$w.onReady(function () {
-    // Write your JavaScript here
-
-    // To select an element by ID use: $w('#elementID')
-
-    // Click 'Preview' to run your code
-});

package/src/public/README.md

@@ -1,11 +0,0 @@
-# The Public Code Folder
-
-This folder contains the public code files for your site. These files correspond to the ones found in the [**Public**](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar#public) section of the  **Public & Backend** ![image](https://user-images.githubusercontent.com/89579857/184873215-d6042ace-4d20-40f2-ad37-1b1911302f96.png) tab in the Velo sidebar. You can import code from these files into any other file on your site.
-
-Use the following syntax to import code from public files:
-```js
-import { myFunctionName } from 'public/myFileName';
-```   
-Trying to import from the relative path in your site's repo doesn't work.
-
-Learn more about [this repo's file structure](https://support.wix.com/en/article/velo-understanding-your-sites-github-repository-beta).

package/src/public/consts.js

@@ -1,3 +0,0 @@
-export const COLLECTIONS = {
-    TASKS: 'Tasks',
-  };