Use bpmn in color

[barmac]

Along with custom bpmn.io extension properties, modeling#setColor will use BPMN in Color properties to serialize element colors.

[barmac]

Follow-up: #1454

[barmac]

Follow-up issue: #1455

[nikku]

I'd personally not introduce any breaking changes at this point. Is it something we could avoid? A way to do it could be:

• Detect if bioc is already used, if so, serialize using our color format.
• If bpmn-in-color is already used, serialize in bpmn-in-color format.
• If non is used, serialize in bioc because that is (at least at the moment) widely understood by bpmn-js viewers out there

Once our bpmn-in-color support received wider adoption we could consider to go the full switch

[barmac]

I'd personally not introduce any breaking changes at this point. Is it something we could avoid?

I think the most important breaking change is that we start to throw errors in setColor. Alternatively, we could just emit a warning and ignore incorrect values.

Regarding using bioc, if I understand your proposal correctly, this would mean we use BPMN in Color only for the diagrams where it has been used already. So if a user wants to use it, they would have to manually add the namespace in the XML or use another tool which supports the extension. I see a problem with this solution that it IMO violates the no magic principle:

• If I create a diagram with a 3rd party tool and add colors, they will work in bpmn-js.
• If I create a diagram with bpmn-js and add colors, they won't work in a 3rd party tool.
• It can also be that I create a diagram with a 3rd party tool, add colors in bpmn-js and then they also won't work work in the 3rd party tool.

[barmac]

We've discussed this offline and come up with the following:

• The stricter validation is not considered a breaking change but rather a fix. The invalid values have not been displayed incorrectly anyway.
• We will use both bpmn.io custom properties and BPMN in Color in the setter. This way, at a cost of small redundancy, the old viewers will still be able to display colors modelled in new versions of the library.

[barmac]

OK I've removed the breaking change.

[nikku]

Looks good. Pending integration of bpmn-moddle with BPMN in color support baked in.

[barmac]

Looks good. Pending integration of bpmn-moddle with BPMN in color support baked in.

Done via 7d58d6a

[nikku]

Did not seem to work according to tests @barmac.

And it seems like we did not properly inline the bpmn-in-color definition into the released bpmn-moddle library: https://unpkg.com/browse/bpmn-moddle@7.1.0/dist/index.js

[nikku]

Needs follow up fix in bpmn-moddle: bpmn-io/bpmn-moddle#88

[barmac]

Yea. I'll release bpmn-moddle@7.1.1 and itegrate it.

[barmac]

Looks good now 😓

[nikku]

Good work. Happy we got this one sorted 👏

[falko]

Awesome! When will this be available in Camunda Modeler?

[nikku]

Will be released with the next release.

[falko]

When will it be included in the nightly builds so we can start using it for the MIWG work? Is there another GitHub issue that I can follow for that?

[barmac]

It's already included in the nightly :)