Missing launch configuraiton in example java-emf-theia ???

[rsoika]

I wonder if there is a wrong / missing configuration in the java-emf-theia example

In the app module the launcher scripts look currently like this:

    "start": "theia start --TASKLIST_GLSP=5007 --root-dir=../workspace",
    "start:external": "theia start --TASKLIST_GLSP=5007 --root-dir=../workspace --glspDebug",

This seems to me being identically. As a result the backend-modul will always launch the server from the jar file

import { GLSPServerContribution } from '@eclipse-glsp/theia-integration/lib/node';
import { ContainerModule } from '@theia/core/shared/inversify';
import { TaskListGLSPServerContribution } from './glsp-server-contribution';

export default new ContainerModule(bind => {
    bind(TaskListGLSPServerContribution).toSelf().inSingletonScope();
    bind(GLSPServerContribution).toService(TaskListGLSPServerContribution);
});

In earlier version (before 2.3) there was the paramter --directWebSocket indicating that a external server is running (this is the external mode which is fine during developing)

So my old code looked more like this:

export default new ContainerModule(bind => {
    if (isDirectWebSocketConnection()) {
        console.log('├── DirectWebSocketConnection = true');
        return;
    }
    console.log('├── DirectWebSocketConnection = false');
    console.log('│   └── launch server...');
    bind(BPMNGLSPSocketServerContribution).toSelf().inSingletonScope();
    bind(GLSPServerContribution).toService(BPMNGLSPSocketServerContribution);
});


const directWebSocketArg = '--directWebSocket';
function isDirectWebSocketConnection(): boolean {
    const args = process.argv.filter(a => a.toLowerCase().startsWith(directWebSocketArg.toLowerCase()));
    return args.length > 0;
}

But anyway, currently when I start the server externally and than launch the theia app without starting the server jar file, I get log messages like this without any other errors

2025-02-09T09:51:55.369Z root ERROR Error: Unexpected SIGPIPE

And the modeler did not start (editor window is empty).
Running with the mode where the GLSPSocketServerContribution is launching the jar file all is fine - this is very strange....

[tortmayr]

Hi @rsoika,
welcome back 😉

In earlier version (before 2.3) there was the paramter --directWebSocket indicating that a external server is running (this is the external mode which is fine during developing)

There never was a --directWebSocket Parameter in the generic GLSP framework. I think you took this implementation from our dev workflow example. The dev workflow example is kind of an all in one example that covers all possible connection cases for testing.
It should not be used as blueprint (see also the remark in the README.md)

Anyways the --directWebsocket Parameter in the Workflow Dev Example is used for the use case where the client should directly connect to an externaly running WebSocket server. In your project you don't use a Websocket Server instead the server connects via a plain TCP Socket. So you can simply remove that code.

I checked your lauch scripts in the current open-bpmn master:

  "start": "theia start --GLSP_PORT=5007 --root-dir=../workspace",
  "start:external": "theia start --GLSP_PORT=5007 --root-dir=../workspace --debug",

For 2.3. you need to adapt the start:external command. Instead of the --debug flag you have to pass the --glspDebug flag.
This is also mentioned in the Changelog:

Potentially Breaking Changes
[launch] Changed the GLSPServerContributionOptions.debugArgument from debug to glspDebug to avoid clashes with nodes debug argument. Launch configurations and scripts need to be updated accordingly [#211](https://github.com/eclipse-glsp/glsp-theia-integration/pull/211)

Then launching the server externally and connecting to it should work as expected.

[rsoika]

Hi @tortmayr , thanks for your answer.
Yes again your are right. The param directWebSocket was not necessary at all. It was something from my last launch config.
Now it works as expected.

The thing that was irritating me (and is still irritating me) is the implementation of GLSPSocketServerContribution

import {
    getPort,
    GLSPSocketServerContribution,
    GLSPSocketServerContributionOptions
} from '@eclipse-glsp/theia-integration/lib/node';
import { injectable } from '@theia/core/shared/inversify';
import { join, resolve } from 'path';
import { BPMNLanguage } from '../common/bpmn-language';

export const DEFAULT_PORT = 0;
export const PORT_ARG_KEY = 'GLSP_PORT';
export const LOG_DIR = join(__dirname, '..', '..', 'logs');
const JAR_FILE = resolve(
    join(__dirname, '..', '..', '..', '..', 'open-bpmn.glsp-server', 'target', 'open-bpmn.server-1.2.6-SNAPSHOT-glsp.jar')
);

@injectable()
export class BPMNGLSPSocketServerContribution extends GLSPSocketServerContribution {
    readonly id = BPMNLanguage.contributionId;

    createContributionOptions(): Partial<GLSPSocketServerContributionOptions> {
        console.log('├── LOG_DIR = '+ LOG_DIR);
        console.log('├── PORT_ARG_KEY = '+ PORT_ARG_KEY);
        const _port=getPort(PORT_ARG_KEY, DEFAULT_PORT);
        console.log('├── PORT = '+ _port);
        return {
            executable: JAR_FILE,
            additionalArgs: ['--consoleLog', 'false', '--fileLog', 'true', '--logDir', LOG_DIR],
            socketConnectionOptions: {
                port: getPort(PORT_ARG_KEY, DEFAULT_PORT)
            }
        };
    }

    protected override processLogInfo(line: string): void {
        super.processLogInfo(line);
        console.info(`${this.id}: ${line}`);
    }
}

To me this looked like that the java jar file is started in all cases. But now I understand your answer in that way, that the launch param --glspDebug is avoiding this - right? At least the application behaves like that and this is fine to me. Now I will continue cleaning up old stuff.

Thanks again for your explanation.

[tortmayr]

Yes, you are correct the --glspDebug flag avoids starting the server.
It works like this:
The GlspSockeetServerContributionOptions have a lauchedExternally flag.
If not set explicitly, the default behavior is that it is set to true unless the --glspDebug flag is set. (https://github.com/eclipse-glsp/glsp-theia-integration/blob/8ac9d6a8325fd6f67b1aa3f9d7dbf773dcb4c0a0/packages/theia-integration/src/node/glsp-server-contribution.ts#L71C33-L71C44)

When the flag is set to false, GLSP does not call the launch() method of your contribution and instead tries to directly connect to a server running on the specified port.