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

package/src/server/actions.ts

@@ -0,0 +1,100 @@
+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.pm.get('workflow') as 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);
+  if (!assignees.includes(currentUser.id) || userJob.userId !== currentUser.id) {
+    return context.throw(403);
+  }
+  const presetValues = processor.getParsedValue(actionItem.values ?? {}, userJob.nodeId, {
+    // @deprecated
+    currentUser: currentUser.toJSON(),
+    // @deprecated
+    currentRecord: values.result[formKey],
+    // @deprecated
+    currentTime: new Date(),
+    $user: currentUser.toJSON(),
+    $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({ transaction: processor.transaction });
+
+  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/collecions/jobs.ts

@@ -0,0 +1,17 @@
+export default {
+  name: 'jobs',
+  fields: [
+    {
+      type: 'belongsToMany',
+      name: 'users',
+      through: 'users_jobs',
+    },
+    {
+      type: 'hasMany',
+      name: 'usersJobs',
+      target: 'users_jobs',
+      foreignKey: 'jobId',
+      onDelete: 'CASCADE',
+    },
+  ],
+};

package/src/server/collecions/users.ts

@@ -0,0 +1,15 @@
+export default {
+  name: 'users',
+  fields: [
+    {
+      type: 'belongsToMany',
+      name: 'jobs',
+      through: 'users_jobs',
+    },
+    {
+      type: 'hasMany',
+      name: 'usersJobs',
+      target: 'users_jobs',
+    },
+  ],
+};

package/src/server/collecions/users_jobs.ts

@@ -0,0 +1,50 @@
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  namespace: 'workflow.executionLogs',
+  name: 'users_jobs',
+  duplicator: 'optional',
+  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',
+    },
+  ],
+} as CollectionOptions;

package/src/server/forms/create.ts

@@ -0,0 +1,23 @@
+import { Processor } from '@nocobase/plugin-workflow';
+import ManualInstruction from '../ManualInstruction';
+
+export default async function (this: ManualInstruction, instance, { collection }, processor: Processor) {
+  const repo = this.plugin.db.getRepository(collection);
+  if (!repo) {
+    throw new Error(`collection ${collection} for create data on manual node not found`);
+  }
+
+  const { _, ...form } = instance.result;
+  const [values] = Object.values(form);
+  await repo.create({
+    values: {
+      ...((values as { [key: string]: any }) ?? {}),
+      createdBy: instance.userId,
+      updatedBy: instance.userId,
+    },
+    context: {
+      executionId: processor.execution.id,
+    },
+    transaction: processor.transaction,
+  });
+}

package/src/server/forms/index.ts

@@ -0,0 +1,13 @@
+import { Processor } from '@nocobase/plugin-workflow';
+
+import ManualInstruction from '../ManualInstruction';
+
+import create from './create';
+import update from './update';
+
+export type FormHandler = (this: ManualInstruction, instance, formConfig, processor: Processor) => Promise<void>;
+
+export default function ({ formTypes }) {
+  formTypes.register('create', create);
+  formTypes.register('update', update);
+}

package/src/server/forms/update.ts

@@ -0,0 +1,23 @@
+import { Processor } from '@nocobase/plugin-workflow';
+import ManualInstruction from '../ManualInstruction';
+
+export default async function (this: ManualInstruction, instance, { collection, filter = {} }, processor: Processor) {
+  const repo = this.plugin.db.getRepository(collection);
+  if (!repo) {
+    throw new Error(`collection ${collection} for update data on manual node not found`);
+  }
+
+  const { _, ...form } = instance.result;
+  const [values] = Object.values(form);
+  await repo.update({
+    filter: processor.getParsedValue(filter, instance.nodeId),
+    values: {
+      ...((values as { [key: string]: any }) ?? {}),
+      updatedBy: instance.userId,
+    },
+    context: {
+      executionId: processor.execution.id,
+    },
+    transaction: processor.transaction,
+  });
+}

package/src/server/index.ts

@@ -0,0 +1 @@
+export { default } from './Plugin';