GLSP-211: Revise TypeHints and server side feedback for creation acti… (#60)

tortmayr · web-flow · commit 63971fcc9e7c · 2023-09-27T18:52:26.000+02:00
* GLSP-211: Revise TypeHints and server side feedback for creation actions (#210) - Add action handler for `RequestEdgeCheckAction` and `EdgeCreationChecker` API - Add a optional `EdgeCreationchecker` component that can be implemented by adopters to provide dynamic typehints - Adapt workflow example to use dynamic edge hints for weighted edges Also: Update eslint config to show warnings if we import from internal index instead of the relative path to the file Fixes eclipse-glsp/glsp/issues/211
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -16,7 +16,10 @@ module.exports = {
                 name: 'sprotty-protocol',
                 message:
                     "The sprotty-protocol default exports are customized and reexported by GLSP. Please import from '@eclipse-glsp/protocol' instead"
-            }
+            },
+            '.',
+            '..',
+            '../..'
         ]
     }
 };
diff --git a/examples/workflow-server/src/common/workflow-diagram-configuration.ts b/examples/workflow-server/src/common/workflow-diagram-configuration.ts
@@ -18,10 +18,10 @@ import {
     DiagramConfiguration,
     GCompartment,
     GEdge,
-    getDefaultMapping,
     GLabel,
     GModelElementConstructor,
-    ServerLayoutKind
+    ServerLayoutKind,
+    getDefaultMapping
 } from '@eclipse-glsp/server';
 import { injectable } from 'inversify';
 import { ActivityNode, Category, TaskNode } from './graph-extension';
@@ -58,15 +58,7 @@ export class WorkflowDiagramConfiguration implements DiagramConfiguration {
                 deletable: true,
                 resizable: true,
                 reparentable: true,
-                containableElementTypeIds: [
-                    types.DECISION_NODE,
-                    types.MERGE_NODE,
-                    types.FORK_NODE,
-                    types.JOIN_NODE,
-                    types.AUTOMATED_TASK,
-                    types.MANUAL_TASK,
-                    types.CATEGORY
-                ]
+                containableElementTypeIds: [types.TASK, types.ACTIVITY_NODE, types.CATEGORY]
             }
         ];
     }
@@ -79,8 +71,9 @@ export class WorkflowDiagramConfiguration implements DiagramConfiguration {
                 repositionable: true,
                 deletable: true,
                 routable: true,
-                sourceElementTypeIds: [types.DECISION_NODE],
-                targetElementTypeIds: [types.MANUAL_TASK, types.AUTOMATED_TASK, types.FORK_NODE, types.JOIN_NODE]
+                dynamic: true,
+                sourceElementTypeIds: [types.ACTIVITY_NODE],
+                targetElementTypeIds: [types.TASK, types.ACTIVITY_NODE]
             }
         ];
     }
diff --git a/examples/workflow-server/src/common/workflow-diagram-module.ts b/examples/workflow-server/src/common/workflow-diagram-module.ts
@@ -20,6 +20,7 @@ import {
     ContextEditValidator,
     ContextMenuItemProvider,
     DiagramConfiguration,
+    EdgeCreationChecker,
     GLSPServer,
     GModelDiagramModule,
     InstanceMultiBinding,
@@ -55,6 +56,7 @@ import { EditTaskOperationHandler } from './taskedit/edit-task-operation-handler
 import { TaskEditContextActionProvider } from './taskedit/task-edit-context-provider';
 import { TaskEditValidator } from './taskedit/task-edit-validator';
 import { WorkflowDiagramConfiguration } from './workflow-diagram-configuration';
+import { WorkflowEdgeCreationChecker } from './workflow-edge-creation-checker';
 import { WorkflowGLSPServer } from './workflow-glsp-server';
 import { WorkflowPopupFactory } from './workflow-popup-factory';
 
@@ -133,4 +135,8 @@ export class WorkflowDiagramModule extends GModelDiagramModule {
         super.configureContextEditValidators(binding);
         binding.add(TaskEditValidator);
     }
+
+    protected override bindEdgeCreationChecker(): BindingTarget<EdgeCreationChecker> | undefined {
+        return WorkflowEdgeCreationChecker;
+    }
 }
