How to get Workflow example working in Eclipse IDE

[dhendriks]

I'm trying to get the Workflow example working in the Eclipse IDE, using these instructions:

• https://github.com/eclipse-glsp/glsp-eclipse-integration
• https://github.com/eclipse-glsp/glsp-server#workflow-diagram-example

I tried the following:

• Download Eclipse Modeling Tools 2021-03 for Windows (x64). Extract it. Run it.
• Install M2eclipse from market place + restart Eclipse.
• Clone https://github.com/eclipse-glsp/glsp-eclipse-integration.git and import all its projects (recursively).
• Clone https://github.com/eclipse-glsp/glsp-server.git and import all its projects (recursively).
• Activate org.eclipse.glsp.ide.releng.target/r2021-03.target as target platform.
• Close org.eclipse.glsp.graph.test project (it has build errors).
• Execute org.eclipse.glsp.example.workflow/Start_Workflow_Example_Server.launch. Produces the following command line output:

    0    [main] INFO  ver.launch.SocketGLSPServerLauncher  - The GLSP server is ready to accept new client requests on port: 5007
    [GLSP-Server]:Startup completed
  

• Execute org.eclipse.glsp.ide.workflow.editor/WorkflowEditor.launch to start runtime instance.
• In runtime instance, import test project from glsp-eclipse-integration/server/example/runtime/test.
• Double click example1.wf in test project.
• New editor opens. It shows an error:

        HTTP ERROR 404 Not Found
        URI:	/diagram.html
        STATUS:	404
        MESSAGE:	Not Found
        SERVLET:	default
        Powered by Jetty:// 9.4.44.v20210927
  

• Observe console output of parent Eclipse that started runtime instance:

  2022-01-08 16:07:27.858:INFO::main: Logging initialized @55766ms to org.eclipse.jetty.util.log.StdErrLog
  2022-01-08 16:07:28.244:INFO:oejs.Server:main: jetty-9.4.44.v20210927; built: 2021-11-04T08:22:36.864Z; git:  8da83308eeca865e495e53ef315a249d63ba9332; jvm 11.0.10+8-LTS-162
  2022-01-08 16:07:28.266:INFO:oejs.session:main: DefaultSessionIdManager workerName=node0
  2022-01-08 16:07:28.266:INFO:oejs.session:main: No SessionScavenger set, using defaults
  2022-01-08 16:07:28.267:INFO:oejs.session:main: node0 Scavenging every 660000ms
  2022-01-08 16:07:28.288:INFO:oejsh.ContextHandler:main: Started o.e.j.s.ServletContextHandler@1e5921ec{/,null,AVAILABLE}
  2022-01-08 16:07:28.311:INFO:oejs.AbstractConnector:main: Started ServerConnector@5608e254{HTTP/1.1, (http/1.1} {localhost:59542}
  2022-01-08 16:07:28.312:INFO:oejs.Server:main: Started @56219ms
  

I then tried:

• Using org.eclipse.glsp.example.workflow/Start_Workflow_Example_Server_(Websocket).launch instead to start the server. I get the same 404 error. The websocker server console shows:

  2022-01-08 16:17:38.789:INFO::main: Logging initialized @785ms to org.eclipse.jetty.util.log.StdErrLog
  2022-01-08 16:17:38.995:INFO:oejs.Server:main: jetty-9.4.44.v20210927; built: 2021-11-04T08:22:36.864Z; git: 8da83308eeca865e495e53ef315a249d63ba9332; jvm 11.0.10+8-LTS-162
  2022-01-08 16:17:39.028:INFO:oejs.session:main: DefaultSessionIdManager workerName=node0
  2022-01-08 16:17:39.028:INFO:oejs.session:main: No SessionScavenger set, using defaults
  2022-01-08 16:17:39.031:INFO:oejs.session:main: node0 Scavenging every 600000ms
  2022-01-08 16:17:39.051:INFO:oejsh.ContextHandler:main: Started o.e.j.s.ServletContextHandler@3eb77ea8{/,null,AVAILABLE}
  2022-01-08 16:17:39.374:INFO:oejs.AbstractConnector:main: Started ServerConnector@f736069{HTTP/1.1, (http/1.1)}{localhost:8081}
  2022-01-08 16:17:39.377:INFO:oejs.Server:main: Started @1373ms
  0    [main] INFO  r.websocket.WebsocketServerLauncher  - GLSP server is running and listening on Endpoint : http://localhost:8081/workflow
  1    [main] INFO  r.websocket.WebsocketServerLauncher  - Press enter to stop the server...
  

What am I doing wrong? How do I get the editor to open instead of a 404 error? Is there any better tutorial that explains the steps?

[CamilleLetavernier]

Hi @dhendriks,

When using the GLSP Server from Eclipse, the GLSP Server doesn't need to be started separately, because it's already packaged as an Eclipse Plug-in. A new server should be automatically started by each GLSP Editor, during the initialization phase.

In the Eclipse integration scenario, there is only one entry point: the WorkflowEditor.launch Eclipse Launch Configuration, from glsp-eclipse-integration/server/example/org.eclipse.glsp.ide.workflow.editor. This will start a new Eclipse IDE, where you can open *.wf files with the GLSP Editor ("Workflow Diagram Editor").

Additionally (And I think this step might be missing from the documentation), the diagram.html file is generated when you build the client packages. You need to run yarn in the glsp-eclipse-integration/client directory. This should create a new diagram.html file (and other client files) in server/example/org.eclipse.glsp.ide.workflow.editor/diagram.

HTH,
Camille

[CamilleLetavernier]

Hi @dhendriks,

Sorry, I missed your previous reply. Thanks for the reminder :)

