@nocobase/flow-engine 2.0.0-alpha.2

package/src/flow-registry/__tests__/instance-and-global-registry.test.ts

@@ -0,0 +1,67 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { describe, expect, test, vi } from 'vitest';
+import { FlowEngine } from '../../flowEngine';
+import { FlowModel } from '../../models/flowModel';
+
+describe('Flow registries integration (instance + global)', () => {
+  test('merges flows with instance precedence; dispatchEvent hits both sets appropriately', async () => {
+    const engine = new FlowEngine();
+
+    class MyBase extends FlowModel {}
+    class MyModel extends MyBase {}
+    engine.registerModels({ MyBase, MyModel });
+
+    const staticSharedHandler = vi.fn().mockResolvedValue('static-shared');
+    const staticBaseOnlyHandler = vi.fn().mockResolvedValue('static-base');
+    const instanceSharedHandler = vi.fn().mockResolvedValue('instance-shared');
+    const instanceOnlyHandler = vi.fn().mockResolvedValue('instance-only');
+
+    // Static/global flows on class registries
+    MyModel.registerFlow({
+      key: 'shared',
+      on: { eventName: 'click' },
+      steps: { s: { title: 'S', handler: staticSharedHandler } },
+    });
+    MyBase.registerFlow({
+      key: 'baseOnly',
+      on: { eventName: 'click' },
+      steps: { b: { title: 'B', handler: staticBaseOnlyHandler } },
+    });
+
+    // Create instance and add instance flows
+    const model = engine.createModel<MyModel>({ use: 'MyModel' });
+    model.flowRegistry.addFlow('instanceOnly', {
+      on: { eventName: 'click' },
+      steps: { i: { title: 'I', handler: instanceOnlyHandler } },
+    });
+
+    // Override the static shared flow with instance definition
+    model.flowRegistry.addFlow('shared', {
+      on: { eventName: 'click' },
+      steps: { is: { title: 'IS', handler: instanceSharedHandler } },
+    });
+
+    // Verify merged keys and precedence
+    const all = model.getFlows();
+    expect(Array.from(all.keys()).sort()).toEqual(['baseOnly', 'instanceOnly', 'shared']);
+    expect(all.get('shared')?.mapSteps((s) => s.title)).toEqual(['IS']);
+
+    // Dispatch event should call: instanceOnly, instance(shared override), and static baseOnly
+    await model.dispatchEvent('click', { any: 'arg' });
+    await new Promise((_resolve) => setTimeout(_resolve, 0));
+
+    expect(instanceOnlyHandler).toHaveBeenCalled();
+    expect(instanceSharedHandler).toHaveBeenCalled();
+    expect(staticBaseOnlyHandler).toHaveBeenCalled();
+    // The static shared should NOT be called because instance overrides it by key
+    expect(staticSharedHandler).not.toHaveBeenCalled();
+  });
+});

package/src/flow-registry/__tests__/instanceFlowRegistry.test.ts

@@ -0,0 +1,83 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { describe, expect, test, vi } from 'vitest';
+import { FlowEngine } from '../../flowEngine';
+import { FlowModel } from '../../models/flowModel';
+
+describe('InstanceFlowRegistry', () => {
+  function createModel() {
+    const engine = new FlowEngine();
+    class MyModel extends FlowModel {}
+    engine.registerModels({ MyModel });
+    return engine.createModel({ use: 'MyModel' });
+  }
+
+  test('saveFlow calls model.saveStepParams via FlowDefinition.save', async () => {
+    const model = createModel();
+    const saveStepParamsSpy = vi.spyOn(model as any, 'saveStepParams').mockResolvedValue(undefined);
+
+    const flow = model.flowRegistry.addFlow('flow1', {
+      title: 'Flow 1',
+      steps: { s1: { title: 'S1' } as any },
+    });
+
+    await flow.save();
+    expect(saveStepParamsSpy).toHaveBeenCalledTimes(1);
+  });
+
+  test('destroyFlow removes flow and calls model.saveStepParams', async () => {
+    const model = createModel();
+    const saveStepParamsSpy = vi.spyOn(model as any, 'saveStepParams').mockResolvedValue(undefined);
+
+    const flow = model.flowRegistry.addFlow('toRemove', {
+      title: 'Remove me',
+      steps: {},
+    });
+    expect(model.flowRegistry.hasFlow('toRemove')).toBe(true);
+
+    await flow.destroy();
+    expect(saveStepParamsSpy).toHaveBeenCalledTimes(1);
+    expect(model.flowRegistry.hasFlow('toRemove')).toBe(false);
+  });
+
+  test('moveStep reorders steps and persists', async () => {
+    const model = createModel();
+    const saveStepParamsSpy = vi.spyOn(model as any, 'saveStepParams').mockResolvedValue(undefined);
+
+    const flow = model.flowRegistry.addFlow('reorder', {
+      title: 'Reorder',
+      steps: {
+        a: { title: 'A' } as any,
+        b: { title: 'B' } as any,
+        c: { title: 'C' } as any,
+      },
+    });
+
+    await model.flowRegistry.moveStep('reorder', 'c', 'b');
+
+    expect(saveStepParamsSpy).toHaveBeenCalledTimes(1);
+    // Ensure integer sorts in new order
+    expect(flow.getStep('a')?.serialize().sort).toBe(1);
+    expect(flow.getStep('c')?.serialize().sort).toBe(2);
+    expect(flow.getStep('b')?.serialize().sort).toBe(3);
+  });
+
+  test('getFlows returns Map and includes added flows', () => {
+    const model = createModel();
+    model.flowRegistry.addFlows({
+      x: { title: 'X', steps: {} },
+      y: { title: 'Y', steps: {} },
+    });
+
+    const flows = model.flowRegistry.getFlows();
+    expect(flows).toBeInstanceOf(Map);
+    expect(Array.from(flows.keys()).sort()).toEqual(['x', 'y']);
+  });
+});

package/src/flow-registry/index.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export * from './BaseFlowRegistry';
+export * from './InstanceFlowRegistry';
+export * from './GlobalFlowRegistry';