@nocobase/plugin-workflow-manual 0.19.0-alpha.3 → 0.19.0-alpha.5

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

@@ -0,0 +1,233 @@
+import { faker } from '@faker-js/faker';
+import {
+  CollectionTriggerNode,
+  apiCreateWorkflow,
+  apiDeleteWorkflow,
+  apiGetWorkflow,
+  apiUpdateWorkflowTrigger,
+  appendJsonCollectionName,
+  generalWithNoRelationalFields,
+  ManualNode,
+} from '@nocobase/plugin-workflow-test/e2e';
+import { expect, test } from '@nocobase/test/e2e';
+import { dayjs } from '@nocobase/utils';
+
+test('filter task node', async ({ page, mockPage, mockCollections, mockRecords }) => {
+  //数据表后缀标识
+  const triggerNodeAppendText = 'a' + faker.string.alphanumeric(4);
+  const manualNodeAppendText = 'b' + dayjs().format('HHmmss').toString();
+
+  // 创建触发器节点数据表
+  const triggerNodeCollectionDisplayName = `自动>组织[普通表]${triggerNodeAppendText}`;
+  const triggerNodeCollectionName = `tt_amt_org${triggerNodeAppendText}`;
+  const triggerNodeFieldName = 'orgname';
+  const triggerNodeFieldDisplayName = '公司名称(单行文本)';
+  await mockCollections(
+    appendJsonCollectionName(JSON.parse(JSON.stringify(generalWithNoRelationalFields)), triggerNodeAppendText)
+      .collections,
+  );
+  // 创建Manual节点数据表
+  const manualNodeCollectionDisplayName = `自动>组织[普通表]${manualNodeAppendText}`;
+  const manualNodeCollectionName = `tt_amt_org${manualNodeAppendText}`;
+  const manualNodeFieldName = 'orgname';
+  const manualNodeFieldDisplayName = '公司名称(单行文本)';
+  await mockCollections(
+    appendJsonCollectionName(JSON.parse(JSON.stringify(generalWithNoRelationalFields)), manualNodeAppendText)
+      .collections,
+  );
+  //添加工作流
+  const workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+  const workflowData = {
+    current: true,
+    options: { deleteExecutionOnStatus: [] },
+    title: workFlowName,
+    type: 'collection',
+    enabled: true,
+  };
+  const workflow = await apiCreateWorkflow(workflowData);
+  const workflowObj = JSON.parse(JSON.stringify(workflow));
+  const workflowId = workflowObj.id;
+  //配置工作流触发器
+  const triggerNodeData = {
+    config: { appends: [], collection: triggerNodeCollectionName, changed: [], condition: { $and: [] }, mode: 1 },
+  };
+  const triggerNode = await apiUpdateWorkflowTrigger(workflowId, triggerNodeData);
+  const triggerNodeObj = JSON.parse(JSON.stringify(triggerNode));
+  //配置Manual节点
+  await page.goto(`admin/workflow/workflows/${workflowId}`);
+  await page.waitForLoadState('networkidle');
+  const collectionTriggerNode = new CollectionTriggerNode(page, workFlowName, triggerNodeCollectionName);
+  await collectionTriggerNode.addNodeButton.click();
+  await page.getByRole('button', { name: 'manual', exact: true }).click();
+  const manualNodeName = 'Manual' + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  await page.getByLabel('Manual-Manual', { exact: true }).getByRole('textbox').fill(manualNodeName);
+  const manualNode = new ManualNode(page, manualNodeName);
+  const manualNodeId = await manualNode.node.locator('.workflow-node-id').innerText();
+  await manualNode.nodeConfigure.click();
+  await manualNode.assigneesDropDown.click();
+  await page.getByRole('option', { name: 'Super Admin' }).click();
+  await manualNode.configureUserInterfaceButton.click();
+  await manualNode.addBlockButton.hover();
+  await manualNode.createRecordFormMenu.hover();
+  await page.getByRole('menuitem', { name: manualNodeCollectionDisplayName }).click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page
+    .locator(`button[aria-label^="schema-initializer-Grid-FormItemInitializers-${manualNodeCollectionName}"]`)
+    .hover();
+  await page.getByLabel(`designer-schema-settings-CardItem-CreateFormDesigner-${manualNodeCollectionName}`).hover();
+  await page.getByRole('menuitem', { name: 'Edit block title' }).click();
+  const blockTitle = 'Create record' + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  await page.getByLabel('Edit block title').getByRole('textbox').fill(blockTitle);
+  await page.getByRole('button', { name: 'OK', exact: true }).click();
+  await page
+    .locator(`button[aria-label^="schema-initializer-Grid-FormItemInitializers-${manualNodeCollectionName}"]`)
+    .hover();
+  await page.getByRole('menuitem', { name: manualNodeFieldDisplayName }).getByRole('switch').click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page.mouse.click(300, 0);
+  await manualNode.submitButton.click();
+  await page.waitForLoadState('networkidle');
+
+  // 2、测试步骤：添加数据触发工作流
+  const triggerNodeCollectionRecordOne = triggerNodeFieldDisplayName + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  const triggerNodeCollectionRecords = await mockRecords(triggerNodeCollectionName, [
+    { orgname: triggerNodeCollectionRecordOne },
+  ]);
+  await page.waitForTimeout(1000);
+  // 3、预期结果：工作流成功触发,待办弹窗表单中显示数据
+  const getWorkflow = await apiGetWorkflow(workflowId);
+  const getWorkflowObj = JSON.parse(JSON.stringify(getWorkflow));
+  const getWorkflowExecuted = getWorkflowObj.executed;
+  expect(getWorkflowExecuted).toBe(1);
+
+  const newPage = mockPage();
+  await newPage.goto();
+  await page.waitForLoadState('networkidle');
+  await page.getByLabel('schema-initializer-Grid-BlockInitializers').hover();
+  await page.getByRole('menuitem', { name: 'check-square Workflow todos' }).click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page.waitForTimeout(300);
+  await page.getByLabel('action-Filter.Action-Filter-filter-users_jobs-workflow-todo').click();
+  await page.getByText('Add condition', { exact: true }).click();
+  await page.getByTestId('select-filter-field').click();
+  await page.getByRole('menuitemcheckbox', { name: 'Task right' }).click();
+  await page.getByRole('menuitemcheckbox', { name: 'Title' }).click();
+  await page.getByRole('textbox').fill(manualNodeName);
+  await page.getByRole('button', { name: 'Submit' }).click();
+
+  // 3、预期结果：列表中出现筛选的工作流
+  await expect(page.getByText(manualNodeName)).toBeAttached();
+
+  // 4、后置处理：删除工作流
+  await apiDeleteWorkflow(workflowId);
+});
+
+test('filter workflow name', async ({ page, mockPage, mockCollections, mockRecords }) => {
+  //数据表后缀标识
+  const triggerNodeAppendText = 'a' + faker.string.alphanumeric(4);
+  const manualNodeAppendText = 'b' + dayjs().format('HHmmss').toString();
+
+  // 创建触发器节点数据表
+  const triggerNodeCollectionDisplayName = `自动>组织[普通表]${triggerNodeAppendText}`;
+  const triggerNodeCollectionName = `tt_amt_org${triggerNodeAppendText}`;
+  const triggerNodeFieldName = 'orgname';
+  const triggerNodeFieldDisplayName = '公司名称(单行文本)';
+  await mockCollections(
+    appendJsonCollectionName(JSON.parse(JSON.stringify(generalWithNoRelationalFields)), triggerNodeAppendText)
+      .collections,
+  );
+  // 创建Manual节点数据表
+  const manualNodeCollectionDisplayName = `自动>组织[普通表]${manualNodeAppendText}`;
+  const manualNodeCollectionName = `tt_amt_org${manualNodeAppendText}`;
+  const manualNodeFieldName = 'orgname';
+  const manualNodeFieldDisplayName = '公司名称(单行文本)';
+  await mockCollections(
+    appendJsonCollectionName(JSON.parse(JSON.stringify(generalWithNoRelationalFields)), manualNodeAppendText)
+      .collections,
+  );
+  //添加工作流
+  const workFlowName = faker.string.alphanumeric(5) + triggerNodeAppendText;
+  const workflowData = {
+    current: true,
+    options: { deleteExecutionOnStatus: [] },
+    title: workFlowName,
+    type: 'collection',
+    enabled: true,
+  };
+  const workflow = await apiCreateWorkflow(workflowData);
+  const workflowObj = JSON.parse(JSON.stringify(workflow));
+  const workflowId = workflowObj.id;
+  //配置工作流触发器
+  const triggerNodeData = {
+    config: { appends: [], collection: triggerNodeCollectionName, changed: [], condition: { $and: [] }, mode: 1 },
+  };
+  const triggerNode = await apiUpdateWorkflowTrigger(workflowId, triggerNodeData);
+  const triggerNodeObj = JSON.parse(JSON.stringify(triggerNode));
+  //配置Manual节点
+  await page.goto(`admin/workflow/workflows/${workflowId}`);
+  await page.waitForLoadState('networkidle');
+  const collectionTriggerNode = new CollectionTriggerNode(page, workFlowName, triggerNodeCollectionName);
+  await collectionTriggerNode.addNodeButton.click();
+  await page.getByRole('button', { name: 'manual', exact: true }).click();
+  const manualNodeName = 'Manual' + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  await page.getByLabel('Manual-Manual', { exact: true }).getByRole('textbox').fill(manualNodeName);
+  const manualNode = new ManualNode(page, manualNodeName);
+  const manualNodeId = await manualNode.node.locator('.workflow-node-id').innerText();
+  await manualNode.nodeConfigure.click();
+  await manualNode.assigneesDropDown.click();
+  await page.getByRole('option', { name: 'Super Admin' }).click();
+  await manualNode.configureUserInterfaceButton.click();
+  await manualNode.addBlockButton.hover();
+  await manualNode.createRecordFormMenu.hover();
+  await page.getByRole('menuitem', { name: manualNodeCollectionDisplayName }).click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page
+    .locator(`button[aria-label^="schema-initializer-Grid-FormItemInitializers-${manualNodeCollectionName}"]`)
+    .hover();
+  await page.getByLabel(`designer-schema-settings-CardItem-CreateFormDesigner-${manualNodeCollectionName}`).hover();
+  await page.getByRole('menuitem', { name: 'Edit block title' }).click();
+  const blockTitle = 'Create record' + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  await page.getByLabel('Edit block title').getByRole('textbox').fill(blockTitle);
+  await page.getByRole('button', { name: 'OK', exact: true }).click();
+  await page
+    .locator(`button[aria-label^="schema-initializer-Grid-FormItemInitializers-${manualNodeCollectionName}"]`)
+    .hover();
+  await page.getByRole('menuitem', { name: manualNodeFieldDisplayName }).getByRole('switch').click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page.mouse.click(300, 0);
+  await manualNode.submitButton.click();
+  await page.waitForLoadState('networkidle');
+
+  // 2、测试步骤：添加数据触发工作流
+  const triggerNodeCollectionRecordOne = triggerNodeFieldDisplayName + dayjs().format('YYYYMMDDHHmmss.SSS').toString();
+  const triggerNodeCollectionRecords = await mockRecords(triggerNodeCollectionName, [
+    { orgname: triggerNodeCollectionRecordOne },
+  ]);
+  await page.waitForTimeout(1000);
+  // 3、预期结果：工作流成功触发,待办弹窗表单中显示数据
+  const getWorkflow = await apiGetWorkflow(workflowId);
+  const getWorkflowObj = JSON.parse(JSON.stringify(getWorkflow));
+  const getWorkflowExecuted = getWorkflowObj.executed;
+  expect(getWorkflowExecuted).toBe(1);
+
+  const newPage = mockPage();
+  await newPage.goto();
+  await page.waitForLoadState('networkidle');
+  await page.getByLabel('schema-initializer-Grid-BlockInitializers').hover();
+  await page.getByRole('menuitem', { name: 'check-square Workflow todos' }).click();
+  await page.mouse.move(300, 0, { steps: 100 });
+  await page.waitForTimeout(300);
+  await page.getByLabel('action-Filter.Action-Filter-filter-users_jobs-workflow-todo').click();
+  await page.getByText('Add condition', { exact: true }).click();
+  await page.getByTestId('select-filter-field').click();
+  await page.getByRole('menuitemcheckbox', { name: 'Workflow right' }).click();
+  await page.getByRole('menuitemcheckbox', { name: 'Name' }).click();
+  await page.getByRole('textbox').fill(workFlowName);
+  await page.getByRole('button', { name: 'Submit' }).click();
+
+  // 3、预期结果：列表中出现筛选的工作流
+  await expect(page.getByText(manualNodeName)).toBeAttached();
+
+  // 4、后置处理：删除工作流
+  await apiDeleteWorkflow(workflowId);
+});

