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

package/src/client/ParallelInstruction.tsx

@@ -0,0 +1,147 @@
+import React, { useState } from 'react';
+import { Button, Tooltip } from 'antd';
+import { PlusOutlined } from '@ant-design/icons';
+
+import { css } from '@nocobase/client';
+
+import {
+  NodeDefaultView,
+  Branch,
+  useFlowContext,
+  useStyles,
+  useGetAriaLabelOfAddButton,
+  RadioWithTooltip,
+  Instruction,
+} from '@nocobase/plugin-workflow/client';
+
+import { NAMESPACE, useLang } from '../locale';
+
+export default class extends Instruction {
+  title = `{{t("Parallel branch", { ns: "${NAMESPACE}" })}}`;
+  type = 'parallel';
+  group = 'control';
+  description = `{{t("Run multiple branch processes in parallel.", { ns: "${NAMESPACE}" })}}`;
+  fieldset = {
+    mode: {
+      type: 'string',
+      title: `{{t("Mode", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-component': 'RadioWithTooltip',
+      'x-component-props': {
+        options: [
+          {
+            value: 'all',
+            label: `{{t('All succeeded', { ns: "${NAMESPACE}" })}}`,
+            tooltip: `{{t('Continue after all branches succeeded', { ns: "${NAMESPACE}" })}}`,
+          },
+          {
+            value: 'any',
+            label: `{{t('Any succeeded', { ns: "${NAMESPACE}" })}}`,
+            tooltip: `{{t('Continue after any branch succeeded', { ns: "${NAMESPACE}" })}}`,
+          },
+          {
+            value: 'race',
+            label: `{{t('Any succeeded or failed', { ns: "${NAMESPACE}" })}}`,
+            tooltip: `{{t('Continue after any branch succeeded, or exit after any branch failed.', { ns: "${NAMESPACE}" })}}`,
+          },
+        ],
+      },
+      default: 'all',
+    },
+  };
+  components = {
+    RadioWithTooltip,
+  };
+  Component({ data }) {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const { styles } = useStyles();
+    const {
+      id,
+      config: { mode },
+    } = data;
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const { workflow, nodes } = useFlowContext();
+    const branches = nodes
+      .reduce((result, node) => {
+        if (node.upstreamId === id && node.branchIndex != null) {
+          return result.concat(node);
+        }
+        return result;
+      }, [])
+      .sort((a, b) => a.branchIndex - b.branchIndex);
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const [branchCount, setBranchCount] = useState(Math.max(2, branches.length));
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const { getAriaLabel } = useGetAriaLabelOfAddButton(data);
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const langAddBranch = useLang('Add branch');
+
+    const tempBranches = Array(Math.max(0, branchCount - branches.length)).fill(null);
+    const lastBranchHead = branches[branches.length - 1];
+
+    return (
+      <NodeDefaultView data={data}>
+        <div className={styles.nodeSubtreeClass}>
+          <div className={styles.branchBlockClass}>
+            {branches.map((branch) => (
+              <Branch key={branch.id} from={data} entry={branch} branchIndex={branch.branchIndex} />
+            ))}
+            {tempBranches.map((_, i) => (
+              <Branch
+                key={`temp_${branches.length + i}`}
+                from={data}
+                branchIndex={(lastBranchHead ? lastBranchHead.branchIndex : 0) + i + 1}
+                controller={
+                  branches.length + i > 1 ? (
+                    <div
+                      className={css`
+                        padding-top: 2em;
+
+                        > button {
+                          .anticon {
+                            transform: rotate(45deg);
+                          }
+                        }
+                      `}
+                    >
+                      <Button
+                        shape="circle"
+                        icon={<PlusOutlined />}
+                        onClick={() => setBranchCount(branchCount - 1)}
+                        disabled={workflow.executed}
+                      />
+                    </div>
+                  ) : null
+                }
+              />
+            ))}
+          </div>
+          <Tooltip
+            title={langAddBranch}
+            className={css`
+              visibility: ${workflow.executed ? 'hidden' : 'visible'};
+            `}
+          >
+            <Button
+              aria-label={getAriaLabel('add-branch')}
+              icon={<PlusOutlined />}
+              className={css`
+                position: relative;
+                top: 1em;
+                transform-origin: center;
+                transform: rotate(45deg);
+
+                .anticon {
+                  transform-origin: center;
+                  transform: rotate(-45deg);
+                }
+              `}
+              onClick={() => setBranchCount(branchCount + 1)}
+              disabled={workflow.executed}
+            />
+          </Tooltip>
+        </div>
+      </NodeDefaultView>
+    );
+  }
+}

package/src/client/index.ts

@@ -0,0 +1,19 @@
+import { Plugin } from '@nocobase/client';
+import WorkflowPlugin from '@nocobase/plugin-workflow/client';
+
+import ParallelInstruction from './ParallelInstruction';
+
+export default class extends Plugin {
+  async afterAdd() {
+    // await this.app.pm.add()
+  }
+
+  async beforeLoad() {}
+
+  // You can get and modify the app instance here
+  async load() {
+    const workflow = this.app.pm.get(WorkflowPlugin);
+    const parallelInstruction = new ParallelInstruction();
+    workflow.instructions.register(parallelInstruction.type, parallelInstruction);
+  }
+}

package/src/index.ts

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

package/src/locale/en-US.json

@@ -0,0 +1,11 @@
+{
+  "Parallel branch": "Parallel branch",
+  "Run multiple branch processes in parallel.": "Run multiple branch processes in parallel.",
+  "Add branch": "Add branch",
+  "All succeeded": "All succeeded",
+  "Any succeeded": "Any succeeded",
+  "Any succeeded or failed": "Any succeeded or failed",
+  "Continue after all branches succeeded": "Continue after all branches succeeded",
+  "Continue after any branch succeeded": "Continue after any branch succeeded",
+  "Continue after any branch succeeded, or exit after any branch failed.": "Continue after any branch succeeded, or exit after any branch failed."
+}

package/src/locale/es-ES.json

@@ -0,0 +1,10 @@
+{
+  "Parallel branch": "Rama paralela",
+  "Add branch": "Añadir rama",
+  "All succeeded": "Todo correcto",
+  "Any succeeded": "Cualquiera con éxito",
+  "Any succeeded or failed": "Cualquiera tuvo éxito o falló",
+  "Continue after all branches succeeded": "Continuar después que todas las ramas han tenido éxito",
+  "Continue after any branch succeeded": "Continuar después que cualquier rama tenga éxito",
+  "Continue after any branch succeeded, or exit after any branch failed": "Continuar después de que cualquier rama tenga éxito, o salir después de que cualquier rama falle"
+}

package/src/locale/fr-FR.json

@@ -0,0 +1,10 @@
+{
+  "Parallel branch": "Branche parallèle",
+  "Add branch": "Ajouter une branche",
+  "All succeeded": "Tous réussis",
+  "Any succeeded": "Un réussi",
+  "Any succeeded or failed": "Un réussi ou un échoué",
+  "Continue after all branches succeeded": "Continuer après la réussite de toutes les branches",
+  "Continue after any branch succeeded": "Continuer après la réussite d'une branche",
+  "Continue after any branch succeeded, or exit after any branch failed": "Continuer après la réussite d'une branche, ou quitter après l'échec d'une branche"
+}

package/src/locale/index.ts

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

package/src/locale/ja-JP.json

@@ -0,0 +1,7 @@
+{
+  "Parallel branch": "分岐",
+  "All succeeded": "すべて成功",
+  "Any succeeded": "いずれかが成功",
+  "Continue after all branches succeeded": "すべての分岐が成功した後に続行",
+  "Continue after any branch succeeded": "いずれかの分岐が成功した後に続行"
+}

package/src/locale/pt-BR.json

@@ -0,0 +1,10 @@
+{
+  "Parallel branch": "Ramo paralelo",
+  "Add branch": "Adicionar ramo",
+  "All succeeded": "Todos com sucesso",
+  "Any succeeded": "Qualquer um com sucesso",
+  "Any succeeded or failed": "Qualquer um com sucesso ou falha",
+  "Continue after all branches succeeded": "Continuar após todos os ramos com sucesso",
+  "Continue after any branch succeeded": "Continuar após qualquer ramo com sucesso",
+  "Continue after any branch succeeded, or exit after any branch failed": "Continuar após qualquer ramo com sucesso ou sair após qualquer ramo falhar"
+}

package/src/locale/ru-RU.json

@@ -0,0 +1,7 @@
+{
+  "Parallel branch": "Параллельная ветвь",
+  "All succeeded": "Всё успешно",
+  "Any succeeded": "Что-то успешно",
+  "Continue after all branches succeeded": "Продолжать после успеха на всех ветвях",
+  "Continue after any branch succeeded": "Продолжать после успеха на любой из ветвей"
+}

package/src/locale/tr-TR.json

@@ -0,0 +1,7 @@
+{
+  "Parallel branch": "Paralel dal",
+  "All succeeded": "Hepsi başarılı",
+  "Any succeeded": "Herhangi biri başarılı",
+  "Continue after all branches succeeded": "Tüm dallar başarılı olduktan sonra devam et",
+  "Continue after any branch succeeded": "Herhangi bir dal başarılı olduktan sonra devam et"
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,11 @@
+{
+  "Parallel branch": "分支",
+  "Run multiple branch processes in parallel.": "并行运行多个分支流程。",
+  "Add branch": "增加分支",
+  "All succeeded": "全部成功",
+  "Any succeeded": "任意成功",
+  "Any succeeded or failed": "任意成功或失败",
+  "Continue after all branches succeeded": "全部分支都成功后才能继续",
+  "Continue after any branch succeeded": "任意分支成功后就继续",
+  "Continue after any branch succeeded, or exit after any branch failed.": "任意分支成功就继续流程，或者任意分支失败就退出流程。"
+}

package/src/server/ParallelInstruction.ts

@@ -0,0 +1,119 @@
+import { Processor, Instruction, JOB_STATUS, FlowNodeModel, JobModel } from '@nocobase/plugin-workflow';
+
+export const PARALLEL_MODE = {
+  ALL: 'all',
+  ANY: 'any',
+  RACE: 'race',
+} as const;
+
+const Modes = {
+  [PARALLEL_MODE.ALL]: {
+    next(previous) {
+      return previous.status >= JOB_STATUS.PENDING;
+    },
+    getStatus(result) {
+      const failedStatus = result.find((status) => status != null && status < JOB_STATUS.PENDING);
+      if (typeof failedStatus !== 'undefined') {
+        return failedStatus;
+      }
+      if (result.every((status) => status != null && status === JOB_STATUS.RESOLVED)) {
+        return JOB_STATUS.RESOLVED;
+      }
+      return JOB_STATUS.PENDING;
+    },
+  },
+  [PARALLEL_MODE.ANY]: {
+    next(previous) {
+      return previous.status <= JOB_STATUS.PENDING;
+    },
+    getStatus(result) {
+      if (result.some((status) => status != null && status === JOB_STATUS.RESOLVED)) {
+        return JOB_STATUS.RESOLVED;
+      }
+      if (result.some((status) => (status != null ? status === JOB_STATUS.PENDING : true))) {
+        return JOB_STATUS.PENDING;
+      }
+      return JOB_STATUS.FAILED;
+    },
+  },
+  [PARALLEL_MODE.RACE]: {
+    next(previous) {
+      return previous.status === JOB_STATUS.PENDING;
+    },
+    getStatus(result) {
+      if (result.some((status) => status != null && status === JOB_STATUS.RESOLVED)) {
+        return JOB_STATUS.RESOLVED;
+      }
+      const failedStatus = result.find((status) => status != null && status < JOB_STATUS.PENDING);
+      if (typeof failedStatus !== 'undefined') {
+        return failedStatus;
+      }
+      return JOB_STATUS.PENDING;
+    },
+  },
+};
+
+export default class extends Instruction {
+  async run(node: FlowNodeModel, prevJob: JobModel, processor: Processor) {
+    const branches = processor.getBranches(node);
+
+    const job = await processor.saveJob({
+      status: JOB_STATUS.PENDING,
+      result: Array(branches.length).fill(null),
+      nodeId: node.id,
+      upstreamId: prevJob?.id ?? null,
+    });
+
+    // NOTE:
+    // use `reduce` but not `Promise.all` here to avoid racing manupulating db.
+    // for users, this is almost equivalent to `Promise.all`,
+    // because of the delay is not significant sensible.
+    // another benifit of this is, it could handle sequenced branches in future.
+    const { mode = PARALLEL_MODE.ALL } = node.config;
+    await branches.reduce(
+      (promise: Promise<any>, branch, i) =>
+        promise.then(async (previous) => {
+          if (i && !Modes[mode].next(previous)) {
+            return previous;
+          }
+          await processor.run(branch, job);
+
+          // find last job of the branch
+          return processor.findBranchLastJob(branch, job);
+        }),
+      Promise.resolve(),
+    );
+
+    return null;
+  }
+
+  async resume(node: FlowNodeModel, branchJob, processor: Processor) {
+    const job = processor.findBranchParentJob(branchJob, node) as JobModel;
+
+    const { result, status } = job;
+    // if parallel has been done (resolved / rejected), do not care newly executed branch jobs.
+    if (status !== JOB_STATUS.PENDING) {
+      return processor.exit();
+    }
+
+    // find the index of the node which start the branch
+    const jobNode = processor.nodesMap.get(branchJob.nodeId) as FlowNodeModel;
+    const branchStartNode = processor.findBranchStartNode(jobNode, node) as FlowNodeModel;
+    const branches = processor.getBranches(node);
+    const branchIndex = branches.indexOf(branchStartNode);
+    const { mode = PARALLEL_MODE.ALL } = node.config || {};
+
+    const newResult = [...result.slice(0, branchIndex), branchJob.status, ...result.slice(branchIndex + 1)];
+    job.set({
+      result: newResult,
+      status: Modes[mode].getStatus(newResult),
+    });
+
+    if (job.status === JOB_STATUS.PENDING) {
+      await job.save({ transaction: processor.transaction });
+      return processor.exit();
+    }
+
+    return job;
+  }
+}

package/src/server/Plugin.ts

@@ -0,0 +1,14 @@
+import { Plugin } from '@nocobase/server';
+import WorkflowPlugin from '@nocobase/plugin-workflow';
+
+import ParallelInstruction from './ParallelInstruction';
+
+export default class extends Plugin {
+  workflow: WorkflowPlugin;
+
+  async load() {
+    const workflowPlugin = this.app.getPlugin('workflow') as WorkflowPlugin;
+    this.workflow = workflowPlugin;
+    workflowPlugin.instructions.register('parallel', new ParallelInstruction(workflowPlugin));
+  }
+}