feat(parser): let configure XML attribute processing #2704

tbouffard · 2023-05-22T09:28:52Z

Remove the 'entities' dependency.
By default, there is no need to be able to decode all entities as most of the time, only 'basic' entities are generally used in BPMN sources. Instead, bpmn-visualization now provides a small set of entities transform.

If there is a need to transform more entities, a new Parser option is now available to let application perform more processing.

closes #2680

Notes

Choice of the decoded entities

The minimal set of entities was chosen by checking

the mxGraph implementation https://github.com/jgraph/mxgraph/blob/v4.2.2/javascript/src/js/util/mxUtils.js?rgh-link-date=2023-05-11T12%3A44%3A35Z#L736-L762
the fast-xml-parser implementation https://github.com/NaturalIntelligence/fast-xml-parser/blob/c7b3cea4ead020c21d39e135a50348208829e971/src/xmlparser/OrderedObjParser.js#L22-L43
the reference files of miwg-test-suite

Tests

The existing unit tests already check the most common entities in the name attribute of the element in the semantic (used to display the label) and in all other attributes (standard like the 'id' attribute or in attributes of BPMN extensions).
Integration tests were added in this PR to ensure that the options passed at the lib initialization are correctly used by the parser.

Bundles size comparison

master: package built by GH Actions (007d881)
new implementation: 823b786

bpmn-visualization.min.js size decrease: 1941b / 1.89kb
Figures from the study done without implementation the internal entities decoding (#2680): 2736b / 2.67kb

bundle	master	new implementation
bpmn-visualization.js	2 925 511	2 918 900
bpmn-visualization.min.js	986 964	985 023

Remove the 'entities' dependency. By default, there is no need to be able to decode all entities as most of the time, only 'basic' entities are generally used in BPMN sources. Instead, `bpmn-visualization` now provides a small set of entities transform. If there is a need to transform more entities, a new Parser option is now available to let application perform more processing.