@nocobase/plugin-workflow-action-trigger 0.20.0-alpha.6

package/src/client/__e2e__/workflowCRUD.test.ts

@@ -0,0 +1,178 @@
+import { faker } from '@faker-js/faker';
+import {
+  CreateWorkFlow,
+  EditWorkFlow,
+  FormEventTriggerNode,
+  WorkflowListRecords,
+  apiCreateRecordTriggerFormEvent,
+  apiCreateWorkflow,
+  apiDeleteWorkflow,
+  apiGetWorkflow,
+  apiUpdateWorkflowTrigger,
+  appendJsonCollectionName,
+  generalWithNoRelationalFields,
+} from '@nocobase/plugin-workflow-test/e2e';
+import { expect, test } from '@nocobase/test/e2e';
+import { dayjs } from '@nocobase/utils';
+
+test.describe('Filter', () => {
+  test('filter workflow name', async ({ page }) => {
+    //添加工作流
+    const triggerNodeAppendText = faker.string.alphanumeric(5);
+    const workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+    const workflowData = {
+      current: true,
+      options: { deleteExecutionOnStatus: [] },
+      title: workFlowName,
+      type: 'action',
+      enabled: true,
+    };
+    const workflow = await apiCreateWorkflow(workflowData);
+    const workflowObj = JSON.parse(JSON.stringify(workflow));
+    const workflowId = workflowObj.id;
+
+    // 2、筛选工作流
+    await page.goto('/admin/settings/workflow');
+    await page.waitForLoadState('networkidle');
+    await page.getByLabel('action-Filter.Action-Filter-filter-workflows').click();
+    await page.getByRole('textbox').fill(workFlowName);
+    await page.getByRole('button', { name: 'Submit' }).click();
+
+    // 3、预期结果：列表中出现筛选的工作流
+    await expect(page.getByText(workFlowName)).toBeAttached();
+
+    // 4、后置处理：删除工作流
+    await apiDeleteWorkflow(workflowId);
+  });
+});
+
+test.describe('Add new', () => {
+  test('add new Action event', async ({ page }) => {
+    // 添加工作流
+    await page.goto('/admin/settings/workflow');
+    await page.waitForLoadState('networkidle');
+    await page.getByLabel('action-Action-Add new-workflows').click();
+    const createWorkFlow = new CreateWorkFlow(page);
+    const workFlowName = faker.string.alphanumeric(5);
+    await createWorkFlow.name.fill(workFlowName);
+    await createWorkFlow.triggerType.click();
+    await page.getByRole('option', { name: 'Action event' }).click();
+    await page.getByLabel('action-Action-Submit-workflows').click();
+
+    // 3、预期结果：列表中出现新建的工作流
+    await expect(page.getByText(workFlowName)).toBeVisible();
+
+    // 4、后置处理：删除工作流
+    await page.getByLabel('action-Filter.Action-Filter-filter-workflows').click();
+    await page.getByRole('textbox').fill(workFlowName);
+    await page.getByRole('button', { name: 'Submit' }).click();
+    await page.getByLabel(`action-Action.Link-Delete-workflows-${workFlowName}`).click();
+    await page.getByRole('button', { name: 'OK', exact: true }).click();
+    await expect(page.getByText(workFlowName)).toBeHidden();
+  });
+});
+
+test.describe('Sync', () => {});
+
+test.describe('Delete', () => {
+  test('delete Action event', async ({ page }) => {
+    //添加工作流
+    const triggerNodeAppendText = faker.string.alphanumeric(5);
+    const workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+    const workflowData = {
+      current: true,
+      options: { deleteExecutionOnStatus: [] },
+      title: workFlowName,
+      type: 'action',
+      enabled: true,
+    };
+    const workflow = await apiCreateWorkflow(workflowData);
+    const workflowObj = JSON.parse(JSON.stringify(workflow));
+    const workflowId = workflowObj.id;
+
+    // 删除工作流
+    await page.goto('/admin/settings/workflow');
+    await page.waitForLoadState('networkidle');
+    await page.getByLabel('action-Filter.Action-Filter-filter-workflows').click();
+    await page.getByRole('textbox').fill(workFlowName);
+    await page.getByRole('button', { name: 'Submit' }).click();
+    await page.getByLabel(`action-Action.Link-Delete-workflows-${workFlowName}`).click();
+    await page.getByRole('button', { name: 'OK', exact: true }).click();
+
+    // 3、预期结果：列表中出现筛选的工作流
+    await expect(page.getByText(workFlowName)).toBeHidden();
+
+    // 4、后置处理：删除工作流
+  });
+});
+
+test.describe('Edit', () => {
+  test('edit Action event name', async ({ page }) => {
+    //添加工作流
+    const triggerNodeAppendText = faker.string.alphanumeric(5);
+    let workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+    const workflowData = {
+      current: true,
+      options: { deleteExecutionOnStatus: [] },
+      title: workFlowName,
+      type: 'action',
+      enabled: true,
+    };
+    const workflow = await apiCreateWorkflow(workflowData);
+    const workflowObj = JSON.parse(JSON.stringify(workflow));
+    const workflowId = workflowObj.id;
+
+    // 编辑工作流
+    await page.goto('/admin/settings/workflow');
+    await page.waitForLoadState('networkidle');
+    await page.getByLabel(`action-Action.Link-Edit-workflows-${workFlowName}`).click();
+    const editWorkFlow = new EditWorkFlow(page, workFlowName);
+    workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+    await editWorkFlow.name.fill(workFlowName);
+    await page.getByLabel('action-Action-Submit-workflows').click();
+    await page.waitForLoadState('networkidle');
+    // 3、预期结果：编辑成功，列表中出现编辑后的工作流
+    await expect(page.getByText(workFlowName)).toBeAttached();
+
+    // 4、后置处理：删除工作流
+    await apiDeleteWorkflow(workflowId);
+  });
+});
+
+test.describe('Duplicate', () => {
+  test('Duplicate Action event triggers with only unconfigured trigger nodes', async ({ page }) => {
+    //添加工作流
+    const triggerNodeAppendText = faker.string.alphanumeric(5);
+    const workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+    const workflowData = {
+      current: true,
+      options: { deleteExecutionOnStatus: [] },
+      title: workFlowName,
+      type: 'action',
+      enabled: true,
+    };
+    const workflow = await apiCreateWorkflow(workflowData);
+    const workflowObj = JSON.parse(JSON.stringify(workflow));
+    const workflowId = workflowObj.id;
+
+    // 2、复制工作流
+    await page.goto('/admin/settings/workflow');
+    await page.waitForLoadState('networkidle');
+    await page.getByLabel(`action-Action.Link-Duplicate-workflows-${workFlowName}`).click();
+    await page.getByLabel(`action-Action-Submit-workflows-${workFlowName}`).click();
+    await page.waitForLoadState('networkidle');
+    // 3、预期结果：列表中出现筛选的工作流
+    await page.getByLabel('action-Filter.Action-Filter-filter-workflows').click();
+    await page.getByRole('textbox').fill(workFlowName);
+    await page.getByRole('button', { name: 'Submit', exact: true }).click();
+    await expect(page.getByText(`${workFlowName} copy`)).toBeAttached();
+
+    // 4、后置处理：删除工作流
+    await page.getByLabel(`action-Action.Link-Delete-workflows-${workFlowName}  copy`).click();
+    await page.getByRole('button', { name: 'OK', exact: true }).click();
+    await expect(page.getByText(`${workFlowName} copy`)).toBeHidden();
+    await apiDeleteWorkflow(workflowId);
+  });
+});
+
+test.describe('Executed', () => {});

