@nocobase/plugin-workflow-manual 1.0.0-alpha.2 → 1.0.0-alpha.4

package/src/server/__tests__/mode.test.ts

@@ -1,561 +0,0 @@
-import Database from '@nocobase/database';
-import { EXECUTION_STATUS, JOB_STATUS } from '@nocobase/plugin-workflow';
-import { getApp, sleep } from '@nocobase/plugin-workflow-test';
-import { MockServer } from '@nocobase/test';
-
-// NOTE: skipped because time is not stable on github ci, but should work in local
-describe('workflow > instructions > manual', () => {
-  let app: MockServer;
-  let agent;
-  let userAgents;
-  let db: Database;
-  let PostRepo;
-  let CommentRepo;
-  let WorkflowModel;
-  let workflow;
-  let UserModel;
-  let users;
-  let UserJobModel;
-
-  beforeEach(async () => {
-    app = await getApp({
-      plugins: ['users', 'auth', 'workflow-manual'],
-    });
-    // await app.getPlugin('auth').install();
-    agent = app.agent();
-    db = app.db;
-    WorkflowModel = db.getCollection('workflows').model;
-    PostRepo = db.getCollection('posts').repository;
-    CommentRepo = db.getCollection('comments').repository;
-    UserModel = db.getCollection('users').model;
-    UserJobModel = db.getModel('users_jobs');
-
-    users = await UserModel.bulkCreate([
-      { id: 2, nickname: 'a' },
-      { id: 3, nickname: 'b' },
-    ]);
-
-    userAgents = users.map((user) => app.agent().login(user));
-
-    workflow = await WorkflowModel.create({
-      enabled: true,
-      type: 'collection',
-      config: {
-        mode: 1,
-        collection: 'posts',
-      },
-    });
-  });
-
-  afterEach(() => app.destroy());
-
-  describe('mode: 0 (single record)', () => {
-    it('the only user assigned could submit', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id],
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.RESOLVED, key: 'resolve' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [pending] = await workflow.getExecutions();
-      expect(pending.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await pending.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-
-      const usersJobs = await UserJobModel.findAll();
-      expect(usersJobs.length).toBe(1);
-      expect(usersJobs[0].status).toBe(JOB_STATUS.PENDING);
-      expect(usersJobs[0].userId).toBe(users[0].id);
-      expect(usersJobs[0].jobId).toBe(j1.id);
-
-      const res1 = await agent.resource('users_jobs').submit({
-        filterByTk: usersJobs[0].id,
-        values: { result: { f1: {}, _: 'resolve' } },
-      });
-      expect(res1.status).toBe(401);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: usersJobs[0].id,
-        values: {
-          result: { f1: {}, _: 'resolve' },
-        },
-      });
-      expect(res2.status).toBe(403);
-
-      const res3 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: usersJobs[0].id,
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res3.status).toBe(202);
-
-      await sleep(1000);
-
-      const [j2] = await pending.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.RESOLVED);
-      expect(j2.result).toEqual({ f1: { a: 1 }, _: 'resolve' });
-
-      const usersJobsAfter = await UserJobModel.findAll();
-      expect(usersJobsAfter.length).toBe(1);
-      expect(usersJobsAfter[0].status).toBe(JOB_STATUS.RESOLVED);
-      expect(usersJobsAfter[0].result).toEqual({ f1: { a: 1 }, _: 'resolve' });
-
-      const res4 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: usersJobs[0].id,
-        values: {
-          result: { f1: { a: 2 }, _: 'resolve' },
-        },
-      });
-      expect(res4.status).toBe(400);
-    });
-
-    it('any user assigned could submit', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.RESOLVED, key: 'resolve' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [pending] = await workflow.getExecutions();
-      expect(pending.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await pending.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-
-      const usersJobs = await j1.getUsersJobs();
-
-      const res1 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: usersJobs.find((item) => item.userId === users[1].id).id,
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [j2] = await pending.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.RESOLVED);
-      expect(j2.result).toEqual({ f1: { a: 1 }, _: 'resolve' });
-
-      const res2 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: usersJobs.find((item) => item.userId === users[0].id).id,
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res2.status).toBe(400);
-    });
-
-    it('also could submit to users_jobs api', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id],
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.RESOLVED, key: 'resolve' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const usersJobs = await UserJobModel.findAll();
-      expect(usersJobs.length).toBe(1);
-      expect(usersJobs[0].get('status')).toBe(JOB_STATUS.PENDING);
-      expect(usersJobs[0].get('userId')).toBe(users[0].id);
-
-      const res = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: usersJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res.status).toBe(202);
-
-      await sleep(1000);
-
-      const [execution] = await workflow.getExecutions();
-      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [job] = await execution.getJobs();
-      expect(job.status).toBe(JOB_STATUS.RESOLVED);
-      expect(job.result).toEqual({ f1: { a: 1 }, _: 'resolve' });
-    });
-  });
-
-  describe('mode: 1 (multiple record, all)', () => {
-    it('all resolved', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: 1,
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.RESOLVED, key: 'resolve' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-      expect(j1.result).toBe(0.5);
-      const usersJobs1 = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(usersJobs1.length).toBe(2);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 2 }, _: 'resolve' },
-        },
-      });
-      expect(res2.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e2] = await workflow.getExecutions();
-      expect(e2.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [j2] = await e2.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.RESOLVED);
-      expect(j2.result).toBe(1);
-    });
-
-    it('first rejected', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: 1,
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.REJECTED, key: 'reject' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.REJECTED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.REJECTED);
-      expect(j1.result).toBe(0.5);
-      const usersJobs1 = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(usersJobs1.length).toBe(2);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res2.status).toBe(400);
-    });
-
-    it('last rejected', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: 1,
-          forms: {
-            f1: {
-              actions: [
-                { status: JOB_STATUS.RESOLVED, key: 'resolve' },
-                { status: JOB_STATUS.REJECTED, key: 'reject' },
-              ],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-      expect(j1.result).toBe(0.5);
-      const usersJobs1 = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(usersJobs1.length).toBe(2);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res2.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e2] = await workflow.getExecutions();
-      expect(e2.status).toBe(EXECUTION_STATUS.REJECTED);
-      const [j2] = await e2.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.REJECTED);
-      expect(j2.result).toBe(1);
-    });
-  });
-
-  describe('mode: -1 (multiple record, any)', () => {
-    it('first resolved', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: -1,
-          forms: {
-            f1: {
-              actions: [
-                { status: JOB_STATUS.RESOLVED, key: 'resolve' },
-                { status: JOB_STATUS.REJECTED, key: 'reject' },
-              ],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.RESOLVED);
-      expect(j1.result).toBe(0.5);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res2.status).toBe(400);
-    });
-
-    it('any resolved', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: -1,
-          forms: {
-            f1: {
-              actions: [
-                { status: JOB_STATUS.RESOLVED, key: 'resolve' },
-                { status: JOB_STATUS.REJECTED, key: 'reject' },
-              ],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-      expect(j1.result).toBe(0.5);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 1 }, _: 'resolve' },
-        },
-      });
-      expect(res2.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e2] = await workflow.getExecutions();
-      expect(e2.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [j2] = await e2.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.RESOLVED);
-      expect(j2.result).toBe(1);
-    });
-
-    it('all rejected', async () => {
-      const n1 = await workflow.createNode({
-        type: 'manual',
-        config: {
-          assignees: [users[0].id, users[1].id],
-          mode: -1,
-          forms: {
-            f1: {
-              actions: [{ status: JOB_STATUS.REJECTED, key: 'reject' }],
-            },
-          },
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const UserJobModel = db.getModel('users_jobs');
-      const pendingJobs = await UserJobModel.findAll({
-        order: [['userId', 'ASC']],
-      });
-      expect(pendingJobs.length).toBe(2);
-
-      const res1 = await userAgents[0].resource('users_jobs').submit({
-        filterByTk: pendingJobs[0].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res1.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e1] = await workflow.getExecutions();
-      expect(e1.status).toBe(EXECUTION_STATUS.STARTED);
-      const [j1] = await e1.getJobs();
-      expect(j1.status).toBe(JOB_STATUS.PENDING);
-      expect(j1.result).toBe(0.5);
-
-      const res2 = await userAgents[1].resource('users_jobs').submit({
-        filterByTk: pendingJobs[1].get('id'),
-        values: {
-          result: { f1: { a: 0 }, _: 'reject' },
-        },
-      });
-      expect(res2.status).toBe(202);
-
-      await sleep(1000);
-
-      const [e2] = await workflow.getExecutions();
-      expect(e2.status).toBe(EXECUTION_STATUS.REJECTED);
-      const [j2] = await e2.getJobs();
-      expect(j2.status).toBe(JOB_STATUS.REJECTED);
-      expect(j2.result).toBe(1);
-    });
-  });
-});

