@nocobase/plugin-workflow/dist/server/actions/nodes.js

A powerful BPM tool that provides foundational support for business automation, with the capability to extend unlimited triggers and nodes.

/**
 * 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.
 */

var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
  for (var name in all)
    __defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
  if (from && typeof from === "object" || typeof from === "function") {
    for (let key of __getOwnPropNames(from))
      if (!__hasOwnProp.call(to, key) && key !== except)
        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  }
  return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  // If the importer is in node compatibility mode or this is not an ESM
  // file that has been converted to a CommonJS file using a Babel-
  // compatible transform (i.e. "__esModule" has not been set), then set
  // "default" to the CommonJS "module.exports" for node compatibility.
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var nodes_exports = {};
__export(nodes_exports, {
  NodeValidationError: () => NodeValidationError,
  create: () => create,
  destroy: () => destroy,
  destroyBranch: () => destroyBranch,
  duplicate: () => duplicate,
  move: () => move,
  test: () => test,
  update: () => update
});
module.exports = __toCommonJS(nodes_exports);
var import_actions = require("@nocobase/actions");
var import_database = require("@nocobase/database");
var import__ = __toESM(require(".."));
class NodeValidationError extends Error {
  status = 400;
  errors;
  constructor(errors) {
    super("Node validation failed");
    this.name = "NodeValidationError";
    this.errors = errors;
  }
}
function validateNode(context, workflow, values) {
  const { type, config } = values;
  if (!type) {
    context.throw(400, "Node type is required");
  }
  const workflowPlugin = context.app.pm.get(import__.default);
  const instruction = workflowPlugin.instructions.get(type);
  if (!instruction) {
    context.throw(400, `Node type "${type}" is not registered`);
  }
  if (workflow && typeof instruction.isAvailable === "function" && !instruction.isAvailable(workflow, values)) {
    context.throw(400, `Node type "${type}" is not available in the current workflow`);
  }
  if (config && typeof instruction.validateConfig === "function") {
    const errors = instruction.validateConfig(config);
    if (errors) {
      throw new NodeValidationError(errors);
    }
  }
}
async function touchWorkflow(context, workflowId, transaction) {
  var _a, _b;
  const values = {
    updatedAt: /* @__PURE__ */ new Date()
  };
  const currentUserId = (_b = (_a = context.state) == null ? void 0 : _a.currentUser) == null ? void 0 : _b.id;
  if (currentUserId != null) {
    values.updatedById = currentUserId;
  }
  await context.db.getCollection("workflows").model.update(values, {
    where: {
      id: workflowId
    },
    transaction,
    hooks: false
  });
}
async function create(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { whitelist, blacklist, updateAssociationValues, values } = context.action.params;
  const workflowPlugin = context.app.pm.get(import__.default);
  context.body = await db.sequelize.transaction(async (transaction) => {
    const workflow = workflowPlugin.enabledCache.get(Number.parseInt(context.action.sourceId, 10)) || await repository.getSourceModel(transaction);
    if (!workflow.versionStats) {
      workflow.versionStats = await workflow.getVersionStats({ transaction });
    }
    if (workflow.versionStats.executed > 0) {
      context.throw(400, "Node could not be created in executed workflow");
    }
    validateNode(context, workflow, values);
    const NODES_LIMIT = process.env.WORKFLOW_NODES_LIMIT ? parseInt(process.env.WORKFLOW_NODES_LIMIT, 10) : null;
    if (NODES_LIMIT) {
      const nodesCount = await workflow.countNodes({ transaction });
      if (nodesCount >= NODES_LIMIT) {
        context.throw(400, `The number of nodes in a workflow cannot exceed ${NODES_LIMIT}`);
      }
    }
    const instance = await repository.create({
      values,
      whitelist,
      blacklist,
      updateAssociationValues,
      context,
      transaction
    });
    if (!instance.upstreamId) {
      const previousHead = await repository.findOne({
        filter: {
          id: {
            $ne: instance.id
          },
          upstreamId: null
        },
        transaction
      });
      if (previousHead) {
        await previousHead.setUpstream(instance, { transaction });
        await instance.setDownstream(previousHead, { transaction });
        instance.set("downstream", previousHead);
      }
      await touchWorkflow(context, workflow.id, transaction);
      return instance;
    }
    const upstream = await instance.getUpstream({ transaction });
    if (instance.branchIndex == null) {
      const downstream = await upstream.getDownstream({ transaction });
      if (downstream) {
        await downstream.setUpstream(instance, { transaction });
        await instance.setDownstream(downstream, { transaction });
        instance.set("downstream", downstream);
      }
      await upstream.update(
        {
          downstreamId: instance.id
        },
        { transaction }
      );
      upstream.set("downstream", instance);
    } else {
      const [downstream] = await upstream.getBranches({
        where: {
          id: {
            [import_database.Op.ne]: instance.id
          },
          branchIndex: instance.branchIndex
        },
        transaction
      });
      if (downstream) {
        await downstream.update(
          {
            upstreamId: instance.id,
            branchIndex: null
          },
          { transaction }
        );
        await instance.setDownstream(downstream, { transaction });
        instance.set("downstream", downstream);
      }
    }
    instance.set("upstream", upstream);
    await touchWorkflow(context, workflow.id, transaction);
    return instance;
  });
  await next();
}
async function duplicate(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { whitelist, blacklist, filterByTk, values = {} } = context.action.params;
  const workflowPlugin = context.app.pm.get(import__.default);
  context.body = await db.sequelize.transaction(async (transaction) => {
    const origin = filterByTk ? await repository.findOne({ filterByTk, transaction }) : null;
    if (!origin) {
      return context.throw(404, "Node not found");
    }
    const workflow = workflowPlugin.enabledCache.get(origin.workflowId) || await db.getRepository("workflows").findOne({
      filterByTk: origin.workflowId,
      transaction
    });
    if (!workflow) {
      return context.throw(400, "Workflow not found");
    }
    if (!workflow.versionStats) {
      workflow.versionStats = await workflow.getVersionStats({ transaction });
    }
    if (workflow.versionStats.executed > 0) {
      context.throw(400, "Node could not be created in executed workflow");
    }
    const NODES_LIMIT = process.env.WORKFLOW_NODES_LIMIT ? parseInt(process.env.WORKFLOW_NODES_LIMIT, 10) : null;
    if (NODES_LIMIT) {
      const nodesCount = await workflow.countNodes({ transaction });
      if (nodesCount >= NODES_LIMIT) {
        context.throw(400, `The number of nodes in a workflow cannot exceed ${NODES_LIMIT}`);
      }
    }
    let nextConfig = values.config;
    if (!nextConfig) {
      const instruction = workflowPlugin.instructions.get(origin.type);
      if (instruction && typeof instruction.duplicateConfig === "function") {
        nextConfig = await instruction.duplicateConfig(origin, { origin: origin ?? void 0, transaction });
      }
    }
    const instance = await repository.create({
      values: {
        config: nextConfig ?? origin.config,
        upstreamId: values.upstreamId,
        branchIndex: values.branchIndex,
        type: origin.type,
        title: origin.title,
        workflowId: origin.workflowId
      },
      whitelist,
      blacklist,
      context,
      transaction
    });
    if (!instance.upstreamId) {
      const previousHead = await repository.findOne({
        filter: {
          id: {
            $ne: instance.id
          },
          workflowId: origin.workflowId,
          upstreamId: null
        },
        transaction
      });
      if (previousHead) {
        await previousHead.setUpstream(instance, { transaction });
        await instance.setDownstream(previousHead, { transaction });
        instance.set("downstream", previousHead);
      }
      await touchWorkflow(context, origin.workflowId, transaction);
      return instance;
    }
    const upstream = await instance.getUpstream({ transaction });
    if (instance.branchIndex == null) {
      const downstream = await upstream.getDownstream({ transaction });
      if (downstream) {
        await downstream.setUpstream(instance, { transaction });
        await instance.setDownstream(downstream, { transaction });
        instance.set("downstream", downstream);
      }
      await upstream.update(
        {
          downstreamId: instance.id
        },
        { transaction }
      );
      upstream.set("downstream", instance);
    } else {
      const [downstream] = await upstream.getBranches({
        where: {
          id: {
            [import_database.Op.ne]: instance.id
          },
          branchIndex: instance.branchIndex
        },
        transaction
      });
      if (downstream) {
        await downstream.update(
          {
            upstreamId: instance.id,
            branchIndex: null
          },
          { transaction }
        );
        await instance.setDownstream(downstream, { transaction });
        instance.set("downstream", downstream);
      }
    }
    instance.set("upstream", upstream);
    await touchWorkflow(context, origin.workflowId, transaction);
    return instance;
  });
  await next();
}
function searchBranchNodes(nodes, from) {
  const branchHeads = nodes.filter((item) => item.upstreamId === from.id && item.branchIndex != null);
  return branchHeads.reduce(
    (flatten, head) => flatten.concat(searchBranchDownstreams(nodes, head)),
    []
  );
}
function searchBranchDownstreams(nodes, from) {
  let result = [];
  for (let search = from; search; search = search.downstream) {
    result = [...result, search, ...searchBranchNodes(nodes, search)];
  }
  return result;
}
function findBranchTail(branchHead) {
  let tail = branchHead;
  while (tail.downstream) {
    tail = tail.downstream;
  }
  return tail;
}
async function destroy(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { filterByTk, keepBranch } = context.action.params;
  const keepBranchIndex = keepBranch == null || keepBranch === "" ? null : Number.parseInt(keepBranch, 10);
  const fields = ["id", "upstreamId", "downstreamId", "branchIndex", "key"];
  const instance = await repository.findOne({
    filterByTk,
    fields: [...fields, "workflowId"],
    appends: ["upstream", "downstream", "workflow.versionStats.executed"]
  });
  if (!instance) {
    context.throw(404, "Node not found");
  }
  if (instance.workflow.versionStats.executed > 0) {
    context.throw(400, "Nodes in executed workflow could not be deleted");
  }
  await db.sequelize.transaction(async (transaction) => {
    const { upstream, downstream } = instance.get();
    const nodes = await repository.find({
      filter: {
        workflowId: instance.workflowId
      },
      fields,
      transaction
    });
    const nodesMap = /* @__PURE__ */ new Map();
    nodes.forEach((item) => {
      nodesMap.set(item.id, item);
    });
    nodes.forEach((item) => {
      if (item.upstreamId) {
        item.upstream = nodesMap.get(item.upstreamId);
      }
      if (item.downstreamId) {
        item.downstream = nodesMap.get(item.downstreamId);
      }
    });
    const keepBranchHead = keepBranchIndex != null ? nodes.find((item) => item.upstreamId === instance.id && item.branchIndex == keepBranchIndex) : null;
    if (keepBranchIndex != null && !keepBranchHead) {
      context.throw(400, `Branch ${keepBranchIndex} not found`);
    }
    const keepBranchNodes = keepBranchHead ? searchBranchDownstreams(nodes, keepBranchHead) : [];
    const keepBranchNodeIds = new Set(keepBranchNodes.map((item) => item.id));
    const branchNodes = instance ? searchBranchNodes(nodes, instance) : [];
    const branchNodesToDelete = keepBranchHead ? branchNodes.filter((item) => !keepBranchNodeIds.has(item.id)) : branchNodes;
    if (keepBranchHead) {
      if (upstream && upstream.downstreamId === instance.id) {
        await upstream.update(
          {
            downstreamId: keepBranchHead.id
          },
          { transaction }
        );
      }
      await keepBranchHead.update(
        {
          upstreamId: instance.upstreamId,
          branchIndex: instance.branchIndex
        },
        { transaction }
      );
      if (downstream) {
        const branchTail = findBranchTail(keepBranchHead);
        await branchTail.update(
          {
            downstreamId: instance.downstreamId
          },
          { transaction }
        );
        branchTail.downstreamId = instance.downstreamId;
        branchTail.downstream = downstream;
        await downstream.update(
          {
            upstreamId: branchTail.id,
            branchIndex: null
          },
          { transaction }
        );
      }
    } else {
      if (upstream && upstream.downstreamId === instance.id) {
        await upstream.update(
          {
            downstreamId: instance.downstreamId
          },
          { transaction }
        );
      }
      if (downstream) {
        await downstream.update(
          {
            upstreamId: instance.upstreamId,
            branchIndex: instance.branchIndex
          },
          { transaction }
        );
      }
    }
    await repository.destroy({
      filterByTk: [instance.id, ...branchNodesToDelete.map((item) => item.id)],
      transaction
    });
    await touchWorkflow(context, instance.workflowId, transaction);
  });
  context.body = instance;
  await next();
}
async function destroyBranch(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { filterByTk, branchIndex: branchIndexParam, shift: shiftParam } = context.action.params;
  if (branchIndexParam == null || branchIndexParam === "") {
    context.throw(400, "branchIndex is required");
  }
  const branchIndex = Number.parseInt(branchIndexParam, 10);
  if (Number.isNaN(branchIndex)) {
    context.throw(400, "branchIndex must be a number");
  }
  const shift = !(shiftParam == null || shiftParam === "") && Number.parseInt(String(shiftParam), 10) === 1;
  const fields = ["id", "upstreamId", "downstreamId", "branchIndex", "key"];
  const instance = await repository.findOne({
    filterByTk,
    fields: [...fields, "workflowId"],
    appends: ["workflow.versionStats.executed"]
  });
  if (!instance) {
    context.throw(404, "Node not found");
  }
  if (instance.workflow.versionStats.executed > 0) {
    context.throw(400, "Branches in executed workflow could not be deleted");
  }
  let deletedBranchHead = null;
  await db.sequelize.transaction(async (transaction) => {
    let shouldTouchWorkflow = false;
    const nodes = await repository.find({
      filter: {
        workflowId: instance.workflowId
      },
      fields,
      transaction
    });
    const nodesMap = /* @__PURE__ */ new Map();
    nodes.forEach((item) => {
      nodesMap.set(item.id, item);
    });
    nodes.forEach((item) => {
      if (item.upstreamId) {
        item.upstream = nodesMap.get(item.upstreamId);
      }
      if (item.downstreamId) {
        item.downstream = nodesMap.get(item.downstreamId);
      }
    });
    const branchHeads = nodes.filter((item) => item.upstreamId === instance.id && item.branchIndex != null).sort((a, b) => a.branchIndex - b.branchIndex);
    const branchHead = branchHeads.find((item) => item.branchIndex === branchIndex);
    deletedBranchHead = branchHead || null;
    if (branchHead) {
      const nodesToDelete = searchBranchDownstreams(nodes, branchHead);
      const idsToDelete = nodesToDelete.map((item) => item.id);
      if (idsToDelete.length) {
        await repository.destroy({
          filterByTk: idsToDelete,
          transaction
        });
        shouldTouchWorkflow = true;
      }
    }
    if (shift) {
      const headsToShift = branchHeads.filter((item) => item.branchIndex > branchIndex);
      await Promise.all(
        headsToShift.map(
          (item) => item.update(
            {
              branchIndex: item.branchIndex - 1
            },
            { transaction }
          )
        )
      );
      if (headsToShift.length) {
        shouldTouchWorkflow = true;
      }
    }
    if (shouldTouchWorkflow) {
      await touchWorkflow(context, instance.workflowId, transaction);
    }
  });
  context.body = deletedBranchHead;
  await next();
}
async function move(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { filterByTk, values = {} } = context.action.params;
  const rawUpstreamId = values.upstreamId;
  const rawBranchIndex = values.branchIndex;
  const upstreamId = rawUpstreamId == null || rawUpstreamId === "" ? null : rawUpstreamId;
  let branchIndex = rawBranchIndex == null || rawBranchIndex === "" ? null : Number.parseInt(rawBranchIndex, 10);
  if (rawBranchIndex != null && rawBranchIndex !== "" && Number.isNaN(branchIndex)) {
    context.throw(400, "branchIndex must be a number");
  }
  if (upstreamId == null) {
    branchIndex = null;
  }
  const fields = ["id", "key", "upstreamId", "downstreamId", "branchIndex", "workflowId"];
  context.body = await db.sequelize.transaction(async (transaction) => {
    const instance = await repository.findOne({
      filterByTk,
      fields,
      appends: ["upstream", "downstream", "workflow.versionStats"],
      transaction
    });
    if (!instance) {
      context.throw(404, "Node not found");
    }
    if (instance.workflow.versionStats.executed > 0) {
      context.throw(400, "Nodes in executed workflow could not be moved");
    }
    if (upstreamId != null && String(upstreamId) === String(instance.id)) {
      context.throw(400, "Invalid upstream node");
    }
    const sameUpstream = (instance.upstreamId ?? null) == (upstreamId ?? null);
    const sameBranchIndex = (instance.branchIndex ?? null) == (branchIndex ?? null);
    if (sameUpstream && sameBranchIndex) {
      context.throw(400, "Node does not need to be moved");
    }
    const { upstream: oldUpstream, downstream: oldDownstream } = instance.get();
    if (oldUpstream && oldUpstream.downstreamId === instance.id) {
      await oldUpstream.update(
        {
          downstreamId: oldDownstream ? oldDownstream.id : null
        },
        { transaction }
      );
    }
    if (oldDownstream && oldDownstream.upstreamId === instance.id) {
      await oldDownstream.update(
        {
          upstreamId: oldUpstream ? oldUpstream.id : null,
          branchIndex: instance.branchIndex ?? null
        },
        { transaction }
      );
    }
    let targetUpstream = null;
    if (upstreamId != null) {
      targetUpstream = await repository.findOne({
        filterByTk: upstreamId,
        fields,
        transaction
      });
      if (!targetUpstream) {
        context.throw(404, "Upstream node not found");
      }
      if (targetUpstream.workflowId !== instance.workflowId) {
        context.throw(400, "Upstream node is not in the same workflow");
      }
    }
    let newDownstream = null;
    if (!targetUpstream) {
      const previousHead = await repository.findOne({
        filter: {
          workflowId: instance.workflowId,
          upstreamId: null,
          id: {
            [import_database.Op.ne]: instance.id
          }
        },
        fields,
        transaction
      });
      if (previousHead) {
        await previousHead.update(
          {
            upstreamId: instance.id,
            branchIndex: null
          },
          { transaction }
        );
        newDownstream = previousHead;
      }
      await instance.update(
        {
          upstreamId: null,
          branchIndex: null,
          downstreamId: newDownstream ? newDownstream.id : null
        },
        { transaction }
      );
      await touchWorkflow(context, instance.workflowId, transaction);
      return instance;
    }
    if (branchIndex == null) {
      if (targetUpstream.downstreamId) {
        newDownstream = await repository.findOne({
          filterByTk: targetUpstream.downstreamId,
          fields,
          transaction
        });
      }
      if (newDownstream) {
        await newDownstream.update(
          {
            upstreamId: instance.id,
            branchIndex: null
          },
          { transaction }
        );
      }
      await targetUpstream.update(
        {
          downstreamId: instance.id
        },
        { transaction }
      );
      await instance.update(
        {
          upstreamId: targetUpstream.id,
          branchIndex: null,
          downstreamId: newDownstream ? newDownstream.id : null
        },
        { transaction }
      );
      await touchWorkflow(context, instance.workflowId, transaction);
      return instance;
    }
    const branchHead = await repository.findOne({
      filter: {
        upstreamId: targetUpstream.id,
        branchIndex
      },
      fields,
      transaction
    });
    if (branchHead) {
      await branchHead.update(
        {
          upstreamId: instance.id,
          branchIndex: null
        },
        { transaction }
      );
      newDownstream = branchHead;
    }
    await instance.update(
      {
        upstreamId: targetUpstream.id,
        branchIndex,
        downstreamId: newDownstream ? newDownstream.id : null
      },
      { transaction }
    );
    await touchWorkflow(context, instance.workflowId, transaction);
    return instance;
  });
  await next();
}
async function update(context, next) {
  const { db } = context;
  const repository = import_actions.utils.getRepositoryFromParams(context);
  const { filterByTk, values, whitelist, blacklist, filter, updateAssociationValues } = context.action.params;
  const workflowPlugin = context.app.pm.get(import__.default);
  context.body = await db.sequelize.transaction(async (transaction) => {
    const instance = await repository.findOne({
      filterByTk,
      appends: ["workflow.versionStats.executed"],
      transaction
    });
    if (instance.workflow.versionStats.executed > 0) {
      context.throw(400, "Nodes in executed workflow could not be reconfigured");
    }
    const merged = Object.assign({}, instance.get(), values);
    validateNode(context, null, merged);
    const result = await repository.update({
      filterByTk,
      values,
      whitelist,
      blacklist,
      filter,
      updateAssociationValues,
      context,
      transaction
    });
    await touchWorkflow(context, instance.workflowId, transaction);
    return result;
  });
  await next();
}
async function test(context, next) {
  const { values = {} } = context.action.params;
  const { type, config = {} } = values;
  const plugin = context.app.pm.get(import__.default);
  const instruction = plugin.instructions.get(type);
  if (typeof instruction.test !== "function") {
    context.throw(400, `test method of instruction "${type}" not implemented`);
  }
  validateNode(context, null, values);
  try {
    context.body = await instruction.test(config);
  } catch (error) {
    context.throw(500, error.message);
  }
  next();
}
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
  NodeValidationError,
  create,
  destroy,
  destroyBranch,
  duplicate,
  move,
  test,
  update
});