@nocobase/plugin-workflow-action-trigger 0.20.0-alpha.7 → 0.20.0-alpha.8

package/dist/externalVersion.js

@@ -1,13 +1,15 @@
 module.exports = {
   "@formily/react": "2.3.0",
-  "@nocobase/client": "0.20.0-alpha.7",
-  "@nocobase/plugin-workflow": "0.20.0-alpha.7",
+  "@nocobase/client": "0.20.0-alpha.8",
+  "@nocobase/plugin-workflow": "0.20.0-alpha.8",
   "react-i18next": "11.18.6",
   "lodash": "4.17.21",
   "sequelize": "6.35.2",
-  "@nocobase/database": "0.20.0-alpha.7",
-  "@nocobase/server": "0.20.0-alpha.7",
-  "@nocobase/plugin-workflow-test": "0.20.0-alpha.7",
-  "@nocobase/test": "0.20.0-alpha.7",
-  "@nocobase/utils": "0.20.0-alpha.7"
+  "@nocobase/database": "0.20.0-alpha.8",
+  "@nocobase/server": "0.20.0-alpha.8",
+  "@nocobase/resourcer": "0.20.0-alpha.8",
+  "@nocobase/actions": "0.20.0-alpha.8",
+  "@nocobase/plugin-workflow-test": "0.20.0-alpha.8",
+  "@nocobase/test": "0.20.0-alpha.8",
+  "@nocobase/utils": "0.20.0-alpha.8"
 };

package/dist/server/ActionTrigger.d.ts

@@ -1,9 +1,15 @@
+import { DefaultContext } from '@nocobase/server';
+import { ActionContext } from '@nocobase/resourcer';
+import { Next } from '@nocobase/actions';
 import WorkflowPlugin, { Trigger, WorkflowModel } from '@nocobase/plugin-workflow';
+interface Context extends ActionContext, DefaultContext {
+}
 export default class extends Trigger {
     constructor(workflow: WorkflowPlugin);
-    triggerAction(context: any, next: any): Promise<any>;
-    middleware: (context: any, next: any) => Promise<any>;
+    triggerAction(context: Context, next: Next): Promise<any>;
+    middleware: (context: Context, next: Next) => Promise<any>;
     private trigger;
     on(workflow: WorkflowModel): void;
     off(workflow: WorkflowModel): void;
 }
+export {};

package/dist/server/ActionTrigger.js

@@ -64,17 +64,18 @@ class ActionTrigger_default extends import_plugin_workflow.Trigger {
     };
     const triggers = triggerWorkflows.split(",").map((trigger) => trigger.split("!"));
     const workflowRepo = this.workflow.db.getRepository("workflows");
-    const workflows = await workflowRepo.find({
+    const workflows = (await workflowRepo.find({
       filter: {
         key: triggers.map((trigger) => trigger[0]),
         current: true,
         type: "action",
         enabled: true
       }
-    });
+    })).filter((workflow) => Boolean(workflow.config.collection));
     const syncGroup = [];
     const asyncGroup = [];
     for (const workflow of workflows) {
+      const { collection, appends = [] } = workflow.config;
       const trigger = triggers.find((trigger2) => trigger2[0] == workflow.key);
       const event = [workflow];
       if (context.action.resourceName !== "workflows") {
@@ -95,7 +96,6 @@ class ActionTrigger_default extends import_plugin_workflow.Trigger {
               }
             }
           }
