GLSP-1416: Align ActionDispatcher API

- Rename `action-override` module of @eclipse-glsp/sprotty to `api-override` which a better fit. - Add additional API methods of the `GLSPActionDispatcher` directly to the `IActionDispatcher` interface and update related code for consistent usage of the interface. Export new `IActionDispatcher` interface via api-override - Also add API override for `IVNodePostProcessor` Also: - Adjust directs imports of `matchesKeystroke` and `toArray` from sprotty. Import from @eclipse/glsp-sprotty instead Fixes eclipse-glsp/glsp#1416
eclipse-glsp · Oct 24, 2024 · 04d5de1 · 04d5de1
1 parent 6953835
commit 04d5de1
Show file tree

Hide file tree

Showing 42 changed files with 268 additions and 174 deletions.
diff --git a/examples/workflow-glsp/src/direct-task-editing/direct-task-editor.ts b/examples/workflow-glsp/src/direct-task-editing/direct-task-editor.ts
@@ -19,8 +19,8 @@ import {
     DOMHelper,
     EditorContextService,
     GLSPAbstractUIExtension,
-    GLSPActionDispatcher,
     GModelRoot,
+    IActionDispatcher,
     ILogger,
     LabeledAction,
     ModelIndexImpl,
@@ -95,7 +95,7 @@ export class TaskEditor extends GLSPAbstractUIExtension {
     };
 
     @inject(TYPES.IActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    protected actionDispatcher: IActionDispatcher;
 
     @inject(EditorContextService)
     protected editorContextService: EditorContextService;

diff --git a/packages/client/src/base/action-dispatcher.ts b/packages/client/src/base/action-dispatcher.ts
@@ -13,15 +13,24 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ActionDispatcher, EMPTY_ROOT, GModelRoot, RequestAction, ResponseAction, SetModelAction } from '@eclipse-glsp/sprotty';
+import {
+    Action,
+    ActionDispatcher,
+    EMPTY_ROOT,
+    GModelRoot,
+    IActionDispatcher,
+    RequestAction,
+    ResponseAction,
+    SetModelAction
+} from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
 import { GLSPActionHandlerRegistry } from './action-handler-registry';
 import { IGModelRootListener } from './editor-context-service';
 import { OptionalAction } from './model/glsp-model-source';
 import { ModelInitializationConstraint } from './model/model-initialization-constraint';
 
 @injectable()
-export class GLSPActionDispatcher extends ActionDispatcher implements IGModelRootListener {
+export class GLSPActionDispatcher extends ActionDispatcher implements IGModelRootListener, IActionDispatcher {
     protected readonly timeouts: Map<string, NodeJS.Timeout> = new Map();
     protected initializedConstraint = false;
 

diff --git a/packages/client/src/base/auto-complete/base-autocomplete-palette.ts b/packages/client/src/base/auto-complete/base-autocomplete-palette.ts
@@ -14,10 +14,9 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Action, GModelRoot, LabeledAction, TYPES } from '@eclipse-glsp/sprotty';
+import { Action, GModelRoot, IActionDispatcher, LabeledAction, TYPES } from '@eclipse-glsp/sprotty';
 import { inject } from 'inversify';
 import '../../../css/autocomplete-palette.css';
-import { GLSPActionDispatcher } from '../action-dispatcher';
 import { GLSPAbstractUIExtension } from '../ui-extension/ui-extension';
 import { AutoCompleteWidget, CloseReason, toActionArray } from './auto-complete-widget';
 
@@ -38,7 +37,7 @@ export abstract class BaseAutocompletePalette extends GLSPAbstractUIExtension {
     protected autocompleteWidget: AutoCompleteWidget;
 
     @inject(TYPES.IActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    protected actionDispatcher: IActionDispatcher;
 
     containerClass(): string {
         return 'autocomplete-palette';

diff --git a/packages/client/src/base/editor-context-service.ts b/packages/client/src/base/editor-context-service.ts
@@ -26,6 +26,7 @@ import {
     Event,
     GModelElement,
     GModelRoot,
+    IActionDispatcher,
     IActionHandler,
     LazyInjector,
     MaybePromise,
@@ -36,7 +37,6 @@ import {
     ValueChange
 } from '@eclipse-glsp/sprotty';
 import { inject, injectable, postConstruct, preDestroy } from 'inversify';
-import { GLSPActionDispatcher } from './action-dispatcher';
 import { FocusChange, FocusTracker } from './focus/focus-tracker';
 import { IDiagramOptions, IDiagramStartup } from './model/diagram-loader';
 import { SelectionChange, SelectionService } from './selection-service';
@@ -89,8 +89,8 @@ export class EditorContextService implements IActionHandler, Disposable, IDiagra
     @inject(TYPES.IDiagramOptions)
     protected diagramOptions: IDiagramOptions;
 
-    @inject(GLSPActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher)
+    protected actionDispatcher: IActionDispatcher;
 
     @inject(FocusTracker)
     protected focusTracker: FocusTracker;

diff --git a/packages/client/src/base/model/diagram-loader.ts b/packages/client/src/base/model/diagram-loader.ts
@@ -20,6 +20,7 @@ import {
     Args,
     EMPTY_ROOT,
     GLSPClient,
+    IActionDispatcher,
     InitializeParameters,
     LazyInjector,
     MaybePromise,
@@ -30,7 +31,6 @@ import {
     hasNumberProp
 } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { GLSPActionDispatcher } from '../action-dispatcher';
 import { Ranked } from '../ranked';
 import { GLSPModelSource } from './glsp-model-source';
 import { ModelInitializationConstraint } from './model-initialization-constraint';
@@ -148,8 +148,8 @@ export class DiagramLoader {
     @inject(TYPES.IDiagramOptions)
     protected options: IDiagramOptions;
 
-    @inject(GLSPActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher)
+    protected actionDispatcher: IActionDispatcher;
 
     @inject(GLSPModelSource)
     protected modelSource: GLSPModelSource;

diff --git a/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-palette.ts b/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-palette.ts
@@ -13,28 +13,28 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { injectable } from 'inversify';
 import {
+    Action,
     codiconCSSString,
-    isConnectable,
+    CreateEdgeOperation,
     GModelElement,
     GModelRoot,
+    IActionHandler,
+    isConnectable,
     LabeledAction,
     name,
     SetUIExtensionVisibilityAction,
-    IActionHandler,
-    Action,
-    CreateEdgeOperation,
+    toArray,
     TriggerEdgeCreationAction
 } from '@eclipse-glsp/sprotty';
-import { EnableDefaultToolsAction } from '../../../base/tool-manager/tool';
-import { toArray } from 'sprotty/lib/utils/iterable';
-import { EdgeAutocompleteContext } from './edge-autocomplete-context';
-import { SearchAutocompletePalette } from '../search/search-palette';
-import { SetEdgeTargetSelectionAction } from './action';
+import { injectable } from 'inversify';
 import { CloseReason, toActionArray } from '../../../base/auto-complete/auto-complete-widget';
 import { AutocompleteSuggestion, IAutocompleteSuggestionProvider } from '../../../base/auto-complete/autocomplete-suggestion-providers';
+import { EnableDefaultToolsAction } from '../../../base/tool-manager/tool';
 import { GEdge } from '../../../model';
+import { SearchAutocompletePalette } from '../search/search-palette';
+import { SetEdgeTargetSelectionAction } from './action';
+import { EdgeAutocompleteContext } from './edge-autocomplete-context';
 
 export namespace EdgeAutocompletePaletteMetadata {
     export const ID = 'edge-autocomplete-palette';

diff --git a/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-tool.ts b/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-tool.ts
@@ -13,10 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Action, GModelElement, KeyListener, KeyTool, matchesKeystroke, SetUIExtensionVisibilityAction } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { KeyTool, KeyListener, SetUIExtensionVisibilityAction, GModelElement, Action } from '@eclipse-glsp/sprotty';
 import { Tool } from '../../../base/tool-manager/tool';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
 import { EdgeAutocompletePaletteMetadata } from './edge-autocomplete-palette';
 
 @injectable()

diff --git a/packages/client/src/features/accessibility/element-navigation/diagram-navigation-tool.ts b/packages/client/src/features/accessibility/element-navigation/diagram-navigation-tool.ts
@@ -18,6 +18,7 @@ import {
     Action,
     GModelElement,
     GModelRoot,
+    IActionDispatcher,
     KeyListener,
     KeyTool,
     SelectAction,
@@ -26,13 +27,13 @@ import {
     findParentByFeature,
     isBoundsAware,
     isSelectable,
-    isSelected
+    isSelected,
+    matchesKeystroke,
+    toArray
 } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { toArray } from 'sprotty/lib/utils/iterable';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
-import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
 import { EnableDefaultToolsAction, EnableToolsAction, Tool } from '../../../base/tool-manager/tool';
+import { GEdge } from '../../../model';
 import { SelectableBoundsAware } from '../../../utils/gmodel-util';
 import { RepositionAction } from '../../viewport/reposition';
 import { SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
@@ -41,7 +42,6 @@ import { SearchAutocompletePaletteTool } from '../search/search-tool';
 import * as messages from '../toast/messages.json';
 import { ShowToastMessageAction } from '../toast/toast-handler';
 import { ElementNavigator } from './element-navigator';
-import { GEdge } from '../../../model';
 
 @injectable()
 export class ElementNavigatorTool implements Tool {
@@ -53,7 +53,7 @@ export class ElementNavigatorTool implements Tool {
     @inject(KeyTool) protected readonly keytool: KeyTool;
     @inject(TYPES.IElementNavigator) readonly elementNavigator: ElementNavigator;
     @inject(TYPES.ILocalElementNavigator) readonly localElementNavigator: ElementNavigator;
-    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: IActionDispatcher;
 
     get id(): string {
         return ElementNavigatorTool.ID;

diff --git a/...s/client/src/features/accessibility/element-navigation/left-right-top-bottom-navigator.ts b/...s/client/src/features/accessibility/element-navigation/left-right-top-bottom-navigator.ts
@@ -14,12 +14,11 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { EdgeRouterRegistry, findParentByFeature, GModelElement, GModelRoot, Point } from '@eclipse-glsp/sprotty';
+import { EdgeRouterRegistry, findParentByFeature, GModelElement, GModelRoot, Point, toArray } from '@eclipse-glsp/sprotty';
 import { inject, injectable, optional } from 'inversify';
-import { toArray } from 'sprotty/lib/utils/iterable';
+import { GEdge } from '../../../model';
 import { calcElementAndRoute, isRoutable, isSelectableAndBoundsAware, SelectableBoundsAware } from '../../../utils/gmodel-util';
 import { ElementNavigator } from './element-navigator';
-import { GEdge } from '../../../model';
 
 @injectable()
 export class LeftToRightTopToBottomElementNavigator implements ElementNavigator {

diff --git a/packages/client/src/features/accessibility/element-navigation/local-element-navigator.ts b/packages/client/src/features/accessibility/element-navigation/local-element-navigator.ts
@@ -13,9 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { EdgeRouterRegistry, GConnectableElement, GModelElement, GModelRoot, TYPES } from '@eclipse-glsp/sprotty';
+import { EdgeRouterRegistry, GConnectableElement, GModelElement, GModelRoot, IActionDispatcher, TYPES } from '@eclipse-glsp/sprotty';
 import { inject, injectable, optional } from 'inversify';
-import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
 import { applyCssClasses, deleteCssClasses } from '../../../base/feedback/css-feedback';
 import { GEdge } from '../../../model';
 import { BoundsAwareModelElement, SelectableBoundsAware } from '../../../utils/gmodel-util';
@@ -25,7 +24,7 @@ import { ElementNavigator } from './element-navigator';
 export class LocalElementNavigator implements ElementNavigator {
     navigableElementCSS = 'navigable-element';
     @inject(EdgeRouterRegistry) @optional() readonly edgeRouterRegistry?: EdgeRouterRegistry;
-    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: IActionDispatcher;
 
     previous(
         root: Readonly<GModelRoot>,

diff --git a/packages/client/src/features/accessibility/element-navigation/position-navigator.ts b/packages/client/src/features/accessibility/element-navigation/position-navigator.ts
@@ -14,16 +14,26 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
+import {
+    Bounds,
+    GChildElement,
+    GModelElement,
+    GModelRoot,
+    GNode,
+    IActionDispatcher,
+    Point,
+    TYPES,
+    isBoundsAware,
+    isSelectable,
+    toArray
+} from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { toArray } from 'sprotty/lib/utils/iterable';
-import { Bounds, GChildElement, Point, GModelElement, GModelRoot, GNode, TYPES, isBoundsAware, isSelectable } from '@eclipse-glsp/sprotty';
-import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
 import { SelectableBoundsAware } from '../../../utils/gmodel-util';
 import { ElementNavigator } from './element-navigator';
 
 @injectable()
 export class PositionNavigator implements ElementNavigator {
-    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: IActionDispatcher;
 
     previous(
         root: Readonly<GModelRoot>,

diff --git a/packages/client/src/features/accessibility/focus-tracker/focus-tracker-tool.ts b/packages/client/src/features/accessibility/focus-tracker/focus-tracker-tool.ts
@@ -14,9 +14,8 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
+import { IActionDispatcher, TYPES, ViewerOptions } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { TYPES, ViewerOptions } from '@eclipse-glsp/sprotty';
-import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
 import { Tool } from '../../../base/tool-manager/tool';
 import * as messages from '../toast/messages.json';
 import { ShowToastMessageAction } from '../toast/toast-handler';
@@ -27,7 +26,7 @@ export class FocusTrackerTool implements Tool {
 
     isEditTool = false;
     @inject(TYPES.IActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    protected actionDispatcher: IActionDispatcher;
     @inject(TYPES.ViewerOptions)
     protected readonly viewerOptions: ViewerOptions;
 

diff --git a/packages/client/src/features/accessibility/global-keylistener-tool.ts b/packages/client/src/features/accessibility/global-keylistener-tool.ts
@@ -13,16 +13,14 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Action, IActionDispatcher, matchesKeystroke, SetUIExtensionVisibilityAction, TYPES } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { SetUIExtensionVisibilityAction, Action } from '@eclipse-glsp/sprotty';
 import { Tool } from '../../base/tool-manager/tool';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { KeyboardGridMetadata, KeyboardNodeGridMetadata } from '../accessibility/keyboard-grid/constants';
 import { ToolPalette } from '../tool-palette/tool-palette';
 import { FocusDomAction } from './actions';
-import { KeyboardGridMetadata, KeyboardNodeGridMetadata } from '../accessibility/keyboard-grid/constants';
-import { KeyboardPointerMetadata } from './keyboard-pointer/constants';
 import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from './key-shortcut/accessible-key-shortcut';
-import { GLSPActionDispatcher } from '../../base/action-dispatcher';
+import { KeyboardPointerMetadata } from './keyboard-pointer/constants';
 import { KeyboardToolPalette } from './keyboard-tool-palette/keyboard-tool-palette';
 
 @injectable()
@@ -32,8 +30,8 @@ export class GlobalKeyListenerTool implements Tool, AccessibleKeyShortcutProvide
     isEditTool = false;
     protected alreadyRegistered = false;
 
-    @inject(GLSPActionDispatcher)
-    protected actionDispatcher: GLSPActionDispatcher;
+    @inject(TYPES.IActionDispatcher)
+    protected actionDispatcher: IActionDispatcher;
 
     get id(): string {
         return GlobalKeyListenerTool.ID;

diff --git a/packages/client/src/features/accessibility/keyboard-grid/keyboard-grid.ts b/packages/client/src/features/accessibility/keyboard-grid/keyboard-grid.ts
@@ -17,23 +17,24 @@ import '../../../../css/keyboard.css';
 
 import {
     Action,
-    ActionDispatcher,
     GModelRoot,
+    IActionDispatcher,
     IActionHandler,
     ICommand,
+    KeyCode,
+    matchesKeystroke,
     Point,
     SetUIExtensionVisibilityAction,
     TYPES
 } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { KeyCode, matchesKeystroke } from 'sprotty/lib/utils/keyboard';
 import { GLSPAbstractUIExtension } from '../../../base/ui-extension/ui-extension';
 import { EnableKeyboardGridAction, KeyboardGridCellSelectedAction, KeyboardGridKeyboardEventAction } from './action';
 import { KeyboardGridMetadata } from './constants';
 
 @injectable()
 export class KeyboardGrid extends GLSPAbstractUIExtension implements IActionHandler {
-    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: ActionDispatcher;
+    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: IActionDispatcher;
 
     protected triggerActions: Action[] = [];
     protected originId: string;

diff --git a/packages/client/src/features/accessibility/keyboard-grid/keyboard-node-grid.ts b/packages/client/src/features/accessibility/keyboard-grid/keyboard-node-grid.ts
@@ -15,14 +15,13 @@
  ********************************************************************************/
 import '../../../../css/keyboard.css';
 
+import { Action, ICommand, matchesKeystroke, SetUIExtensionVisibilityAction } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
-import { ICommand, SetUIExtensionVisibilityAction, Action } from '@eclipse-glsp/sprotty';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
-import { KeyboardPointer } from '../keyboard-pointer/keyboard-pointer';
 import { KeyboardPointerMetadata } from '../keyboard-pointer/constants';
-import { GridSearchPaletteMetadata } from './keyboard-grid-search-palette';
-import { KeyboardGrid } from './keyboard-grid';
+import { KeyboardPointer } from '../keyboard-pointer/keyboard-pointer';
 import { KeyboardNodeGridMetadata } from './constants';
+import { KeyboardGrid } from './keyboard-grid';
+import { GridSearchPaletteMetadata } from './keyboard-grid-search-palette';
 
 @injectable()
 export class KeyboardNodeGrid extends KeyboardGrid {

diff --git a/packages/client/src/features/accessibility/keyboard-pointer/keyboard-pointer-listener.ts b/packages/client/src/features/accessibility/keyboard-pointer/keyboard-pointer-listener.ts
@@ -14,14 +14,13 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { IActionDispatcher, SetUIExtensionVisibilityAction, CreateNodeOperation } from '@eclipse-glsp/sprotty';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { CreateNodeOperation, IActionDispatcher, matchesKeystroke, SetUIExtensionVisibilityAction } from '@eclipse-glsp/sprotty';
+import { CursorCSS } from '../../../base/feedback/css-feedback';
+import { EnableDefaultToolsAction } from '../../../base/tool-manager/tool';
 import { KeyboardNodeGridMetadata } from '../keyboard-grid/constants';
 import { KeyboardPointerMetadata } from './constants';
 import { KeyboardPointer } from './keyboard-pointer';
 import { KeyboardPointerPosition } from './keyboard-pointer-position';
-import { EnableDefaultToolsAction } from '../../../base/tool-manager/tool';
-import { CursorCSS } from '../../../base/feedback/css-feedback';
 
 /**
  * Keyboard listener for the pointer with the necessary logic to handle keyboard events