@nocobase/plugin-workflow-action-trigger 1.0.0-alpha.2 → 1.0.0-alpha.3

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

@@ -1,178 +0,0 @@
-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.getByTitle('Post-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

@@ -1,96 +0,0 @@
-import { Plugin, SchemaInitializerItemType } from '@nocobase/client';
-import WorkflowPlugin, {
-  useRecordTriggerWorkflowsActionProps,
-  useTriggerWorkflowsActionProps,
-} 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-use-component-props': '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-use-component-props': '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('createForm:configureActions');
-    CreateFormActionInitializers.add('customize.submitToWorkflow', submitToWorkflowActionInitializer);
-
-    const UpdateFormActionInitializers = this.app.schemaInitializerManager.get('editForm:configureActions');
-    UpdateFormActionInitializers.add('customize.submitToWorkflow', submitToWorkflowActionInitializer);
-
-    const DetailsActionInitializers = this.app.schemaInitializerManager.get('detailsWithPaging:configureActions');
-    DetailsActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionInitializer);
-
-    const ReadPrettyFormActionInitializers = this.app.schemaInitializerManager.get('details:configureActions');
-    ReadPrettyFormActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionInitializer);
-
-    const TableActionColumnInitializers = this.app.schemaInitializerManager.get('table:configureItemActions');
-    TableActionColumnInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
-
-    const GridCardItemActionInitializers = this.app.schemaInitializerManager.get('gridCard:configureItemActions');
-    GridCardItemActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
-
-    const ListItemActionInitializers = this.app.schemaInitializerManager.get('list:configureItemActions');
-    ListItemActionInitializers.add('customize.submitToWorkflow', recordTriggerWorkflowActionLinkInitializer);
-  }
-}

package/src/index.ts

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

package/src/locale/en-US.json