-          const { collection, appends = [] } = workflow.config;
           const model = payload.constructor;
           if (payload instanceof import_database.Model) {
             if (collection !== model.collection.name) {
@@ -111,7 +111,15 @@ class ActionTrigger_default extends import_plugin_workflow.Trigger {
           event.push({ data: (0, import_plugin_workflow.toJSON)(payload), ...userInfo });
         }
       } else {
-        const data = trigger[1] ? (0, import_lodash.get)(values, trigger[1]) : values;
+        const { model, repository } = context.db.getCollection(collection);
+        let data = trigger[1] ? (0, import_lodash.get)(values, trigger[1]) : values;
+        const pk = (0, import_lodash.get)(data, model.primaryKeyAttribute);
+        if (appends.length && pk != null) {
+          data = await repository.findOne({
+            filterByTk: pk,
+            appends
+          });
+        }
         event.push({ data, ...userInfo });
       }
       (workflow.sync ? syncGroup : asyncGroup).push(event);

package/dist/server/migrations/{20240227172623-change-name.js → 20240307215012-change-name.js}

@@ -22,7 +22,7 @@ __export(change_name_exports, {
 module.exports = __toCommonJS(change_name_exports);
 var import_server = require("@nocobase/server");
 class change_name_default extends import_server.Migration {
-  appVersion = "<0.20.0-alpha.6";
+  appVersion = "<0.20.0-alpha.7";
   on = "afterSync";
   async up() {
     const { db } = this.context;

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "工作流：数据操作触发器",
   "description": "Bind action buttons to trigger workflow events when clicked.",
   "description.zh-CN": "可对数据操作按钮绑定，在点击后触发对应的工作流事件。",
-  "version": "0.20.0-alpha.7",
+  "version": "0.20.0-alpha.8",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/plugins/workflow-action-trigger",
@@ -21,7 +21,7 @@
     "@nocobase/server": "0.x",
     "@nocobase/test": "0.x"
   },
-  "gitHead": "78900f33a0112255c408799d8bbf0c9b513147cd",
+  "gitHead": "39ebc1cefe5a826aecf0b14d73530dfa5f9c2b1c",
   "keywords": [
     "Workflow"
   ]

package/src/server/ActionTrigger.ts

@@ -1,9 +1,14 @@
 import { get } from 'lodash';
 import { BelongsTo, HasOne } from 'sequelize';
 import { Model, modelAssociationByKey } from '@nocobase/database';
+import { DefaultContext } from '@nocobase/server';
+import { ActionContext } from '@nocobase/resourcer';
+import { Next } from '@nocobase/actions';
 
 import WorkflowPlugin, { Trigger, WorkflowModel, toJSON } from '@nocobase/plugin-workflow';
 
+interface Context extends ActionContext, DefaultContext {}
+
 export default class extends Trigger {
   constructor(workflow: WorkflowPlugin) {
     super(workflow);
@@ -11,7 +16,7 @@ export default class extends Trigger {
     workflow.app.resourcer.use(this.middleware);
   }
 
-  async triggerAction(context, next) {
+  async triggerAction(context: Context, next: Next) {
     const { triggerWorkflows } = context.action.params;
 
     if (!triggerWorkflows) {
@@ -24,7 +29,7 @@ export default class extends Trigger {
     this.trigger(context);
   }
 
-  middleware = async (context, next) => {
+  middleware = async (context: Context, next: Next) => {
     const {
       resourceName,
       actionName,
@@ -48,7 +53,7 @@ export default class extends Trigger {
     return this.trigger(context);
   };
 
-  private async trigger(context) {
+  private async trigger(context: Context) {
     const { triggerWorkflows = '', values } = context.action.params;
 
     const { currentUser, currentRole } = context.state;
@@ -59,17 +64,20 @@ export default class extends Trigger {
 
     const triggers = triggerWorkflows.split(',').map((trigger) => trigger.split('!'));
     const workflowRepo = this.workflow.db.getRepository('workflows');
-    const workflows = await workflowRepo.find({
-      filter: {
-        key: triggers.map((trigger) => trigger[0]),
-        current: true,
-        type: 'action',
-        enabled: true,
-      },
-    });
+    const workflows = (
+      await workflowRepo.find({
+        filter: {
+          key: triggers.map((trigger) => trigger[0]),
+          current: true,
+          type: 'action',
+          enabled: true,
+        },
+      })
+    ).filter((workflow) => Boolean(workflow.config.collection));
     const syncGroup = [];
     const asyncGroup = [];
     for (const workflow of workflows) {
+      const { collection, appends = [] } = workflow.config;
       const trigger = triggers.find((trigger) => trigger[0] == workflow.key);
       const event = [workflow];
       if (context.action.resourceName !== 'workflows') {
@@ -90,7 +98,6 @@ export default class extends Trigger {
               }
             }
           }
-          const { collection, appends = [] } = workflow.config;
           const model = payload.constructor;
           if (payload instanceof Model) {
             if (collection !== model.collection.name) {
@@ -107,7 +114,15 @@ export default class extends Trigger {
           event.push({ data: toJSON(payload), ...userInfo });
         }
       } else {
-        const data = trigger[1] ? get(values, trigger[1]) : values;
+        const { model, repository } = context.db.getCollection(collection);
+        let data = trigger[1] ? get(values, trigger[1]) : values;
+        const pk = get(data, model.primaryKeyAttribute);
+        if (appends.length && pk != null) {
+          data = await repository.findOne({
+            filterByTk: pk,
+            appends,
+          });
+        }
         // this.workflow.trigger(workflow, {
         //   data,
         //   ...userInfo,

package/src/server/__tests__/trigger.test.ts

@@ -214,6 +214,7 @@ describe('workflow > action-trigger', () => {
         type: 'action',
         config: {
           collection: 'posts',
+          appends: ['createdBy'],
         },
       });
 
@@ -238,6 +239,7 @@ describe('workflow > action-trigger', () => {
       const [e2] = await workflow.getExecutions();
       expect(e2.status).toBe(EXECUTION_STATUS.RESOLVED);
       expect(e2.context.data).toHaveProperty('title', 't2');
+      expect(e2.context.data).toHaveProperty('createdBy');
     });
   });
 
@@ -281,10 +283,32 @@ describe('workflow > action-trigger', () => {
   });
 
   describe('directly trigger', () => {
-    it('trigger data', async () => {
+    it('no collection configured should not be triggered', async () => {
+      const workflow = await WorkflowModel.create({
+        enabled: true,
+        type: 'action',
+      });
+
+      const res1 = await userAgents[0].resource('workflows').trigger({
+        values: { title: 't1' },
+        triggerWorkflows: `${workflow.key}`,
+      });
+      expect(res1.status).toBe(202);
+
+      await sleep(500);
+
+      const e1s = await workflow.getExecutions();
+      expect(e1s.length).toBe(0);
+    });
+
+    it('trigger on form data', async () => {
       const workflow = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+          appends: ['createdBy'],
+        },
       });
 
       const res1 = await userAgents[0].resource('workflows').trigger({
@@ -298,17 +322,53 @@ describe('workflow > action-trigger', () => {
       const [e1] = await workflow.getExecutions();
       expect(e1.status).toBe(EXECUTION_STATUS.RESOLVED);
       expect(e1.context.data).toMatchObject({ title: 't1' });
+      expect(e1.context.data.createdBy).toBeUndefined();
+    });
+
+    it('trigger on record data', async () => {
+      const workflow = await WorkflowModel.create({
+        enabled: true,
+        type: 'action',
+        config: {
+          collection: 'posts',
+          appends: ['createdBy'],
+        },
+      });
+
+      const post = await PostRepo.create({
+        values: { title: 't1', createdBy: users[0].id },
+      });
+
+      const res1 = await userAgents[0].resource('workflows').trigger({
+        values: post.toJSON(),
+        triggerWorkflows: `${workflow.key}`,
+      });
+      expect(res1.status).toBe(202);
+
+      await sleep(500);
+
+      const [e1] = await workflow.getExecutions();
+      expect(e1.status).toBe(EXECUTION_STATUS.RESOLVED);
+      expect(e1.context.data).toMatchObject({ title: 't1' });
+      expect(e1.context.data).toHaveProperty('createdBy');
+      expect(e1.context.data.createdBy.id).toBe(users[0].id);
     });
 
     it('multi trigger', async () => {
       const w1 = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+        },
       });
 
       const w2 = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+        },
       });
 
       const res1 = await userAgents[0].resource('workflows').trigger({
@@ -358,6 +418,9 @@ describe('workflow > action-trigger', () => {
       const workflow = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+        },
       });
 
       const res1 = await userAgents[0].resource('workflows').trigger({
@@ -377,6 +440,9 @@ describe('workflow > action-trigger', () => {
       const workflow = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+        },
       });
 
       const res1 = await userAgents[0].resource('workflows').trigger({
@@ -398,6 +464,9 @@ describe('workflow > action-trigger', () => {
       const w1 = await WorkflowModel.create({
         enabled: true,
         type: 'action',
+        config: {
+          collection: 'posts',
+        },
       });
 
       const res1 = await userAgents[0].resource('workflows').trigger({

package/src/server/migrations/{20240227172623-change-name.ts → 20240307215012-change-name.ts}

@@ -1,7 +1,7 @@
 import { Migration } from '@nocobase/server';
 
 export default class extends Migration {
-  appVersion = '<0.20.0-alpha.6';
+  appVersion = '<0.20.0-alpha.7';
   on = 'afterSync';
   async up() {
     const { db } = this.context;