helperLineModule documentation

[rsoika]

Hi, I wonder if there is any documentation about the helperLineModule?

I am currently migrating my Open-BPMN project form 2.1 to 2.3
Looks almost good. But my old BPMN Snapper is no longer able to be used. To be honest, it did not very much ;-)

@injectable()
export class BPMNElementSnapper implements ISnapper {
  constructor(public grid: { x: number; y: number } = { x: 1, y: 1 }) { }
  snap(position: Point, element: GModelElement): Point {
    // default move 1x1...
    return {
      // maybe the better snap behavior instead of round()...
      x: Math.floor(position.x),
      y: Math.floor(position.y)
    };
  }
}

But I recognized during migration to GLSP version 2.3, that binding this class in my ContainerModule

...
 bind(TYPES.ISnapper).to(BPMNElementSnapper);
....

causes the following error:

Error: You are attempting to construct Symbol(ITool) in a synchronous way but it has asynchronous dependencies.

Now I assume that the Snapper functionality is somehow replaced/included by the new helperLineModule .
But still this is a totally hidden feature. I cant find any documentation anywhere in the internet. Only my own discussions with @martin-fleck-at during development.

[tortmayr]

Hi @rsoika,

the ISnapper functionality has not been replaced and should work as before. The HelperLineModule and any other feature that relies on snapping (e.g. the ChangeBoundsManager) simply rely on the bound ISnapper implementation.

Weirdly enogugh your isse seems to be related to inversify which is complaing about async code, however I don't see any async code in your ISnapper implementation.

Could you please verify that

• The issue is gone if you remove the ISnapper binding
• If I recall correctly inversify does no longer allow direct arguments in constructors of injectable components without an @inject annotation. Please align the constructor of your snapper with one of your example implementations (e.g. the GridSnapper)

    constructor(@optional() @inject(TYPES.Grid) public readonly grid: Grid = { x: 1, y: 1 }) {}

• If the issue still persists you need to figure out which ITool implementation causes the error and then we can have a look at that code.

[rsoika]

Yes, you were right. The constructor was the problem. Adding the @optional() @inject(TYPES.Grid) annotations solved the problem. Thanks a lot!