bpmn-js-differ icon indicating copy to clipboard operation
bpmn-js-differ copied to clipboard

Published 20 hours ago • verified publisher icon bpmn-io

Timer Event is not recognized in the differ module

Open stocksanjan opened this issue 3 years ago • 5 comments

Describe the Bug

When we compare two models, and there is a difference in the "duration" configuration in the timer event, then bpmn-js-differ neither populate in the "list of changes" section nor show it on the difference on the models.

Steps to Reproduce

  1. create two BPMNs (clone each other) with timer event with default event duration as PT1S
  2. take the second BPMN file and change the above same event's duration to PT15S
  3. upload these two BPMN Files in the https://demo.bpmn.io/diff, to see if the tool can alert the timer difference.
  4. diff tool doesn't alert a difference at the timer event.

Expected Behavior

  1. Diff tool is expected to show the different between two models
  2. Tool may have to high light there is a difference in timer event node.
  3. Tool may have to list this difference in "List of changes" panel.

Environment

  • Host (Browser/Node version: Version 105.0.5195.125 (Official Build) (64-bit)
  • OS: [e.g. Windows 7]: Windows 11
  • Library version: [e.g. 2.0.0]

Sample BPMN Files.zip

stocksanjan avatar Sep 16 '22 13:09 stocksanjan

Hi, thank you for opening this issue. I can reproduce this. Moving to Backlog for now.

As this is currently not a high priority item for us, I would like to encourage you to provide a PR for this issue. I investigated a bit and maybe you find my findings helpful to get started.

Root Cause

We only track the bpmn attributes as defined in https://github.com/bpmn-io/bpmn-js-differ/blob/819773dc8302a224bd38318b1837610a1c7eaf9b/lib/change-handler.js#L60-L67

The Timer is defined in bpmn:TimerEventDefinition, which is not part of the list.

marstamm avatar Sep 21 '22 13:09 marstamm

hey @marstamm,

Thank you for the reply, yes I have noticed it is not a part of tracked attributes, I will be modifiying the code to include that, Thanks for the response once again.

stocksanjan avatar Sep 21 '22 15:09 stocksanjan

@marstamm Thank you for providing this open source, learnt little bit on how things work with BPMN.js, I have modified the local snippet as per my needs, and now the code recognize these events including Camunda ones too. Thanks.

image

stocksanjan avatar Sep 30 '22 17:09 stocksanjan

Thank you for providing this open source

And you plan to contribute that back?

nikku avatar Sep 30 '22 17:09 nikku

@nikku I need to do some unit test, and will keep you posted as per the output. Thanks.

stocksanjan avatar Oct 03 '22 13:10 stocksanjan