@@ -1,9 +0,0 @@
-{
-  "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

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

@@ -1,9 +0,0 @@
-{
-  "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

@@ -1,18 +0,0 @@
-{
-  "Post-action event": "操作后事件",
-  "Triggered after the completion of a request initiated through an action button or API, such as after adding, updating, deleting data, or \"submit to workflow\". Suitable for data processing, sending notifications, etc., after actions are completed.":
-    "通过操作按钮或 API 发起请求并在执行完成后触发，比如新增、更新、删除数据或者“提交至工作流”之后。适用于在操作完成后进行数据处理、发送通知等。",
-  "Collection": "数据表",
-  "The collection to which the triggered data belongs.": "触发数据所属的数据表。",
-  "Trigger mode": "触发模式",
-  "Local mode, triggered after the completion of actions bound to this workflow": "局部模式，绑定该工作流的操作执行完成后触发",
-  "Global mode, triggered after the completion of the following actions": "全局模式，以下操作执行完成后都触发",
-  "Action to submit to workflow directly is only supported on bound buttons, and will not be affected under global mode.": "直接提交至工作流的操作仅支持使用按钮绑定，不受全局模式的影响。",
-  "Select actions": "选择操作",
-  "Create record action": "创建记录操作",
-  "Update record action": "更新记录操作",
-  "Associations to use": "待使用的关系数据",
-  "Trigger data": "触发器数据",
-  "User submitted action": "提交操作的用户",
-  "Role of user submitted action": "提交操作用户的角色"
-}

package/src/server/ActionTrigger.ts

@@ -1,177 +0,0 @@
-import { get } from 'lodash';
-import { BelongsTo, HasOne } from 'sequelize';
-import { Model, modelAssociationByKey } from '@nocobase/database';
-import Application, { DefaultContext } from '@nocobase/server';
-import { Context as ActionContext, Next } from '@nocobase/actions';
-
-import WorkflowPlugin, { Trigger, WorkflowModel, toJSON } from '@nocobase/plugin-workflow';
-import { joinCollectionName, parseCollectionName } from '@nocobase/data-source-manager';
-
-interface Context extends ActionContext, DefaultContext {}
-
-export default class extends Trigger {
-  static TYPE = 'action';
-
-  constructor(workflow: WorkflowPlugin) {
-    super(workflow);
-
-    workflow.app.use(this.middleware, { after: 'dataSource' });
-  }
-
-  async workflowTriggerAction(context: Context, next: Next) {
-    const { triggerWorkflows } = context.action.params;
-
-    if (!triggerWorkflows) {
-      return context.throw(400);
-    }
-
-    context.status = 202;
-    await next();
-
-    return this.collectionTriggerAction(context);
-  }
-
-  middleware = async (context: Context, next: Next) => {
-    const { resourceName, actionName } = context.action;
-
-    if (resourceName === 'workflows' && actionName === 'trigger') {
-      return this.workflowTriggerAction(context, next);
-    }
-
-    await next();
-
-    if (!['create', 'update'].includes(actionName)) {
-      return;
-    }
-
-    return this.collectionTriggerAction(context);
-  };
-
-  private async collectionTriggerAction(context: Context) {
-    const {
-      resourceName,
-      actionName,
-      params: { triggerWorkflows = '', values },
-    } = context.action;
-    const dataSourceHeader = context.get('x-data-source') || 'main';
-    const collection = context.app.dataSourceManager.dataSources
-      .get(dataSourceHeader)
-      .collectionManager.getCollection(resourceName);
-
-    if (!collection) {
-      return;
-    }
-
-    const fullCollectionName = joinCollectionName(dataSourceHeader, collection.name);
-    const { currentUser, currentRole } = context.state;
-    const { model: UserModel } = this.workflow.db.getCollection('users');
-    const userInfo = {
-      user: UserModel.build(currentUser).desensitize(),
-      roleName: currentRole,
-    };
-
-    const triggers = triggerWorkflows.split(',').map((trigger) => trigger.split('!'));
-    const triggersKeysMap = new Map<string, string>(triggers);
-    const workflows = Array.from(this.workflow.enabledCache.values()).filter(
-      (item) => item.type === 'action' && item.config.collection,
-    );
-    const globalWorkflows = new Map();
-    const localWorkflows = new Map();
-    workflows.forEach((item) => {
-      if (resourceName === 'workflows' && actionName === 'trigger') {
-        localWorkflows.set(item.key, item);
-      } else if (item.config.collection === fullCollectionName) {
-        if (item.config.global) {
-          if (item.config.actions?.includes(actionName)) {
-            globalWorkflows.set(item.key, item);
-          }
-        } else {
-          localWorkflows.set(item.key, item);
-        }
-      }
-    });
-    const triggeringLocalWorkflows = [];
-    const uniqueTriggersMap = new Map();
-    triggers.forEach((trigger) => {
-      const [key] = trigger;
-      const workflow = localWorkflows.get(key);
-      if (workflow && !uniqueTriggersMap.has(key)) {
-        triggeringLocalWorkflows.push(workflow);
-        uniqueTriggersMap.set(key, true);
-      }
-    });
-    const syncGroup = [];
-    const asyncGroup = [];
-    for (const workflow of triggeringLocalWorkflows.concat(...globalWorkflows.values())) {
-      const { appends = [] } = workflow.config;
-      const [dataSourceName, collectionName] = parseCollectionName(workflow.config.collection);
-      const dataPath = triggersKeysMap.get(workflow.key);
-      const event = [workflow];
-      if (context.action.resourceName !== 'workflows') {
-        if (!context.body) {
-          continue;
-        }
-        if (dataSourceName !== dataSourceHeader) {
-          continue;
-        }
-        const { body: data } = context;
-        for (const row of Array.isArray(data) ? data : [data]) {
-          let payload = row;
-          if (dataPath) {
-            const paths = dataPath.split('.');
-            for (const field of paths) {
-              if (!payload) {
-                break;
-              }
-              if (payload.get(field)) {
-                payload = payload.get(field);
-              } else {
-                const association = <HasOne | BelongsTo>modelAssociationByKey(payload, field);
-                payload = await payload[association.accessors.get]();
-              }
-            }
-          }
-          if (payload instanceof Model) {
-            const model = payload.constructor as unknown as Model;
-            if (collectionName !== model.collection.name) {
-              continue;
-            }
-            if (appends.length) {
-              payload = await model.collection.repository.findOne({
-                filterByTk: payload.get(model.collection.filterTargetKey),
-                appends,
-              });
-            }
-          }
-          event.push({ data: toJSON(payload), ...userInfo });
-        }
-      } else {
-        const { filterTargetKey, repository } = (<Application>context.app).dataSourceManager.dataSources
-          .get(dataSourceName)
-          .collectionManager.getCollection(collectionName);
-        let data = dataPath ? get(values, dataPath) : values;
-        const pk = get(data, filterTargetKey);
-        if (appends.length && pk != null) {
-          data = await repository.findOne({
-            filterByTk: pk,
-            appends,
-          });
-        }
-        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

@@ -1,11 +0,0 @@
-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));
-  }
-}