the correct way to use source-model watcher

[JimCSuen]

I wish to know the correct way to use source-model watcher. I have added the files in the "client" path like below:

and added related codes in workflow-diagram-module.ts like the following:

there might be repetition work, but none of them worked. After yarn and yarn start, the running webview does not pop any notifications after i perform any changes directly upon the raw workflow.wf file in the workspace via notepad, e.g., deleting a node data json block. I don't know if i have done something wrong :(

[martin-fleck-at]

Hi @JimCSuen,

The idea of the source model watcher module is that the server sends a SourceModelChangedAction when the source model has changed so that the client can inform the user or perform other actions. By default, the module on the client side by default only registers a very bare bone action handler that shows that the model has changed as a status and becomes more interesting if you also bind a ExternalSourceModelChangedHandler that may be able to do more. We do so, for instance, in the Theia integration where we may also auto-reload the model (see the TheiaSourceModelChangedHandler). However, you need to also make sure that someone on the server side is actually sending this action. Currently, only the Java server does so by watching the file, see the FileWatcher implementation. The module itself is already part of the default modules, so if you use the initializeDiagramContainer helper function, there is no need to actually add the module again.

I just tested this with the workflow example with the Theia integration and the Java server and I do get the dialog as expected when I change the file on the file system using an external editor:

What issues are you facing in particular?

[JimCSuen]

Thank you for answering me :) @martin-fleck-at

For I'm still getting used to this framework, there could be potential faults I have made in binding the handler, which I will keep checking. Anyhow, I'm using the NODE server instead of the JAVA server, is it the source of the problem?

[JimCSuen]

Also, it seems that I did not apply any operation at the server side, no wonder nothing happens on the client side. (sorry for my foolishness). So is there any possible bindings for the NODE server?

[martin-fleck-at]

No worries, getting used to a new framework is never easy, so I'm happy to answer your questions.

I just double-checked and I think that is indeed the source of the problem. It seems that the SourceModelWatcher API never made it into the Node server, see #1053. You can still implement it yourself based on the Java implementation or by otherwise detecting changes and sending a SourceModelChangedAction to the client.

[JimCSuen]

Now I understand, I will try the Java server with the source model watcher. Thank you @martin-fleck-at :)