Unfortunately, I'm not familiar with the Windows installation procedures. All instructions are provided for a Linux installation.

Regarding your first error message, it seems that Node 6.x was used (Instead of 12):

error [email protected]: The engine "node" is incompatible with this module. Expected version ">=10.13.0". Got "6.10.1"

Regarding the nvm installation issue on Windows, I can't really help you. Maybe this could help? https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows

It seems I only need some missing files, for which I need yarn, for which I need nodejs, etc. Can't the missing files just be committed to the glsp repo?

Except for diagram.html (Which I think is hardcoded), all required artifacts are build-time artifacts. As such, publishing them to the repository would not be a good practice (It would probably make more sense to build and deploy a pre-built Eclipse RCP with the Workflow editor, for simple demo purposes). I don't know what your current use case is, but if you're going to use GLSP, having a working web development environment is a must: except for the backend, which is implemented in Java, most of the project uses web technologies, languages and tools.

I assume this is a one-time only thing? I won't need this nodejs/yarn thing otherwise? My Eclipse-based product can just depend on Eclipse features/plugins without a dependency on nodejs/yarn?

You'll need Node and Yarn each time you want to build/rebuild the project, for any of the EMF.Cloud products. So, again, it really depends on your current and future use cases.

If you're simply interested in a GLSP Demo, rather than GLSP usage/development, you can check the online Demo here: https://eclipsesource.com/coffee-editor (Although this demo doesn't cover the Eclipse IDE integration).

HTH,

[dhendriks]

Using nodejs 12 solved the issue. I completed the client build. The example works then, in an Eclipse 2021-03 environment.

I also tried it in an Eclipse 2021-06 (4.20) release, as that is what the rest of my tool runs on. There the Chromium support has been removed. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=572010. When I execute the workflow example and open a workflow model, I get:

2022-01-15 15:18:12.172:INFO::main: Logging initialized @21442ms to org.eclipse.jetty.util.log.StdErrLog
2022-01-15 15:18:12.590:INFO:oejs.Server:main: jetty-9.4.44.v20210927; built: 2021-11-04T08:22:36.864Z; git: 8da83308eeca865e495e53ef315a249d63ba9332; jvm 11.0.2+9
2022-01-15 15:18:12.619:INFO:oejs.session:main: DefaultSessionIdManager workerName=node0
2022-01-15 15:18:12.619:INFO:oejs.session:main: No SessionScavenger set, using defaults
2022-01-15 15:18:12.621:INFO:oejs.session:main: node0 Scavenging every 660000ms
2022-01-15 15:18:12.643:INFO:oejsh.ContextHandler:main: Started o.e.j.s.ServletContextHandler@6287e312{/,null,AVAILABLE}
2022-01-15 15:18:12.669:INFO:oejs.AbstractConnector:main: Started ServerConnector@5eed2edf{HTTP/1.1, (http/1.1)}{localhost:52904}
2022-01-15 15:18:12.670:INFO:oejs.Server:main: Started @21940ms
SWT.CHROMIUM style was used but chromium.swt fragment/jar is missing from classpath.

I additionally added org.eclipse.swt.chromium.feature.feature.group from http://dl.maketechnology.io/chromium-swt/rls/repository to the target platform. However, this does not help.

[dhendriks]

It seems #216 needs to be solved for this first... :(

[dhendriks]

I changed SWT.CHROMIUM to SWT.EDGE in 3 places and now it does work in Eclipse 2021-06 (4.20).

[CamilleLetavernier]

Hi,

Thanks for the feedback

I changed SWT.CHROMIUM to SWT.EDGE in 3 places and now it does work in Eclipse 2021-06 (4.20).

Great! :)