GLSP-1371: Fix Theia selection forwarder (#227)

Switch from `onDidChangeActiveWidget` event to `onFoucsChanged` event for restoring the diagram selection.
Reason: The `TheiaSelectionForwarder` is bound once per diagram widget.
By using the `onDidChangeActiveWidget` event we notified and updated all forwarders of all widgets. As a consequence a wrong i.e. currently inactive widget could set the last selection in the selection service

With using the `onFocusChanged` event we can now only update the selection if the diagram currently has focus.

Requires eclipse-glsp/glsp-client#380

Fixes eclipse-glsp/glsp#1371

CHANGELOG.md

@@ -12,6 +12,8 @@
 ### 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)
+-   [diagram] Fix a bug in the `TheiaSelectionForwarder` when handling multiple diagrams [#227](https://github.com/eclipse-glsp/glsp-theia-integration/pull/227)
+    -   This required a change in event handling. As a consequence the `shell` property has been removed. This might impact custom subclasses.
 
 ## [2.1.0- 24/01/2024](https://github.com/eclipse-glsp/glsp-theia-integration/releases/tag/v2.1.0)
 

packages/theia-integration/src/browser/diagram/features/select/theia-glsp-selection-forwarder.ts

@@ -16,6 +16,8 @@
 // based on: https://github.com/eclipse-sprotty/sprotty-theia/blob/v0.12.0/src/sprotty/theia-sprotty-selection-forwarder.ts
 import {
     AnyObject,
+    DisposableCollection,
+    EditorContextService,
     GLSPModelSource,
     GModelRoot,
     ISelectionListener,
@@ -24,12 +26,11 @@ import {
     ViewerOptions,
     hasArrayProp,
     hasObjectProp,
-    hasStringProp
+    hasStringProp,
+    pluck
 } from '@eclipse-glsp/client';
-import { SelectionService } from '@theia/core';
-import { ApplicationShell } from '@theia/core/lib/browser';
-import { inject, injectable, optional, postConstruct } from '@theia/core/shared/inversify';
-import { getDiagramWidget } from '../../glsp-diagram-widget';
+import { SelectionService as TheiaSelectionService } from '@theia/core';
+import { inject, injectable, optional, postConstruct, preDestroy } from '@theia/core/shared/inversify';
 
 export interface GlspSelection {
     additionalSelectionData?: GlspSelectionData;
@@ -81,29 +82,34 @@ export class TheiaGLSPSelectionForwarder implements ISelectionListener {
     @inject(TYPES.ViewerOptions)
     protected viewerOptions: ViewerOptions;
 
-    @inject(SelectionService)
-    protected theiaSelectionService: SelectionService;
+    @inject(TheiaSelectionService)
+    protected theiaSelectionService: TheiaSelectionService;
 
     @inject(TYPES.ModelSourceProvider)
     protected modelSourceProvider: () => Promise<ModelSource>;
 
-    @inject(ApplicationShell)
-    protected shell: ApplicationShell;
+    @inject(EditorContextService)
+    protected editorContext: EditorContextService;
 
     protected sourceUri?: string;
 
+    protected toDispose = new DisposableCollection();
+
     @postConstruct()
     protected init(): void {
-        this.shell.onDidChangeActiveWidget(() => {
-            const activeDiagramWidget = getDiagramWidget(this.shell);
-            if (activeDiagramWidget) {
-                // restore selection from diagram to the global scope
-                this.selectionChanged(
-                    activeDiagramWidget.editorContext.modelRoot,
-                    activeDiagramWidget.editorContext.selectedElements.map(element => element.id)
-                );
-            }
-        });
+        this.toDispose.push(
+            this.editorContext.onFocusChanged(event => {
+                if (event.hasFocus) {
+                    // restore selection from the global scope to the diagram
+                    this.selectionChanged(this.editorContext.modelRoot, pluck(this.editorContext.selectedElements, 'id'));
+                }
+            })
+        );
+    }
+
+    @preDestroy()
+    protected dispose(): void {
+        this.toDispose.dispose();
     }
 
     protected async getSourceUri(): Promise<string | undefined> {

yarn.lock

@@ -990,11 +990,11 @@
   integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==
 
 "@eclipse-glsp-examples/workflow-glsp@next":
-  version "2.2.0-next.369"
-  resolved "https://registry.yarnpkg.com/@eclipse-glsp-examples/workflow-glsp/-/workflow-glsp-2.2.0-next.369.tgz#f5584f3a937a0afddd03e7e5fe093bc56e5c3cb8"
-  integrity sha512-gq47On44X8JFTKtdIAmsZKzvrI5Ocu0XjcDzG6atAdbYplXn2Qinz9O2d4bOenrhfI9l71ps0i+9E4wh7Y5GgQ==
+  version "2.2.0-next.370"
+  resolved "https://registry.yarnpkg.com/@eclipse-glsp-examples/workflow-glsp/-/workflow-glsp-2.2.0-next.370.tgz#889e49c994609869d1cdf9946af9eeae3335789c"
+  integrity sha512-SQDYHEqGZu9zoPoLTwRHP/9q21ELrKHPrDbzFraeC9FSXfW/2w7S2klcHdAnfTXTQm3w2Qje3iNv5boqHpL81w==
   dependencies:
-    "@eclipse-glsp/client" "2.2.0-next.369+9b95d68"
+    "@eclipse-glsp/client" "2.2.0-next.370+89dfe80"
     balloon-css "^0.5.0"
 
 "@eclipse-glsp-examples/workflow-server-bundled@next":
@@ -1025,12 +1025,12 @@
     semver "^7.5.1"
     shelljs "^0.8.5"
 
-"@eclipse-glsp/[email protected].369+9b95d68", "@eclipse-glsp/client@next":
-  version "2.2.0-next.369"
-  resolved "https://registry.yarnpkg.com/@eclipse-glsp/client/-/client-2.2.0-next.369.tgz#6668ce679cb7aae60b2bfc7a40aaefdfe69443af"
-  integrity sha512-8F7lW9DofAzByLUJqLUP4rBj6ATDIVq6dauE3PaBEldDDNWDEpDSUQy+dzRsHka1vMwKhqIzJrEmNsxgZdly2A==
+"@eclipse-glsp/[email protected].370+89dfe80", "@eclipse-glsp/client@next":
+  version "2.2.0-next.370"
+  resolved "https://registry.yarnpkg.com/@eclipse-glsp/client/-/client-2.2.0-next.370.tgz#d2e8a3f598257343fe27377d8d945c50d92872df"
+  integrity sha512-wJEKtKvGB0RNd0a/EipiHZIlydHVDfy1rH5KBQ4lfj6i2rWrqrPGAlFExkfFW8TTG4WRBo781Tbz7YzXaJpVAw==
   dependencies:
-    "@eclipse-glsp/sprotty" "2.2.0-next.369+9b95d68"
+    "@eclipse-glsp/sprotty" "2.2.0-next.370+89dfe80"
     autocompleter "^9.1.2"
     file-saver "^2.0.5"
     lodash "4.17.21"
@@ -1124,10 +1124,10 @@
   dependencies:
     prettier-plugin-packagejson "~2.4.6"
 
-"@eclipse-glsp/[email protected].369+9b95d68":
-  version "2.2.0-next.369"
-  resolved "https://registry.yarnpkg.com/@eclipse-glsp/protocol/-/protocol-2.2.0-next.369.tgz#426fa5ecbe1ed93a30189cca5e97913b2a265abc"
-  integrity sha512-k7+ILRwG2ll1RTuuHefujZaEXVeVgKrpa+E/L/w4JCPdyzh5F58iQo0ooKhjRVXkEoz/1qZ/bExN+GcK+XR1tw==
+"@eclipse-glsp/[email protected].370+89dfe80":
+  version "2.2.0-next.370"
+  resolved "https://registry.yarnpkg.com/@eclipse-glsp/protocol/-/protocol-2.2.0-next.370.tgz#f77bd1d68ce9e1d3df05e3c4bfd62bfca8c56668"
+  integrity sha512-wL0HScoXwpse75yWlIfgSapyyBssdZ7WUsvJ3rG9q21O7ZcoARYnwgdscy1r7C/FyqlhIoAwddTN1xlbSJs57A==
   dependencies:
     sprotty-protocol "1.2.0"
     uuid "~10.0.0"
@@ -1156,12 +1156,12 @@
     winston "^3.3.3"
     ws "^8.12.1"
 
-"@eclipse-glsp/[email protected].369+9b95d68":
-  version "2.2.0-next.369"
-  resolved "https://registry.yarnpkg.com/@eclipse-glsp/sprotty/-/sprotty-2.2.0-next.369.tgz#94f69a3682c9867a0965253770f40f2be7b7b5d7"
-  integrity sha512-rqY8vdHwpwxU7Z05dHG6W/p7ucTJYDUDLwLQ1YTuDAeTo7Wq0iHRlxhWa5WiAlJ9df7YnKV9ZukIYbpfVx7AdQ==
+"@eclipse-glsp/[email protected].370+89dfe80":
+  version "2.2.0-next.370"
+  resolved "https://registry.yarnpkg.com/@eclipse-glsp/sprotty/-/sprotty-2.2.0-next.370.tgz#d0a98a824b52f4c29690cee5c87ec4d4ad6c24b1"
+  integrity sha512-jJRGEgQMmC/aN77ysbPSM5yjo57IlsAVd78ZdC/fY1+nUS0k7f5VDvqQ5KBuJyE4W2Dt8u/1FVBaCHEev//Cdw==
   dependencies:
-    "@eclipse-glsp/protocol" "2.2.0-next.369+9b95d68"
+    "@eclipse-glsp/protocol" "2.2.0-next.370+89dfe80"
     autocompleter "^9.1.0"
     snabbdom "~3.5.1"
     sprotty "1.2.0"