package/src/client/index.ts

@@ -0,0 +1,100 @@
+import { Plugin, SchemaInitializerItemType } from '@nocobase/client';
+import WorkflowPlugin, {
+  useTriggerWorkflowsActionProps,
+  useRecordTriggerWorkflowsActionProps,
+} from '@nocobase/plugin-workflow/client';
+
+import ActionTrigger from './ActionTrigger';
+
+const submitToWorkflowActionInitializer: SchemaInitializerItemType = {
+  name: 'submitToWorkflow',
+  title: '{{t("Submit to workflow", { ns: "workflow" })}}',
+  Component: 'CustomizeActionInitializer',
+  schema: {
+    title: '{{t("Submit to workflow", { ns: "workflow" })}}',
+    'x-component': 'Action',
+    'x-component-props': {
+      useProps: '{{ useTriggerWorkflowsActionProps }}',
+    },
+    'x-designer': 'Action.Designer',
+    'x-action-settings': {
+      // assignedValues: {},
+      skipValidator: false,
+      onSuccess: {
+        manualClose: true,
+        redirecting: false,
+        successMessage: '{{t("Submitted successfully")}}',
+      },
+      triggerWorkflows: [],
+    },
+    'x-action': 'customize:triggerWorkflows',
+  },
+};
+
+const recordTriggerWorkflowActionInitializer: SchemaInitializerItemType = {
+  name: 'submitToWorkflow',
+  title: '{{t("Submit to workflow", { ns: "workflow" })}}',
+  Component: 'CustomizeActionInitializer',
+  schema: {
+    title: '{{t("Submit to workflow", { ns: "workflow" })}}',
+    'x-component': 'Action',
+    'x-component-props': {
+      useProps: '{{ useRecordTriggerWorkflowsActionProps }}',
+    },
+    'x-designer': 'Action.Designer',
+    'x-action-settings': {
+      // assignedValues: {},
+      onSuccess: {
+        manualClose: true,
+        redirecting: false,
+        successMessage: '{{t("Submitted successfully")}}',
+      },
+      triggerWorkflows: [],
+    },
+    'x-action': 'customize:triggerWorkflows',
+  },
+};
+
+const recordTriggerWorkflowActionLinkInitializer = {
+  ...recordTriggerWorkflowActionInitializer,
+  schema: {
+    ...recordTriggerWorkflowActionInitializer.schema,
+    'x-component': 'Action.Link',
+  },
+};
+
+export default class extends Plugin {
+  async load() {
+    const workflow = this.app.pm.get('workflow') as WorkflowPlugin;
+    workflow.registerTrigger('action', ActionTrigger);
+
+    this.app.addScopes({
+      useTriggerWorkflowsActionProps,
+      useRecordTriggerWorkflowsActionProps,
+    });
+
+    const FormActionInitializers = this.app.schemaInitializerManager.get('FormActionInitializers');
+    FormActionInitializers.add('customize.submitToWorkflow', submitToWorkflowActionInitializer);
+
+    const CreateFormActionInitializers = this.app.schemaInitializerManager.get('CreateFormActionInitializers');
+    CreateFormActionInitializers.add('customize.submitToWorkflow', submitToWorkflowActionInitializer);
+
+    const UpdateFormActionInitializers = this.app.schemaInitializerManager.get('UpdateFormActionInitializers');
+    UpdateFormActionInitializers.add('customize.submitToWorkflow', submitToWorkflowActionInitializer);
+
+    const DetailsActionInitializers = this.app.schemaInitializerManager.get('DetailsActionInitializers');
+    DetailsActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionInitializer);
+
+    const ReadPrettyFormActionInitializers = this.app.schemaInitializerManager.get('ReadPrettyFormActionInitializers');
+    ReadPrettyFormActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionInitializer);
+
+    const TableActionColumnInitializers = this.app.schemaInitializerManager.get('TableActionColumnInitializers');
+    TableActionColumnInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
+
+    const GridCardItemActionInitializers = this.app.schemaInitializerManager.get('GridCardItemActionInitializers');
+    GridCardItemActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
+
+    const ListItemActionInitializers = this.app.schemaInitializerManager.get('ListItemActionInitializers');
+    ListItemActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './server';
+export { default } from './server';