diff --git a/examples/workflow-server/src/common/workflow-edge-creation-checker.ts b/examples/workflow-server/src/common/workflow-edge-creation-checker.ts
@@ -0,0 +1,31 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { EdgeCreationChecker, GModelElement } from '@eclipse-glsp/server/';
+import { injectable } from 'inversify';
+import { TaskNode } from './graph-extension';
+import { ModelTypes } from './util/model-types';
+
+@injectable()
+export class WorkflowEdgeCreationChecker implements EdgeCreationChecker {
+    isValidSource(edgeType: string, sourceElement: GModelElement): boolean {
+        return edgeType !== ModelTypes.WEIGHTED_EDGE || sourceElement.type === ModelTypes.DECISION_NODE;
+    }
+    isValidTarget(edgeType: string, sourceElement: GModelElement, targetElement: GModelElement): boolean {
+        return (
+            targetElement instanceof TaskNode || targetElement.type === ModelTypes.FORK_NODE || targetElement.type === ModelTypes.JOIN_NODE
+        );
+    }
+}
diff --git a/packages/server/src/common/di/diagram-module.ts b/packages/server/src/common/di/diagram-module.ts
@@ -21,7 +21,6 @@ import { ClientActionForwarder } from '../actions/client-action-handler';
 import { CommandStack, DefaultCommandStack } from '../command/command-stack';
 import { UndoRedoActionHandler } from '../command/undo-redo-action-handler';
 import { DiagramConfiguration } from '../diagram/diagram-configuration';
-import { RequestTypeHintsActionHandler } from '../diagram/request-type-hints-action-handler';
 import { CommandPaletteActionProvider } from '../features/contextactions/command-palette-action-provider';
 import { ContextActionsProvider } from '../features/contextactions/context-actions-provider';
 import { ContextActionsProviderRegistry } from '../features/contextactions/context-actions-provider-registry';
@@ -57,6 +56,9 @@ import { ResolveNavigationTargetsActionHandler } from '../features/navigation/re
 import { PopupModelFactory } from '../features/popup/popup-model-factory';
 import { RequestPopupModelActionHandler } from '../features/popup/request-popup-model-action-handler';
 import { DefaultProgressService, ProgressService } from '../features/progress/progress-service';
+import { EdgeCreationChecker } from '../features/type-hints/edge-creation-checker';
+import { RequestCheckEdgeActionHandler } from '../features/type-hints/request-check-edge-action-handler';
+import { RequestTypeHintsActionHandler } from '../features/type-hints/request-type-hints-action-handler';
 import { ModelValidator } from '../features/validation/model-validator';
 import { RequestMarkersHandler } from '../features/validation/request-markers-handler';
 import { CompoundOperationHandler } from '../operations/compound-operation-handler';
