Skip to content

Support cancel execution listener rules and start event forms rules#156

Merged
barmac merged 5 commits into
mainfrom
cancel-execution-listener
May 22, 2026
Merged

Support cancel execution listener rules and start event forms rules#156
barmac merged 5 commits into
mainfrom
cancel-execution-listener

Conversation

@barmac
Copy link
Copy Markdown
Contributor

@barmac barmac commented May 21, 2026

Related to camunda/camunda-modeler#5929

deps: update to bpmnlint-plugin-camunda-compat@2.51.0

Proposed Changes

This PR adds support for the cancel execution listener rules. Also, we get ready for the future event types rules without code adjustments.

image

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

Related to camunda/camunda-modeler#5929

deps: update to `bpmnlint-plugin-camunda-compat@2.51.0`
Copilot AI review requested due to automatic review settings May 21, 2026 14:51
@bpmn-io-tasks bpmn-io-tasks Bot added the needs review Review pending label May 21, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Camunda compatibility linting support for zeebe:ExecutionListener with cancel event type, including updated dependency versions and error message handling to accommodate future event types without further code changes.

Changes:

  • Update bpmnlint-plugin-camunda-compat to ^2.51.0 (and bump bpmn-js-properties-panel dev dependency).
  • Add/enable cancel execution listener rules in the bundled compiled config.
  • Extend error message adjustment + add tests for cancel execution listener support gating (Camunda >= 8.10).

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/spec/utils/properties-panel.spec.js Adds properties panel test asserting cancel event type is flagged as unsupported on Camunda < 8.10.
test/spec/utils/error-messages.spec.js Adds error message test for cancel execution listener support gating.
package.json Bumps bpmnlint-plugin-camunda-compat and bpmn-js-properties-panel versions.
package-lock.json Locks updated dependency versions and integrity hashes.
lib/utils/properties-panel.js Adjusts per-entry properties panel error messaging for execution listener eventType.
lib/utils/error-messages.js Generalizes execution listener eventType support error message formatting (introduces camelCase → sentence conversion).
lib/compiled-config.js Enables/bundles new cancel execution listener rules for browser usage.
CHANGELOG.md Documents the new feature and dependency bump.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lib/utils/properties-panel.js
@AlekseyManetov
Copy link
Copy Markdown
Contributor

@barmac

I also committed a version bump for bpmnlint-plugin-camunda-compat to 2.51.0, which contains:

The deprecation message itself is generic and doesn't need any adjustments, so it's just a routine version bump.

@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

@barmac

I also committed a version bump for bpmnlint-plugin-camunda-compat to 2.51.0, which contains:

The deprecation message itself is generic and doesn't need any adjustments, so it's just a routine version bump.

OK but I will need to update the properties panel too in that case as one cannot even try out the new rule on the test setup.

@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

@AlekseyManetov We'd need an adjustment for start event forms though:
image

@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

More:

image

@AlekseyManetov
Copy link
Copy Markdown
Contributor

@barmac Start event form error message in properties panel is adjusted

image

@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

I'd rather keep it short: Only supported in Camunda 8.3 or newer. We already have this pattern in this library.

Comment thread lib/utils/properties-panel.js Outdated
}

if (id === 'formType' && type === ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED) {
return `Embedded form on Start Event is only supported by Camunda ${ allowedVersion } or newer.`;
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude[agent] shorten this to use not supported message helper. Adjust the test.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 6374ab5. Changed to use getNotSupportedMessage('', allowedVersion) helper function, which produces "Only supported by Camunda 8.3 or newer." message. Test updated accordingly.

@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

More:

image

Clicking the message should focus the dropdown. We need to provide entry ID for the deprecation warning.

@Claude
Copy link
Copy Markdown

Claude AI commented May 22, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • www-api.ibm.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/linting/linting/node_modules/@ibm/telemetry-js/dist/REDACTED-process.js --log=/tmp/ibmtelemetry-20260522T125940678Z-049612.log --config=telemetry.yml conf�� --local --get /home/REDACTED/work/_temp/ghcca-node/node/bin/git R) &#43; 1) if (git (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@AlekseyManetov
Copy link
Copy Markdown
Contributor

More:
image

Clicking the message should focus the dropdown. We need to provide entry ID for the deprecation warning.

@barmac Fixed - 5c7fdaa

@barmac barmac force-pushed the cancel-execution-listener branch from 5c7fdaa to 2d08ca5 Compare May 22, 2026 13:21
@barmac
Copy link
Copy Markdown
Contributor Author

barmac commented May 22, 2026

Works for me! I squashed the commits and re-wrote the messages as feat.

@barmac barmac force-pushed the cancel-execution-listener branch from 2d08ca5 to 22996c2 Compare May 22, 2026 13:23
@barmac barmac changed the title feat: support cancel execution listener rules Support cancel execution listener rules and start event forms rule May 22, 2026
@barmac barmac changed the title Support cancel execution listener rules and start event forms rule Support cancel execution listener rules and start event forms rules May 22, 2026
@barmac barmac merged commit 064ea90 into main May 22, 2026
3 checks passed
@barmac barmac deleted the cancel-execution-listener branch May 22, 2026 13:24
@bpmn-io-tasks bpmn-io-tasks Bot removed the needs review Review pending label May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants