bpmnlint/rules/no-implicit-end.js

Validate your BPMN diagrams based on configurable lint rules

const {
  is,
  isAny
} = require('bpmnlint-utils');

const {
  findParent,
  annotateRule
} = require('./helper');


/**
 * A rule that checks that an element is not an implicit end (token sink).
 *
 * @type { import('../lib/types.js').RuleFactory }
 */
module.exports = function() {

  function isLinkEvent(node) {
    const eventDefinitions = node.eventDefinitions || [];

    return eventDefinitions.length && eventDefinitions.every(
      definition => is(definition, 'bpmn:LinkEventDefinition')
    );
  }

  function isCompensationEvent(node) {
    const eventDefinitions = node.eventDefinitions || [];

    return eventDefinitions.length && eventDefinitions.every(
      definition => is(definition, 'bpmn:CompensateEventDefinition')
    );
  }

  function hasCompensationActivity(node) {
    const parent = findParent(node, 'bpmn:Process');

    const artifacts = parent.artifacts || [];

    return artifacts.some((element) => {
      if (!is(element, 'bpmn:Association')) {
        return false;
      }

      const source = element.sourceRef;

      return source.id === node.id;
    });
  }

  function isForCompensation(node) {
    return node.isForCompensation;
  }

  function isImplicitEnd(node) {
    const outgoing = node.outgoing || [];

    if (is(node, 'bpmn:SubProcess') && node.triggeredByEvent) {
      return false;
    }

    if (is(node, 'bpmn:IntermediateThrowEvent') && isLinkEvent(node)) {
      return false;
    }

    if (is(node.$parent, 'bpmn:AdHocSubProcess')) {
      return false;
    }

    if (is(node, 'bpmn:EndEvent')) {
      return false;
    }

    if (is(node, 'bpmn:BoundaryEvent') && isCompensationEvent(node) && hasCompensationActivity(node)) {
      return false;
    }

    if (is(node, 'bpmn:Task') && isForCompensation(node)) {
      return false;
    }

    return outgoing.length === 0;
  }

  function check(node, reporter) {

    if (!isAny(node, [ 'bpmn:Event', 'bpmn:Activity', 'bpmn:Gateway' ])) {
      return;
    }

    if (isImplicitEnd(node)) {
      reporter.report(node.id, 'Element is an implicit end');
    }
  }

  return annotateRule('no-implicit-end', {
    check
  });
};