@@ -121,6 +123,7 @@ import {
  * - {@link ClientSessionInitializer} as {@link ClassMultiBinding<ClientSessionInitializer>}
  * - {@link PopupModelFactory}  as optional binding
  * - {@link LayoutEngine}  as optional binding
+ * - {@link EdgeCreationChecker}  as optional binding
  */
 
 export abstract class DiagramModule extends GLSPModule {
@@ -172,7 +175,7 @@ export abstract class DiagramModule extends GLSPModule {
         applyBindingTarget(context, CommandStack, this.bindCommandStack()).inSingletonScope();
 
         // Navigation
-        applyOptionalBindingTarget(context, NavigationTargetResolver, this.bindNavigationTargetResolver());
+        applyOptionalBindingTarget(context, NavigationTargetResolver, this.bindNavigationTargetResolver())?.inSingletonScope();
         this.configureMultiBinding(new MultiBinding<NavigationTargetProvider>(NavigationTargetProviders), binding =>
             this.configureNavigationTargetProviders(binding)
         );
@@ -189,8 +192,9 @@ export abstract class DiagramModule extends GLSPModule {
             this.configureClientSessionInitializers(binding)
         );
         applyBindingTarget(context, ProgressService, this.bindProgressService()).inSingletonScope();
-        applyOptionalBindingTarget(context, PopupModelFactory, this.bindPopupModelFactory());
-        applyOptionalBindingTarget(context, LayoutEngine, this.bindLayoutEngine?.());
+        applyOptionalBindingTarget(context, PopupModelFactory, this.bindPopupModelFactory())?.inSingletonScope();
+        applyOptionalBindingTarget(context, LayoutEngine, this.bindLayoutEngine())?.inSingletonScope();
+        applyOptionalBindingTarget(context, EdgeCreationChecker, this.bindEdgeCreationChecker())?.inSingletonScope();
     }
 
     configureClientSessionInitializers(binding: MultiBinding<ClientSessionInitializer>): void {
@@ -203,6 +207,7 @@ export abstract class DiagramModule extends GLSPModule {
         binding.add(RequestContextActionsHandler);
         binding.add(RequestTypeHintsActionHandler);
         binding.add(OperationActionHandler);
+        binding.add(RequestCheckEdgeActionHandler);
         binding.add(RequestMarkersHandler);
         binding.add(RequestPopupModelActionHandler);
         binding.add(RequestEditValidationHandler);
@@ -331,16 +336,19 @@ export abstract class DiagramModule extends GLSPModule {
     protected bindModelValidator(): BindingTarget<ModelValidator> | undefined {
         return undefined;
     }
+
     protected bindLabelEditValidator(): BindingTarget<LabelEditValidator> | undefined {
         return undefined;
     }
 
     protected bindToolPaletteItemProvider(): BindingTarget<ToolPaletteItemProvider> | undefined {
         return DefaultToolPaletteItemProvider;
     }
+
     protected bindCommandPaletteActionProvider(): BindingTarget<CommandPaletteActionProvider> | undefined {
         return undefined;
     }
+
     protected bindContextMenuItemProvider(): BindingTarget<ContextMenuItemProvider> | undefined {
         return undefined;
     }
@@ -352,7 +360,12 @@ export abstract class DiagramModule extends GLSPModule {
     protected bindPopupModelFactory(): BindingTarget<PopupModelFactory> | undefined {
         return undefined;
     }
+
     protected bindLayoutEngine(): BindingTarget<LayoutEngine> | undefined {
         return undefined;
     }
+
+    protected bindEdgeCreationChecker(): BindingTarget<EdgeCreationChecker> | undefined {
+        return undefined;
+    }
 }
diff --git a/packages/server/src/common/features/type-hints/edge-creation-checker.ts b/packages/server/src/common/features/type-hints/edge-creation-checker.ts
@@ -0,0 +1,44 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { GModelElement } from '@eclipse-glsp/graph';
+
+/**
+ * Optional service used to check the validity of an edge being created. Used in combination with `dynamic`
+ * `EdgeTypeHints`.
+ * A dynamic edge type hint is used for cases where a plain list of allowed source and target element ids is not enough
+ * to determine wether an edge being created is valid. In this cases the client will query the server to determine wether the edge
+ * is valid. The `EdgeCreationChecker` then checks the given edge information and returns wether the edge being created is
+ * valid.
+ */
+export interface EdgeCreationChecker {
+    /**
+     * Checks wether the given source element for an edge being created is valid i.e. if the
+     * given source is and allowed source element for the given edge type.
+     *
+     * @returns `true` if the edge source is valid, `false` otherwise
+     */
+    isValidSource(edgeType: string, sourceElement: GModelElement): boolean;
+
+    /**
+     * Checks wether the given information for an edge being created is valid i.e. if the
+     * given target is an allowed target for the given source and edge type.
+     *
+     * @return `true` if the edge target is valid, `false` otherwise
+     */
+    isValidTarget(edgeType: string, sourceElement: GModelElement, targetElement: GModelElement): boolean;
+}
+export const EdgeCreationChecker = Symbol('EdgeCreationChecker');
diff --git a/packages/server/src/common/features/type-hints/request-check-edge-action-handler.ts b/packages/server/src/common/features/type-hints/request-check-edge-action-handler.ts
@@ -0,0 +1,62 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { Action, CheckEdgeResultAction, MaybePromise, RequestCheckEdgeAction } from '@eclipse-glsp/protocol';
+import { inject, injectable, optional } from 'inversify';
+import { ActionHandler } from '../../actions/action-handler';
+import { DiagramConfiguration } from '../../diagram/diagram-configuration';
+import { GLSPServerError, getOrThrow } from '../../utils/glsp-server-error';
+import { ModelState } from '../model/model-state';
+import { EdgeCreationChecker } from './edge-creation-checker';
+
+@injectable()
+export class RequestCheckEdgeActionHandler implements ActionHandler {
+    @inject(ModelState)
+    protected modelState: ModelState;
+
+    @inject(DiagramConfiguration)
+    protected diagramConfiguration: DiagramConfiguration;
+
+    @inject(EdgeCreationChecker)
+    @optional()
+    protected edgeCreationChecker?: EdgeCreationChecker;
+
+    readonly actionKinds: string[] = [RequestCheckEdgeAction.KIND];
+
+    execute(action: RequestCheckEdgeAction): MaybePromise<Action[]> {
+        const hasDynamicHint = this.diagramConfiguration.edgeTypeHints.some(hint => hint.elementTypeId === action.edgeType && hint.dynamic);
+        const { edgeType, sourceElementId, targetElementId } = action;
+        const isValid = this.edgeCreationChecker && hasDynamicHint ? this.validate(action) : true;
+
+        return [CheckEdgeResultAction.create({ edgeType, isValid, sourceElementId, targetElementId })];
+    }
+
+    protected validate(action: RequestCheckEdgeAction): boolean {
+        const sourceElement = getOrThrow(
+            this.modelState.index.get(action.sourceElementId),
+            'Invalid `RequestCheckEdgeTargetAction`!. Could not find a source element with id: ' + action.sourceElementId
+        );
+        const targetElement = action.targetElementId ? this.modelState.index.get(action.targetElementId) : undefined;
+
+        if (action.targetElementId && !targetElement) {
+            throw new GLSPServerError(
+                'Invalid `RequestCheckEdgeTargetAction`! Could not find a target element with id: ' + action.targetElementId
+            );
+        }
+        return targetElement
+            ? this.edgeCreationChecker!.isValidTarget(action.edgeType, sourceElement, targetElement)
+            : this.edgeCreationChecker!.isValidSource(action.edgeType, sourceElement);
+    }
+}
diff --git a/packages/server/src/common/features/type-hints/request-type-hints-action-handler.spec.ts b/packages/server/src/common/features/type-hints/request-type-hints-action-handler.spec.ts
@@ -16,8 +16,8 @@
 import { EdgeTypeHint, RequestTypeHintsAction, SetTypeHintsAction, ShapeTypeHint } from '@eclipse-glsp/protocol';
 import { expect } from 'chai';
 import { Container, ContainerModule } from 'inversify';
-import * as mock from '../test/mock-util';
-import { DiagramConfiguration } from './diagram-configuration';
+import { DiagramConfiguration } from '../../diagram/diagram-configuration';
+import * as mock from '../../test/mock-util';
 import { RequestTypeHintsActionHandler } from './request-type-hints-action-handler';
 
 describe('test RequestTypeHintsActionHandler', () => {
diff --git a/packages/server/src/common/features/type-hints/request-type-hints-action-handler.ts b/packages/server/src/common/features/type-hints/request-type-hints-action-handler.ts
@@ -15,13 +15,12 @@
  ********************************************************************************/
 import { Action, MaybePromise, RequestTypeHintsAction, SetTypeHintsAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
-import { ActionHandler } from '../actions/action-handler';
-import { DiagramConfiguration } from './diagram-configuration';
+import { ActionHandler } from '../../actions/action-handler';
+import { DiagramConfiguration } from '../../diagram/diagram-configuration';
 
 @injectable()
 export class RequestTypeHintsActionHandler implements ActionHandler {
     @inject(DiagramConfiguration) protected diagramConfiguration: DiagramConfiguration;
-    static KINDS = [RequestTypeHintsAction.KIND];
 
     execute(action: RequestTypeHintsAction): MaybePromise<Action[]> {
         return [
diff --git a/packages/server/src/common/index.ts b/packages/server/src/common/index.ts
@@ -33,7 +33,6 @@ export * from './di/multi-binding';
 export * from './di/server-module';
 export * from './di/service-identifiers';
 export * from './diagram/diagram-configuration';
-export * from './diagram/request-type-hints-action-handler';
 export * from './features/clipboard/request-clipboard-data-action-handler';
 export * from './features/contextactions/command-palette-action-provider';
 export * from './features/contextactions/context-actions-provider';
@@ -65,6 +64,8 @@ export * from './features/navigation/request-navigation-targets-action-handler';
 export * from './features/navigation/resolve-navigation-targets-action-handler';
 export * from './features/popup/popup-model-factory';
 export * from './features/popup/request-popup-model-action-handler';
+export * from './features/type-hints/edge-creation-checker';
+export * from './features/type-hints/request-type-hints-action-handler';
 export * from './features/validation/model-validator';
 export * from './features/validation/request-markers-handler';
 export * from './gmodel/index';
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,10 @@ module.exports = {`
`16`	`16`	`name: 'sprotty-protocol',`
`17`	`17`	`message:`
`18`	`18`	`"The sprotty-protocol default exports are customized and reexported by GLSP. Please import from '@eclipse-glsp/protocol' instead"`
`19`		`- }`
	`19`	`+ },`
	`20`	`+ '.',`
	`21`	`+ '..',`
	`22`	`+ '../..'`
`20`	`23`	`]`
`21`	`24`	`}`
`22`	`25`	`};`