Skip to content

v0.4.0

Choose a tag to compare

@sfmskywalker sfmskywalker released this 21 Oct 20:06
d631ff7

Minor release from main (d631ff7). Released on Sipke's instruction. 0.4.0 contains breaking changes in graph building and routing; read Breaking changes before upgrading a host.

New

  • Host-evaluated conditions (#71, ADR 0011). Hosts answer expression-only sequence-flow conditions through IBpmnConditionEvaluator on BpmnHostSnapshot.Conditions, gated by the new BpmnHostCapabilities.ConditionEvaluation (not in Full). Each answer is recorded as a ConditionEvaluated diagnostic.
  • Coded BPMN errors (#72, ADR 0012).
    • Error catchers match by code: an exact match wins over the catch-all.
    • Hosts name the error on BpmnWorkFaultedRequest.ErrorCode, or on BpmnWorkCompletedRequest.ErrorCode with a call activity's Faulted outcome. The code survives on BpmnContinuation.Fault.ErrorCode when nothing catches it.
    • Error end events throw. An uncaught throw faults the scope with bpmn.error.thrown.
    • New diagnostics: ErrorThrown and ErrorCaught.
  • Condition expressions in the model (#68). BpmnSequenceFlow.ConditionExpression (BpmnConditionExpression) and the document's ExpressionLanguage are modeled and round-trip.
  • Error codes in interchange (#70). An errorRef resolves to the referenced <error>'s errorCode, or to its id when it has none. Error end events and errorRefs survive a round trip.
  • Concurrent work disambiguation (#60, ADR 0010). Hosts can echo StartWork.TokenId as WorkTokenId, so concurrent work that shares one binding is told apart. Additive: hosts that send no ID keep working wherever the slot is unambiguous.
  • Error routing on the common evaluation (#48): a public error disposition and transcript.
  • Public escalation payload contract (#43).
  • Work-binding JSON and schema contracts (#51).
  • Single-process XML writer overload (#50).
  • Timer-start schedule choices validated at graph build (#57).

Breaking changes

  • Cycles (#39). BpmnGraph.Build refuses a cycle on which nothing can hold a token, which previously hung the host. An evaluation that dispatches 10,000 tokens without coming to rest faults with bpmn.propagation.limit.
  • Faulted units (#42). A faulted unit is found by its binding and iteration, never by the enclosing scope's token.
  • Conditions (#71):
    • An exclusive gateway's unconditional flow counts as true, in declaration order.
    • An element that takes no flow on arrival faults with bpmn.flow.none-taken, including an unbound task. The exception is an escalation throw caught by an interrupting event subprocess of its own scope.
    • A Failed answer from the evaluator faults the scope.
    • An expression on a flow out of a start event, a parallel gateway or an event-based gateway is refused at graph build.
    • The reader no longer reports expression conditions as Degraded.
    • A default flow marked only by the element's default reference is no longer also taken as an unconditional flow.
  • Errors (#72):
    • Coded catchers no longer catch uncoded or differently coded faults.
    • DispatchFailed and Cancelled reach only catch-alls.
    • The reference host reports a called process's fault as a Faulted completion.
    • The code-less error lookups are obsolete and return only the catch-all.

Payload format

The format goes from 1.1.0 (0.3.1) to 1.5.0:

  • 1.2.0 adds the binding root union.
  • 1.3.0 adds optional condition-expression properties.
  • 1.4.0 adds the ConditionEvaluated diagnostic.
  • 1.5.0 adds the ErrorThrown and ErrorCaught diagnostics.

Older payloads read as before. A strict validator (additionalProperties: false) needs the regenerated schema.

Includes

All 0.3.1 fixes (#41, #44, #45).