feat: add StartProcessByMessageAtElementCmd to process API#293
Open
emaarco wants to merge 2 commits into
Open
Conversation
Adds a new start command analogous to StartProcessByDefinitionAtElementCmd that starts a process at a specific element via a message name, for processes that have no plain (none) start event and are entered only via message start events. - new StartProcessByMessageAtElementCmd (messageName, elementId, payload, restrictions) with Java-friendly constructor overloads - document the new start variant in docs/process-api.md - add 'Start Process by message at' row to the README adapter feature matrix (C7 embedded/remote and CIB7 in development, C8 unsupported) plus an icon legend Refs #292
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #293 +/- ##
=============================================
+ Coverage 47.65% 49.67% +2.02%
- Complexity 72 80 +8
=============================================
Files 47 48 +1
Lines 447 467 +20
Branches 9 9
=============================================
+ Hits 213 232 +19
- Misses 229 230 +1
Partials 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Adds unit tests exercising all constructor overloads, payload delegation and restrictions, to satisfy codecov patch coverage on the new command. Refs #292
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
StartProcessByMessageAtElementCmdto the Process API — analogous to the existingStartProcessByDefinitionAtElementCmd, but it starts a process at a specific element via a message name instead of a definition key.This enables starting at a given element for processes that have no plain (none) start event and are entered only through one or multiple message start events — the use case described in #292.
Changes
api/.../process/StartProcessByMessageAtElementCmd.kt(messageName,elementId, payload, restrictions), with the same Java-friendly constructor overloads as its definition-based sibling. Tagged@since 1.7. No dispatch changes needed —StartProcessApi.startProcess(...)accepts it polymorphically.docs/process-api.md: intro now lists four start variants and includes astartByMessageAtActivity(...)example.Start Process by message atrow + an icon legend.Adapter support
The matrix marks the new feature 🚧 (in development) for C7 embedded, C7 remote and CIB7, and ❌ for C8.
C8/Zeebe is not technically supportable:
CreateProcessInstancewithstartInstructionsstarts by process definition id (not message), andPublishMessagehas nostartInstructions— the two cannot be combined, and there is no API to resolve a message name to its owning definition.Adapter implementations are tracked in separate tickets and are out of scope for this PR:
Docs delivery
The published docs site (
process-engine-api-docs) importsdocs/**/*.mdfrom this repo'sdevelopbranch at build time via the mkdocs-multirepo plugin, so no separate docs-repo PR is needed. The site rebuilds on its own push/tag (left to the release).Refs #292