package/src/locale/en-US.json

@@ -0,0 +1,9 @@
+{
+  "Form event": "Form event",
+  "Event triggers when submitted a workflow bound form action.": "Event triggers when submitted a workflow bound form action.",
+  "Form data model": "Form data model",
+  "Use a collection to match form data.": "Use a collection to match form data.",
+  "Associations to use": "Associations to use",
+  "User submitted form": "User submitted form",
+  "Role of user submitted form": "Role of user submitted form"
+}

package/src/locale/index.ts

@@ -0,0 +1,12 @@
+import { useTranslation } from 'react-i18next';
+
+export const NAMESPACE = 'workflow-action-trigger';
+
+export function useLang(key: string, options = {}) {
+  const { t } = usePluginTranslation(options);
+  return t(key);
+}
+
+export function usePluginTranslation(options) {
+  return useTranslation(NAMESPACE, options);
+}

package/src/locale/ko_KR.json

@@ -0,0 +1,9 @@
+{
+  "Form event": "폼 이벤트",
+  "Event triggers when submitted a workflow bound form action.": "작업 흐름에 바인딩된 폼 작업이 제출될 때 이벤트가 트리거됩니다.",
+  "Form data model": "폼 데이터 모델",
+  "Use a collection to match form data.": "폼 데이터를 일치시키기 위해 데이터 테이블을 사용합니다.",
+  "Associations to use": "사용할 관련 데이터",
+  "User submitted form": "사용자가 제출한 폼",
+  "Role of user submitted form": "사용자 제출 폼의 역할"  
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,10 @@
+{
+  "Action event": "操作事件",
+  "Triggers after specific operations on data are submitted, such as create, update, delete, etc., or directly submitting a record to the workflow.": "在对数据的特定操作提交后触发，如创建、更新、删除等，或直接提交一条数据至工作流。",
+  "Collection": "数据表",
+  "Which collection record belongs to.": "数据所属的数据表。",
+  "Associations to use": "待使用的关系数据",
+  "Trigger data": "触发器数据",
+  "User submitted action": "提交操作的用户",
+  "Role of user submitted action": "提交操作用户的角色"
+}

package/src/server/ActionTrigger.ts

@@ -0,0 +1,132 @@
+import { get } from 'lodash';
+import { BelongsTo, HasOne } from 'sequelize';
+import { Model, modelAssociationByKey } from '@nocobase/database';
+
+import WorkflowPlugin, { Trigger, WorkflowModel, toJSON } from '@nocobase/plugin-workflow';
+
+export default class extends Trigger {
+  constructor(workflow: WorkflowPlugin) {
+    super(workflow);
+
+    workflow.app.resourcer.use(this.middleware);
+  }
+
+  async triggerAction(context, next) {
+    const { triggerWorkflows } = context.action.params;
+
+    if (!triggerWorkflows) {
+      return context.throw(400);
+    }
+
+    context.status = 202;
+    await next();
+
+    this.trigger(context);
+  }
+
+  middleware = async (context, next) => {
+    const {
+      resourceName,
+      actionName,
+      params: { triggerWorkflows },
+    } = context.action;
+
+    if (resourceName === 'workflows' && actionName === 'trigger') {
+      return this.triggerAction(context, next);
+    }
+
+    await next();
+
+    if (!triggerWorkflows) {
+      return;
+    }
+
+    if (!['create', 'update'].includes(actionName)) {
+      return;
+    }
+
+    return this.trigger(context);
+  };
+
+  private async trigger(context) {
+    const { triggerWorkflows = '', values } = context.action.params;
+
+    const { currentUser, currentRole } = context.state;
+    const userInfo = {
+      user: toJSON(currentUser),
+      roleName: currentRole,
+    };
+
+    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 syncGroup = [];
+    const asyncGroup = [];
+    for (const workflow of workflows) {
+      const trigger = triggers.find((trigger) => trigger[0] == workflow.key);
+      const event = [workflow];
+      if (context.action.resourceName !== 'workflows') {
+        if (!context.body) {
+          continue;
+        }
+        const { body: data } = context;
+        for (const row of Array.isArray(data) ? data : [data]) {
+          let payload = row;
+          if (trigger[1]) {
+            const paths = trigger[1].split('.');
+            for (const field of paths) {
+              if (payload.get(field)) {
+                payload = payload.get(field);
+              } else {
+                const association = <HasOne | BelongsTo>modelAssociationByKey(payload, field);
+                payload = await payload[association.accessors.get]();
+              }
+            }
+          }
+          const { collection, appends = [] } = workflow.config;
+          const model = payload.constructor;
+          if (payload instanceof Model) {
+            if (collection !== model.collection.name) {
+              continue;
+            }
+            if (appends.length) {
+              payload = await model.collection.repository.findOne({
+                filterByTk: payload.get(model.primaryKeyAttribute),
+                appends,
+              });
+            }
+          }
+          // this.workflow.trigger(workflow, { data: toJSON(payload), ...userInfo });
+          event.push({ data: toJSON(payload), ...userInfo });
+        }
+      } else {
+        const data = trigger[1] ? get(values, trigger[1]) : values;
+        // this.workflow.trigger(workflow, {
+        //   data,
+        //   ...userInfo,
+        // });
+        event.push({ data, ...userInfo });
+      }
+      (workflow.sync ? syncGroup : asyncGroup).push(event);
+    }
+
+    for (const event of syncGroup) {
+      await this.workflow.trigger(event[0], event[1], { httpContext: context });
+    }
+
+    for (const event of asyncGroup) {
+      this.workflow.trigger(event[0], event[1]);
+    }
+  }
+
+  on(workflow: WorkflowModel) {}
+
+  off(workflow: WorkflowModel) {}
+}

package/src/server/Plugin.ts

@@ -0,0 +1,11 @@
+import { Plugin } from '@nocobase/server';
+import WorkflowPlugin from '@nocobase/plugin-workflow';
+
+import ActionTrigger from './ActionTrigger';
+
+export default class extends Plugin {
+  async load() {
+    const workflowPlugin = this.app.pm.get(WorkflowPlugin) as WorkflowPlugin;
+    workflowPlugin.triggers.register('action', new ActionTrigger(workflowPlugin));
+  }
+}