@nocobase/plugin-workflow-manual 0.17.0-alpha.4

package/src/client/instruction/utils.ts

@@ -0,0 +1,19 @@
+export function findSchema(schema, filter, onlyLeaf = false) {
+  const result = [];
+
+  if (!schema) {
+    return result;
+  }
+
+  if (filter(schema) && (!onlyLeaf || !schema.properties)) {
+    result.push(schema);
+    return result;
+  }
+
+  if (schema.properties) {
+    Object.keys(schema.properties).forEach((key) => {
+      result.push(...findSchema(schema.properties[key], filter));
+    });
+  }
+  return result;
+}

package/src/index.ts

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

package/src/locale/en-US.json

@@ -0,0 +1,30 @@
+{
+  "Manual": "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.": "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.": "Values preset in this form will override user submitted ones when continue or reject.",
+  "Assignee": "Assignee",
+  "Assignees": "Assignees",
+  "User interface": "User interface",
+  "Configure user interface": "Configure user interface",
+  "View user interface": "View user interface",
+  "Separately": "Separately",
+  "Each user has own task": "Each user has own task",
+  "Collaboratively": "Collaboratively",
+  "Everyone shares one task": "Everyone shares one task",
+  "Negotiation": "Negotiation",
+  "All pass": "All pass",
+  "Everyone should pass": "Everyone should pass",
+  "Any pass": "Any pass",
+  "Anyone pass": "Anyone pass",
+  "Field name existed in form": "Field name existed in form",
+  "Continue the process": "Continue the process",
+  "Terminate the process": "Terminate the process",
+  "Save temporarily": "Save temporarily",
+  "Custom form": "Custom form",
+  "Data record": "Data record",
+  "Create record form": "Create record form",
+  "Update record form": "Update record form",
+  "Filter settings": "Filter settings",
+  "Workflow todos": "Workflow todos",
+  "Task": "Task"
+}

package/src/locale/index.ts

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

package/src/locale/zh-CN.json

@@ -0,0 +1,30 @@
+{
+  "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": "任务"
+}

package/src/server/ManualInstruction.ts

@@ -0,0 +1,151 @@
+import { Registry } from '@nocobase/utils';
+import WorkflowPlugin, { Processor, JOB_STATUS, Instruction } from '@nocobase/plugin-workflow';
+
+import initFormTypes, { FormHandler } from './forms';
+
+type FormType = {
+  type: 'custom' | 'create' | 'update';
+  actions: number[];
+  options: {
+    [key: string]: any;
+  };
+};
+
+export interface ManualConfig {
+  schema: { [key: string]: any };
+  forms: { [key: string]: FormType };
+  assignees?: (number | string)[];
+  mode?: number;
+}
+
+const MULTIPLE_ASSIGNED_MODE = {
+  SINGLE: Symbol('single'),
+  ALL: Symbol('all'),
+  ANY: Symbol('any'),
+  ALL_PERCENTAGE: Symbol('all percentage'),
+  ANY_PERCENTAGE: Symbol('any percentage'),
+};
+
+const Modes = {
+  [MULTIPLE_ASSIGNED_MODE.SINGLE]: {
+    getStatus(distribution, assignees) {
+      const done = distribution.find((item) => item.status !== JOB_STATUS.PENDING && item.count > 0);
+      return done ? done.status : null;
+    },
+  },
+  [MULTIPLE_ASSIGNED_MODE.ALL]: {
+    getStatus(distribution, assignees) {
+      const resolved = distribution.find((item) => item.status === JOB_STATUS.RESOLVED);
+      if (resolved && resolved.count === assignees.length) {
+        return JOB_STATUS.RESOLVED;
+      }
+      const rejected = distribution.find((item) => item.status < JOB_STATUS.PENDING);
+      if (rejected && rejected.count) {
+        return rejected.status;
+      }
+
+      return null;
+    },
+  },
+  [MULTIPLE_ASSIGNED_MODE.ANY]: {
+    getStatus(distribution, assignees) {
+      const resolved = distribution.find((item) => item.status === JOB_STATUS.RESOLVED);
+      if (resolved && resolved.count) {
+        return JOB_STATUS.RESOLVED;
+      }
+      const rejectedCount = distribution.reduce(
+        (count, item) => (item.status < JOB_STATUS.PENDING ? count + item.count : count),
+        0,
+      );
+      // NOTE: all failures are considered as rejected for now
+      if (rejectedCount === assignees.length) {
+        return JOB_STATUS.REJECTED;
+      }
+
+      return null;
+    },
+  },
+};
+
+function getMode(mode) {
+  switch (true) {
+    case mode === 1:
+      return Modes[MULTIPLE_ASSIGNED_MODE.ALL];
+    case mode === -1:
+      return Modes[MULTIPLE_ASSIGNED_MODE.ANY];
+    case mode > 0:
+      return Modes[MULTIPLE_ASSIGNED_MODE.ALL_PERCENTAGE];
+    case mode < 0:
+      return Modes[MULTIPLE_ASSIGNED_MODE.ANY_PERCENTAGE];
+    default:
+      return Modes[MULTIPLE_ASSIGNED_MODE.SINGLE];
+  }
+}
+
+export default class extends Instruction {
+  formTypes = new Registry<FormHandler>();
+
+  constructor(public plugin: WorkflowPlugin) {
+    super(plugin);
+
+    initFormTypes(this);
+  }
+
+  async run(node, prevJob, processor: Processor) {
+    const { mode, ...config } = node.config as ManualConfig;
+    const assignees = [...new Set(processor.getParsedValue(config.assignees, node.id) || [])];
+
+    const job = await processor.saveJob({
+      status: JOB_STATUS.PENDING,
+      result: mode ? [] : null,
+      nodeId: node.id,
+      upstreamId: prevJob?.id ?? null,
+    });
+
+    // NOTE: batch create users jobs
+    const UserJobModel = processor.options.plugin.db.getModel('users_jobs');
+    await UserJobModel.bulkCreate(
+      assignees.map((userId) => ({
+        userId,
+        jobId: job.id,
+        nodeId: node.id,
+        executionId: job.executionId,
+        workflowId: node.workflowId,
+        status: JOB_STATUS.PENDING,
+      })),
+      {
+        transaction: processor.transaction,
+      },
+    );
+
+    return job;
+  }
+
+  async resume(node, job, processor: Processor) {
+    // NOTE: check all users jobs related if all done then continue as parallel
+    const { assignees = [], mode } = node.config as ManualConfig;
+
+    const UserJobModel = processor.options.plugin.db.getModel('users_jobs');
+    const distribution = await UserJobModel.count({
+      where: {
+        jobId: job.id,
+      },
+      group: ['status'],
+      transaction: processor.transaction,
+    });
+
+    const submitted = distribution.reduce(
+      (count, item) => (item.status !== JOB_STATUS.PENDING ? count + item.count : count),
+      0,
+    );
+    const status = job.status || (getMode(mode).getStatus(distribution, assignees) ?? JOB_STATUS.PENDING);
+    const result = mode ? (submitted || 0) / assignees.length : job.latestUserJob?.result ?? job.result;
+    processor.logger.debug(`manual resume job and next status: ${status}`);
+    job.set({
+      status,
+      result,
+    });
+
+    return job;
+  }
+}

