Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: simplify shapes registration #3045

Merged
merged 2 commits into from
Mar 1, 2024
Merged

refactor: simplify shapes registration #3045

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0757f1f
refactor: simplify shapes registration
tbouffard Feb 26, 2024
997ebf6
Merge branch 'master' into refactor/shapes_registration
tbouffard Mar 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 42 additions & 34 deletions src/component/mxgraph/config/ShapeConfigurator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

import type { mxShape } from 'mxgraph';

import { ShapeBpmnElementKind } from '../../../model/bpmn/internal';
import { mxgraph, mxCellRenderer, mxConstants, mxSvgCanvas2D } from '../initializer';
import { computeAllBpmnClassNamesOfCell } from '../renderer/style-utils';
Expand All @@ -36,47 +38,53 @@ import { ComplexGatewayShape, EventBasedGatewayShape, ExclusiveGatewayShape, Inc
import { TextAnnotationShape } from '../shape/text-annotation-shapes';
import { BpmnStyleIdentifier } from '../style';

const registerShapes = (): void => {
Copy link
Member Author

@tbouffard tbouffard Feb 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

thought: the shapes are registered in a global state in mxGraph, so bpmn-visualization currently registers the same shapes at every instantiation of the BpmnVisualization class.

We could register the shapes only once.
This is what is done in maxGraph: https://github.com/maxGraph/maxGraph/blob/v0.8.0/packages/core/src/view/cell/register-shapes.ts#L36-L43

// Inspired by the default shapes registration done in maxGraph
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- required by the signature of registerShape
const shapesToRegister: [string, new (...arguments_: any) => mxShape][] = [
// events
[ShapeBpmnElementKind.EVENT_END, EndEventShape],
[ShapeBpmnElementKind.EVENT_START, EventShape],
[ShapeBpmnElementKind.EVENT_INTERMEDIATE_THROW, ThrowIntermediateEventShape],
[ShapeBpmnElementKind.EVENT_INTERMEDIATE_CATCH, IntermediateEventShape],
[ShapeBpmnElementKind.EVENT_BOUNDARY, IntermediateEventShape],
// gateways
[ShapeBpmnElementKind.GATEWAY_COMPLEX, ComplexGatewayShape],
[ShapeBpmnElementKind.GATEWAY_EVENT_BASED, EventBasedGatewayShape],
[ShapeBpmnElementKind.GATEWAY_EXCLUSIVE, ExclusiveGatewayShape],
[ShapeBpmnElementKind.GATEWAY_INCLUSIVE, InclusiveGatewayShape],
[ShapeBpmnElementKind.GATEWAY_PARALLEL, ParallelGatewayShape],
// activities
[ShapeBpmnElementKind.SUB_PROCESS, SubProcessShape],
[ShapeBpmnElementKind.CALL_ACTIVITY, CallActivityShape],
// tasks
[ShapeBpmnElementKind.TASK, TaskShape],
[ShapeBpmnElementKind.TASK_SERVICE, ServiceTaskShape],
[ShapeBpmnElementKind.TASK_USER, UserTaskShape],
[ShapeBpmnElementKind.TASK_RECEIVE, ReceiveTaskShape],
[ShapeBpmnElementKind.TASK_SEND, SendTaskShape],
[ShapeBpmnElementKind.TASK_MANUAL, ManualTaskShape],
[ShapeBpmnElementKind.TASK_SCRIPT, ScriptTaskShape],
[ShapeBpmnElementKind.TASK_BUSINESS_RULE, BusinessRuleTaskShape],
// artifacts
[ShapeBpmnElementKind.TEXT_ANNOTATION, TextAnnotationShape],
// shapes for flows
[BpmnStyleIdentifier.EDGE, BpmnConnector],
[BpmnStyleIdentifier.MESSAGE_FLOW_ICON, MessageFlowIconShape],
];
for (const [shapeName, shapeClass] of shapesToRegister) {
mxCellRenderer.registerShape(shapeName, shapeClass);
}
};

/**
* @internal
*/
export default class ShapeConfigurator {
configureShapes(): void {
this.initMxSvgCanvasPrototype();
this.initMxShapePrototype();
this.registerShapes();
}

private registerShapes(): void {
// events
mxCellRenderer.registerShape(ShapeBpmnElementKind.EVENT_END, EndEventShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.EVENT_START, EventShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.EVENT_INTERMEDIATE_THROW, ThrowIntermediateEventShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.EVENT_INTERMEDIATE_CATCH, IntermediateEventShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.EVENT_BOUNDARY, IntermediateEventShape);
// gateways
mxCellRenderer.registerShape(ShapeBpmnElementKind.GATEWAY_COMPLEX, ComplexGatewayShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.GATEWAY_EVENT_BASED, EventBasedGatewayShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.GATEWAY_EXCLUSIVE, ExclusiveGatewayShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.GATEWAY_INCLUSIVE, InclusiveGatewayShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.GATEWAY_PARALLEL, ParallelGatewayShape);
// activities
mxCellRenderer.registerShape(ShapeBpmnElementKind.SUB_PROCESS, SubProcessShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.CALL_ACTIVITY, CallActivityShape);
// tasks
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK, TaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_SERVICE, ServiceTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_USER, UserTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_RECEIVE, ReceiveTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_SEND, SendTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_MANUAL, ManualTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_SCRIPT, ScriptTaskShape);
mxCellRenderer.registerShape(ShapeBpmnElementKind.TASK_BUSINESS_RULE, BusinessRuleTaskShape);
// artifacts
mxCellRenderer.registerShape(ShapeBpmnElementKind.TEXT_ANNOTATION, TextAnnotationShape);

// shapes for flows
mxCellRenderer.registerShape(BpmnStyleIdentifier.EDGE, BpmnConnector);
mxCellRenderer.registerShape(BpmnStyleIdentifier.MESSAGE_FLOW_ICON, MessageFlowIconShape);
registerShapes();
}

private initMxSvgCanvasPrototype(): void {
Expand Down
Loading