psdev-task-manager 1.1.0 → 1.1.2

package/.eslintrc.json

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

package/backend/tasks/taskManager.js

@@ -83,14 +83,14 @@ function taskManager() {
    * */
   const processTasksBasedOnVeloLimit = async (scheduledTasks, tasksConfig) => {
     console.log(
-      `processTasksBasedOnVeloLimit: ${JSON.stringify(scheduledTasks)} ${JSON.stringify(tasksConfig)}`
+      `processTasksBasedOnVeloLimit: scheduledTasks count: ${scheduledTasks.length} tasksConfig: ${JSON.stringify(tasksConfig)}`
     );
     const toProcessTasks = getTasksToProcess({
       scheduledTasks,
       tasksConfig,
       maxDuration: CRON_JOB_MAX_DURATION_SEC,
     });
-    console.log(`processTasksBasedOnVeloLimit: toProcessTasks: ${JSON.stringify(toProcessTasks)}`);
+    console.log(`processTasksBasedOnVeloLimit: toProcessTasks count: ${toProcessTasks.length}`);
     console.log(
       `[processTasksBasedOnVeloLimit] started processing: ${toProcessTasks.length} tasks`
     );
@@ -113,7 +113,7 @@ function taskManager() {
   const runScheduledTasks = async tasksConfig => {
     try {
       const scheduledTasks = await getScheduledTasks();
-      console.log(`runScheduledTasks: scheduledTasks: ${JSON.stringify(scheduledTasks)}`);
+      console.log(`runScheduledTasks: scheduledTasks count: ${scheduledTasks.length}`);
       console.log(`runScheduledTasks: tasksConfig: ${JSON.stringify(tasksConfig)}`);
       if (scheduledTasks.length) {
         await processTasksBasedOnVeloLimit(scheduledTasks, tasksConfig);

package/backend/tasks/utils.js

@@ -169,7 +169,7 @@ const isParentTask = (task, taskConfig) => {
 };
 const filterScheduledTasksByStatus = (tasks, tasksConfig) => {
   console.log(
-    `filterScheduledTasksByStatus: ${JSON.stringify(tasks)} ${JSON.stringify(tasksConfig)}`
+    `filterScheduledTasksByStatus: tasks count: ${tasks.length} tasksConfig: ${JSON.stringify(tasksConfig)}`
   );
   const filtered = tasks.filter(task => {
     if (task.status === TASK_STATUS.IN_PROGRESS) {
@@ -180,7 +180,7 @@ const filterScheduledTasksByStatus = (tasks, tasksConfig) => {
     }
     return [TASK_STATUS.PENDING, TASK_STATUS.FAILED].includes(task.status);
   });
-  console.log(`filterScheduledTasksByStatus: filtered: ${JSON.stringify(filtered)}`);
+  console.log(`filterScheduledTasksByStatus: filtered count: ${filtered.length}`);
   return filtered;
 };
 const getScheduledTasks = async () => {
@@ -221,12 +221,12 @@ const getTaskScheduledChildren = async parentTaskId => {
 };
 
 const getTasksToProcess = ({ scheduledTasks, tasksConfig, maxDuration }) => {
-  console.log('getTasksToProcess:', { scheduledTasks, tasksConfig, maxDuration });
+  console.log('getTasksToProcess:', { scheduledTasksCount: scheduledTasks.length, tasksConfig, maxDuration });
   const tasksToProcess = [];
   let totalDuration = 0;
   console.log(`tasksConfig is : ${JSON.stringify(tasksConfig)}`);
   const filteredScheduledTasks = filterScheduledTasksByStatus(scheduledTasks, tasksConfig);
-  console.log(`filteredScheduledTasks is  : ${JSON.stringify(filteredScheduledTasks)}`);
+  console.log(`filteredScheduledTasks count  : ${filteredScheduledTasks.length}`);
   for (const task of filteredScheduledTasks) {
     console.log(`task is : ${JSON.stringify(task)}`);
     const taskConfig = getTaskConfig(task.name, tasksConfig);
@@ -243,7 +243,7 @@ const getTasksToProcess = ({ scheduledTasks, tasksConfig, maxDuration }) => {
     totalDuration += buffered;
     tasksToProcess.push(task);
   }
-  console.log('getTasksToProcess: tasksToProcess:', tasksToProcess);
+  console.log('getTasksToProcess: tasksToProcess count:', tasksToProcess.length);
   return tasksToProcess;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "psdev-task-manager",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Task manager library",
   "keywords": [
     "task-manager"

package/src/backend/README.md

@@ -0,0 +1,115 @@
+# 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

@@ -0,0 +1,40 @@
+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

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

package/src/backend/rootMethods.js

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

package/src/pages/Home.c1dmp.js

@@ -0,0 +1,10 @@
+// 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,10 @@
+// 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

@@ -0,0 +1,11 @@
+# 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

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

package/.github/workflows/update-sites.yml

@@ -1,19 +0,0 @@
-name: Update Sites After Release Main
-
-on:
-  workflow_dispatch:
-        
-permissions:
-  contents: write
-  packages: write
-
-jobs:
-  update-sites:
-    uses: psdevteamenterprise/ci-workflows/.github/workflows/publish-and-notify.yml@main
-
-    secrets:
-      MY_GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN_PUBLISH }}
-      GH_APP_ID: ${{ secrets.GH_APP_ID }}
-      GH_APP_PRIVATE_KEY: ${{ secrets.GH_APP_PRIVATE_KEY }}
-      WIX_CLI_API_KEY: ${{ secrets.PS_WIX_ACCOUNT_TOKEN }}