package/src/client/index.ts

@@ -20,8 +20,7 @@ export default class extends Plugin {
 
     // this.app.addProvider(Provider);
     const workflow = this.app.pm.get('workflow') as WorkflowPlugin;
-    const manualInstruction = new Manual();
-    workflow.instructions.register(manualInstruction.type, manualInstruction);
+    workflow.registerInstruction('manual', Manual);
 
     this.app.schemaInitializerManager.add(addBlockButton);
     this.app.schemaInitializerManager.add(addActionButton);

package/src/client/instruction/SchemaConfig.tsx

@@ -416,7 +416,6 @@ export function SchemaConfig({ value, onChange }) {
   const nodeComponents = {};
   nodes.forEach((item) => {
     const instruction = workflowPlugin.instructions.get(item.type);
-    Object.assign(nodeInitializers, instruction.initializers);
     Object.assign(nodeComponents, instruction.components);
   });
 

package/src/client/instruction/index.tsx

@@ -1,6 +1,6 @@
-import { SchemaInitializerItemType, useCollectionManager, useCompile } from '@nocobase/client';
+import { SchemaInitializerItemType, useCollectionManager, useCompile, usePlugin } from '@nocobase/client';
 
-import {
+import WorkflowPlugin, {
   defaultFieldNames,
   getCollectionFieldOptions,
   CollectionBlockInitializer,
@@ -154,4 +154,7 @@ export default class extends Instruction {
         }
       : null;
   }
+  isAvailable({ engine, workflow, upstream, branchIndex }) {
+    return !engine.isWorkflowSync(workflow);
+  }
 }

package/src/locale/ko_KR.json

@@ -0,0 +1,32 @@
+{
+  "Manual": "수동",
+  "Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.":
+    "수동으로 데이터를 제출하고 계속 진행할지 종료할지를 결정하는 데 사용될 수 있습니다. 워크플로우가 수동 노드에 도달하면 지정된 사용자에 대해 할 일 항목을 생성하고 사용자가 양식을 제출한 후 처리를 계속합니다.",
+  "Values preset in this form will override user submitted ones when continue or reject.": 
+    "이 양식에 사전 설정된 값은 계속 또는 거부될 때 사용자가 제출한 값이 덮어씁니다.",
+  "Assignee": "담당자",
+  "Assignees": "담당자",
+  "User interface": "사용자 인터페이스",
+  "Configure user interface": "사용자 인터페이스 구성",
+  "View user interface": "사용자 인터페이스 보기",
+  "Separately": "별도로",
+  "Each user has own task": "각 사용자는 고유한 작업을 갖습니다.",
+  "Collaboratively": "협력하여",
+  "Everyone shares one task": "모두가 하나의 작업을 공유합니다.",
+  "Negotiation": "협상",
+  "All pass": "모두 통과",
+  "Everyone should pass": "모든 사람이 통과해야 합니다.",
+  "Any pass": "어떤 통과",
+  "Anyone pass": "누구든 통과하면 됩니다.",
+  "Field name existed in form": "양식에 이미 존재하는 필드 이름",
+  "Continue the process": "프로세스 계속 진행",
+  "Terminate the process": "프로세스 종료",
+  "Save temporarily": "임시로 저장",
+  "Custom form": "사용자 정의 양식",
+  "Data record": "데이터 레코드",
+  "Create record form": "레코드 생성 양식",
+  "Update record form": "레코드 업데이트 양식",
+  "Filter settings": "필터 설정",
+  "Workflow todos": "워크플로우 할 일",
+  "Task node": "작업 노드"
+}

package/src/locale/zh-CN.json

@@ -26,5 +26,6 @@
   "Update record form": "更新数据表单",
   "Filter settings": "筛选设置",
   "Workflow todos": "工作流待办",
-  "Task node": "任务节点"
+  "Task node": "任务节点",
+  "Unprocessed": "未处理"
 }

package/src/server/ManualInstruction.ts

@@ -99,6 +99,7 @@ export default class extends Instruction {
       status: JOB_STATUS.PENDING,
       result: mode ? [] : null,
       nodeId: node.id,
+      nodeKey: node.key,
       upstreamId: prevJob?.id ?? null,
     });
 

package/src/server/Plugin.ts

@@ -37,7 +37,7 @@ export default class extends Plugin {
 
     this.app.acl.allow('users_jobs', ['list', 'get', 'submit'], 'loggedIn');
 
-    const workflowPlugin = this.app.getPlugin<WorkflowPlugin>(WorkflowPlugin);
+    const workflowPlugin = this.app.pm.get(WorkflowPlugin) as WorkflowPlugin;
     workflowPlugin.registerInstruction('manual', ManualInstruction);
   }
 }