package/src/server/Plugin.ts

@@ -0,0 +1,48 @@
+import { Plugin } from '@nocobase/server';
+import actions from '@nocobase/actions';
+import { HandlerType } from '@nocobase/resourcer';
+import WorkflowPlugin, { JOB_STATUS } from '@nocobase/plugin-workflow';
+
+import jobsCollection from './collecions/jobs';
+import usersCollection from './collecions/users';
+import usersJobsCollection from './collecions/users_jobs';
+import { submit } from './actions';
+
+import ManualInstruction from './ManualInstruction';
+
+export default class extends Plugin {
+  workflow: WorkflowPlugin;
+
+  async load() {
+    this.app.db.collection(usersJobsCollection);
+    this.app.db.extendCollection(usersCollection);
+    this.app.db.extendCollection(jobsCollection);
+
+    this.app.resource({
+      name: 'users_jobs',
+      actions: {
+        list: {
+          filter: {
+            $or: [
+              {
+                'workflow.enabled': true,
+              },
+              {
+                'workflow.enabled': false,
+                status: {
+                  $ne: JOB_STATUS.PENDING,
+                },
+              },
+            ],
+          },
+          handler: actions.list as HandlerType,
+        },
+        submit,
+      },
+    });
+
+    const workflowPlugin = this.app.getPlugin('workflow') as WorkflowPlugin;
+    this.workflow = workflowPlugin;
+    workflowPlugin.instructions.register('manual', new ManualInstruction(workflowPlugin));
+  }
+}

package/src/server/__tests__/collections/categories.ts

@@ -0,0 +1,15 @@
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  name: 'categories',
+  fields: [
+    {
+      type: 'string',
+      name: 'title',
+    },
+    {
+      type: 'hasMany',
+      name: 'posts',
+    },
+  ],
+} as CollectionOptions;

package/src/server/__tests__/collections/comments.ts

@@ -0,0 +1,24 @@
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  name: 'comments',
+  fields: [
+    {
+      type: 'belongsTo',
+      name: 'post',
+    },
+    {
+      type: 'text',
+      name: 'content',
+    },
+    {
+      type: 'integer',
+      name: 'status',
+      defaultValue: 0,
+    },
+    {
+      type: 'hasMany',
+      name: 'replies',
+    },
+  ],
+} as CollectionOptions;

package/src/server/__tests__/collections/posts.ts

@@ -0,0 +1,40 @@
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  name: 'posts',
+  createdBy: true,
+  updatedBy: true,
+  fields: [
+    {
+      type: 'string',
+      name: 'title',
+    },
+    {
+      type: 'boolean',
+      name: 'published',
+      defaultValue: false,
+    },
+    {
+      type: 'integer',
+      name: 'read',
+      defaultValue: 0,
+    },
+    {
+      type: 'belongsTo',
+      name: 'category',
+    },
+    {
+      type: 'hasMany',
+      name: 'comments',
+    },
+    {
+      type: 'belongsToMany',
+      name: 'tags',
+    },
+    {
+      type: 'integer',
+      name: 'read',
+      defaultValue: 0,
+    },
+  ],
+} as CollectionOptions;

package/src/server/__tests__/collections/replies.ts

@@ -0,0 +1,9 @@
+export default {
+  name: 'replies',
+  fields: [
+    {
+      type: 'string',
+      name: 'content',
+    },
+  ],
+};

package/src/server/__tests__/collections/tags.ts

@@ -0,0 +1,15 @@
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  name: 'tags',
+  fields: [
+    {
+      type: 'belongsToMany',
+      name: 'posts',
+    },
+    {
+      type: 'string',
+      name: 'name',
+    },
+  ],
+} as CollectionOptions;