Change ELK layout algorithm

[gee4vee]

I am trying to change the algorithm from the default layered to sporeOverlap but running into this error.

3:13:53 PM error -  [DefaultCommandStack] An error occurred during command execution. CommandStack will be flushed! org.eclipse.elk.core.UnsupportedConfigurationException: Unable to load default layout algorithm org.eclipse.elk.layered for unconfigured node Root Node root > Node f7f06f76-2fe5-446c-a1d8-dc0c6174317b-config
            Error: org.eclipse.elk.core.UnsupportedConfigurationException: Unable to load default layout algorithm org.eclipse.elk.layered for unconfigured node Root Node root > Node f7f06f76-2fe5-446c-a1d8-dc0c6174317b-config
    at i$c.Mx [as Wd] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:84194)
    at i$c.Sx [as _d] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:84455)
    at i$c.Kx (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:2734:48)
    at i$c.Vx (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:1337:19)
    at new i$c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:1383:20)
    at C_c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5836:311)
    at E_c.F_c [as jg] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:306867)
    at Rad (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5085:187)
    at d$c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5109:137)
    at Iqd (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5889:353)
    at h.dispatch (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6188:473)
    at h.saveDispatch (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6188:603)
    at Timeout._onTimeout (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6189:162)
    at listOnTimeout (node:internal/timers:581:17)
    at process.processTimers (node:internal/timers:519:7)
3:13:53 PM error -  [DefaultGLSPServer] Could not process action: 'layout 
3:13:53 PM error -  [DefaultGLSPServer] Error: org.eclipse.elk.core.UnsupportedConfigurationException: Unable to load default layout algorithm org.eclipse.elk.layered for unconfigured node Root Node root > Node f7f06f76-2fe5-446c-a1d8-dc0c6174317b-config 

I also tried org.eclipse.elk.sporeOverlap for the algorithm ID.

org.eclipse.elk.core.UnsupportedConfigurationException: Layout algorithm 'org.eclipse.elk.sporeOverlap' not found for Root Node root
            Error: org.eclipse.elk.core.UnsupportedConfigurationException: Layout algorithm 'org.eclipse.elk.sporeOverlap' not found for Root Node root
    at i$c.Mx [as Wd] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:84194)
    at i$c.Sx [as _d] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:84455)
    at i$c.Kx (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:2734:48)
    at i$c.Vx (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:1337:19)
    at new i$c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:1383:20)
    at C_c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5836:412)
    at E_c.F_c [as jg] (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6253:306867)
    at Rad (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5085:187)
    at d$c (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5109:137)
    at Iqd (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:5889:353)
    at h.dispatch (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6188:473)
    at h.saveDispatch (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6188:603)
    at Timeout._onTimeout (/Users/gvalenc/git/DevX/epx-vscode-ext-poc/node_modules/elkjs/lib/elk.bundled.js:6189:162)
    at listOnTimeout (node:internal/timers:581:17)
    at process.processTimers (node:internal/timers:519:7)
3:19:22 PM error -  [DefaultGLSPServer] Could not process action: 'layout 
3:19:22 PM error -  [DefaultGLSPServer] Error: org.eclipse.elk.core.UnsupportedConfigurationException: Layout algorithm 'org.eclipse.elk.sporeOverlap' not found for Root Node root 

Is this the correct way to do it?

GLSP server

export async function launch(argv?: string[]): Promise<void> {
  const options = createSocketCliParser().parse(argv);
  const appContainer = new Container();
  appContainer.load(createAppModule(options));

  const launcher = appContainer.resolve(SocketServerLauncher);
  const elkLayoutModule = configureELKLayoutModule({
    algorithms: ['sporeOverlap'],
    layoutConfigurator: GraphEditorLayoutConfigurator,
    elementFilter: ProjectConfigElementFilter
  });
  const serverModule = new ServerModule().configureDiagramModule(new ProjectDiagramModule(), elkLayoutModule);

  launcher.configure(serverModule);
  launcher.start({ port: options.port, host: options.host });
}

Layout configurator

@injectable()
export class GraphEditorLayoutConfigurator extends AbstractLayoutConfigurator {
  protected override graphOptions(graph: GGraph): LayoutOptions | undefined {
    return {
      'elk.algorithm': 'sporeOverlap'
    };
  }
}

[tortmayr]

Yes this should be the correct way to do ti. AFAIK the org.eclipse.elk prefix is optional and should not change anything.
I quickly tried it with the workflow example and here it seems to work without issues:

I'm not sure why your configurator still tries to load the layered algorithm at some point.

Note that there are currently a lot of known issues/bugs regarding the ELK layouting. We are trying to tackle most of them before the next release.
If your problem persists you could try to find a reproducible configuration for the workflow example so that we can test it and if its indeed a bug fix it.

[gee4vee]

@tortmayr I will poke around a bit. Ours is based on the task list project template. Could there be any significant differences compared to the workflow example?

[gee4vee]

@tortmayr another thought: since we are using our own model, could this issue be related to #1173?

[gee4vee]

@tortmayr to try to see if this is a bug, I added the ELK layout diagram module and tool palette button to the base task list project template. I don't get an error, but I also don't see the diagram layout changing with the sporeOverlap algorithm. In fact, the nodes don't move at all, even if I overlap them. I've attached a diff patch of the changes.

elk-layout-tasklist.patch

[gee4vee]

@tortmayr I have also tried to debug as much as I can into the stack when trying the different algorithm. When this is called,

I can see that the layout algorithm is properly configured.

However, when I dig a little deeper, in the ELK worker postMessage call,

I can see that there are no layout options. Not sure if that is relevant.

Hope this helps.