glsp-vscode-integration with GLSP Version 1.1.0-RC10 and a Java Server

[rsoika]

Hi,
I try to adapt my existing vscode-integration (based on 1.1.0-RC04) to 1.1.0-RC10.

From the changelog I understand that there a some breaking changes and I try to adapt this to my own code.

But from the example code here I run into some problems.

.......
function createServerModules(): ContainerModule[] {
    const appModule = createAppModule({ logLevel: LogLevel.info, logDir: LOG_DIR, fileLog: true, consoleLog: false });
    const elkLayoutModule = configureELKLayoutModule({ algorithms: ['layered'], layoutConfigurator: WorkflowLayoutConfigurator });
    const mainModule = new WorkflowServerModule().configureDiagramModule(new WorkflowDiagramModule(() => GModelStorage), elkLayoutModule);
    return [appModule, mainModule];
}

This method (and also other code pieces) expect a WorkflowServerModule? I don't think that I have something like this in my current application. I only have the WorkflowDiagramModule and my server is written in Java. I also have a problem with the WorkflowLayoutConfigurator. I also don't think I have this piece of code :-/

In my case the server is implemented in Java and so I have created a const JAVA_EXECUTABLE and implemented the serverProcess like this:

const JAVA_EXECUTABLE = path.join(
  __dirname,
  `../server/${artifactId}-${version}${isSnapShot ? "-SNAPSHOT" : ""}-glsp.jar`
);

export async function activate(context: vscode.ExtensionContext): Promise<void> {
    // Start server process using quickstart component
    let serverProcess: GlspSocketServerLauncher | undefined;
    const useIntegratedServer = JSON.parse(process.env.GLSP_INTEGRATED_SERVER ?? 'false');
    if (!useIntegratedServer && process.env.GLSP_SERVER_DEBUG !== 'true') {
        const additionalArgs = ['--fileLog', 'true', '--logDir', LOG_DIR];
        if (process.env.GLSP_WEBSOCKET_PATH) {
            additionalArgs.push('--webSocket');
        }
        serverProcess = new GlspSocketServerLauncher({
            executable: JAVA_EXECUTABLE,
            socketConnectionOptions: { port: JSON.parse(process.env.GLSP_SERVER_PORT || DEFAULT_SERVER_PORT) },
            additionalArgs,
            logging: true
        });

        context.subscriptions.push(serverProcess);
        await serverProcess.start();
    }
....

Is this approach valid so far?

I still wonder if the useIntegratedServer definition is expecting a Server written in NodeJS?

    // Wrap server with quickstart component
    const bpmnServer = useIntegratedServer
        ? new NodeGlspVscodeServer({
              clientId: 'glsp.workflow',
              clientName: 'workflow',
              serverModules: createServerModules()
          })
        : new SocketGlspVscodeServer({
              clientId: 'glsp.workflow',
              clientName: 'workflow',
              connectionOptions: {
                  port: serverProcess?.getPort() || JSON.parse(process.env.GLSP_SERVER_PORT || DEFAULT_SERVER_PORT),
                  path: process.env.GLSP_WEBSOCKET_PATH
              }
          });

Thanks for any hints regarding the integration of a java server in VSCode Integration 1.1.0-RC10.

[rsoika]

I think I found the solution.

In case that you only have a Java Server implementation, the NodeGlspVscodeServer and the function createServerModules() can simply be removed from the example code.

So your code have to look like this:

....
......

const JAVA_EXECUTABLE = path.join(
  __dirname,
  `../server/${artifactId}-${version}${isSnapShot ? "-SNAPSHOT" : ""}-glsp.jar`
);

export async function activate(context: vscode.ExtensionContext): Promise<void> {
  // Start server process using quickstart component
  let serverProcess: GlspSocketServerLauncher | undefined;
  const useIntegratedServer = JSON.parse(process.env.GLSP_INTEGRATED_SERVER ?? 'false');
  if (!useIntegratedServer && process.env.GLSP_SERVER_DEBUG !== 'true') {
      const additionalArgs = ['--fileLog', 'true', '--logDir', LOG_DIR];
      if (process.env.GLSP_WEBSOCKET_PATH) {
          additionalArgs.push('--webSocket');
      }
      serverProcess = new GlspSocketServerLauncher({
          executable: JAVA_EXECUTABLE,
          socketConnectionOptions: { port: JSON.parse(process.env.GLSP_SERVER_PORT || DEFAULT_SERVER_PORT) },
          additionalArgs,
          logging: true
      });

      context.subscriptions.push(serverProcess);
      await serverProcess.start();
  }
    // Wrap server with quickstart component
    const workflowServer =  new SocketGlspVscodeServer({
              clientId: 'glsp.workflow',
              clientName: 'workflow',
              connectionOptions: {
                  port: serverProcess?.getPort() || JSON.parse(process.env.GLSP_SERVER_PORT || DEFAULT_SERVER_PORT),
                  path: process.env.GLSP_WEBSOCKET_PATH
              }
          });
   // Initialize GLSP-VSCode connector with server wrapper
    const glspVscodeConnector = new GlspVscodeConnector({
        server: workflowServer,
        logging: true
    });

    const customEditorProvider = vscode.window.registerCustomEditorProvider(
        'workflow.glspDiagram',
        new WorkflowEditorProvider(context, glspVscodeConnector),
        {
            webviewOptions: { retainContextWhenHidden: true },
            supportsMultipleEditorsPerDocument: false
        }
    );

    context.subscriptions.push(workflowServer, glspVscodeConnector, customEditorProvider);
    workflowServer.start();

    configureDefaultCommands({ extensionContext: context, connector: glspVscodeConnector, diagramPrefix: 'workflow' });

....
.....

In addition you can call the method context.subscriptions.push(...) as shown in the workflow example to push additional custom commands.