package/src/server/actions.ts

@@ -1,103 +0,0 @@
-import { Context, utils } from '@nocobase/actions';
-import WorkflowPlugin, { EXECUTION_STATUS, JOB_STATUS } from '@nocobase/plugin-workflow';
-
-import ManualInstruction from './ManualInstruction';
-
-export async function submit(context: Context, next) {
-  const repository = utils.getRepositoryFromParams(context);
-  const { filterByTk, values } = context.action.params;
-  const { currentUser } = context.state;
-
-  if (!currentUser) {
-    return context.throw(401);
-  }
-
-  const plugin: WorkflowPlugin = context.app.getPlugin(WorkflowPlugin);
-  const instruction = plugin.instructions.get('manual') as ManualInstruction;
-
-  const userJob = await repository.findOne({
-    filterByTk,
-    // filter: {
-    //   userId: currentUser?.id
-    // },
-    appends: ['job', 'node', 'execution', 'workflow'],
-    context,
-  });
-
-  if (!userJob) {
-    return context.throw(404);
-  }
-
-  const { forms = {} } = userJob.node.config;
-  const [formKey] = Object.keys(values.result ?? {}).filter((key) => key !== '_');
-  const actionKey = values.result?._;
-
-  const actionItem = forms[formKey]?.actions?.find((item) => item.key === actionKey);
-  // NOTE: validate status
-  if (
-    userJob.status !== JOB_STATUS.PENDING ||
-    userJob.job.status !== JOB_STATUS.PENDING ||
-    userJob.execution.status !== EXECUTION_STATUS.STARTED ||
-    !userJob.workflow.enabled ||
-    !actionKey ||
-    actionItem?.status == null
-  ) {
-    return context.throw(400);
-  }
-
-  userJob.execution.workflow = userJob.workflow;
-  const processor = plugin.createProcessor(userJob.execution);
-  await processor.prepare();
-
-  // NOTE: validate assignee
-  const assignees = processor
-    .getParsedValue(userJob.node.config.assignees ?? [], userJob.nodeId)
-    .flat()
-    .filter(Boolean);
-  if (!assignees.includes(currentUser.id) || userJob.userId !== currentUser.id) {
-    return context.throw(403);
-  }
-  const presetValues = processor.getParsedValue(actionItem.values ?? {}, userJob.nodeId, {
-    // @deprecated
-    currentUser: currentUser,
-    // @deprecated
-    currentRecord: values.result[formKey],
-    // @deprecated
-    currentTime: new Date(),
-    $user: currentUser,
-    $nForm: values.result[formKey],
-    $nDate: {
-      now: new Date(),
-    },
-  });
-
-  userJob.set({
-    status: actionItem.status,
-    result:
-      actionItem.status > JOB_STATUS.PENDING
-        ? { [formKey]: Object.assign(values.result[formKey], presetValues), _: actionKey }
-        : Object.assign(userJob.result ?? {}, values.result),
-  });
-
-  const handler = instruction.formTypes.get(forms[formKey].type);
-  if (handler && userJob.status) {
-    await handler.call(instruction, userJob, forms[formKey], processor);
-  }
-
-  await userJob.save();
-
-  await processor.exit();
-
-  context.body = userJob;
-  context.status = 202;
-
-  await next();
-
-  userJob.job.execution = userJob.execution;
-  userJob.job.latestUserJob = userJob;
-
-  // NOTE: resume the process and no `await` for quick returning
-  processor.logger.info(`manual node (${userJob.nodeId}) action trigger execution (${userJob.execution.id}) to resume`);
-
-  plugin.resume(userJob.job);
-}

package/src/server/collections/1-users_jobs.ts

@@ -1,52 +0,0 @@
-import { defineCollection } from '@nocobase/database';
-
-export default defineCollection({
-  name: 'users_jobs',
-  dumpRules: {
-    group: 'log',
-  },
-  shared: true,
-  fields: [
-    {
-      type: 'bigInt',
-      name: 'id',
-      primaryKey: true,
-      autoIncrement: true,
-    },
-    {
-      type: 'belongsTo',
-      name: 'job',
-      target: 'jobs',
-      foreignKey: 'jobId',
-      primaryKey: false,
-    },
-    {
-      type: 'belongsTo',
-      name: 'user',
-      target: 'users',
-      foreignKey: 'userId',
-      primaryKey: false,
-    },
-    {
-      type: 'belongsTo',
-      name: 'execution',
-    },
-    {
-      type: 'belongsTo',
-      name: 'node',
-      target: 'flow_nodes',
-    },
-    {
-      type: 'belongsTo',
-      name: 'workflow',
-    },
-    {
-      type: 'integer',
-      name: 'status',
-    },
-    {
-      type: 'jsonb',
-      name: 'result',
-    },
-  ],
-});