Handlers for Smart Connector UIExtension #70

yentelmanero · 2023-11-30T15:00:05Z

This PR is part of my bachelor research conducted in TU Wien in the Business Informatics Group.

In this PR, the ActionHandler and ContextActionProvider as well as the related workflow example implementations for the Smart Connector UIExtension are included (more info on Smart Connector in Client PR)

Client PR
Theia PR

…t, right, up, down)

haydar-metin · 2023-12-19T13:02:34Z

Thanks for the PR! I will test it after the changes are done!

Can you also add some description to your PR and reference the other PRs you have created, something like:

This PR is part of my bachelor research conducted in TU Wien in the [Business Informatics Group](https://www.big.tuwien.ac.at/).

---

<Little Description>

<Other PR references>

packages/server/src/common/di/diagram-module.ts

packages/server/src/common/features/contextactions/smart-connector-action-handler.ts

examples/workflow-server/src/common/provider/workflow-smart-connector-item-provider.ts

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

haydar-metin · 2023-12-19T12:46:39Z

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

+
+    createSmartConnectorGroupItem(handlers: CreateOperationHandler[], kind: string, selectedNodeType: string,
+            showOnly?: SmartConnectorGroupUIType): PaletteItem[] {
+        const includedInNodeFilter = (e: string): boolean => this.nodeOperationFilter[selectedNodeType].includes(e);


The this.nodeOperationFilter[selectedNodeType].includes(e) part can cause an error if the selectedNodeType does not exist in nodeOperationFilter. Check the updated types provided before.

Solution could be something like !!this.nodeOperationFilter[selectedNodeType]?.includes(e)

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

haydar-metin

LGTM, just small changes

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

examples/workflow-server/src/common/provider/workflow-smart-connector-item-provider.ts

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

merge newest to fork

yentelmanero · 2024-02-01T22:00:57Z

Did not mean to mention that PR with that last commit

tortmayr

Thanks, in general the code looks good to me.
I have a few inline comments/suggestions.
As discussed offline we like to have a more generic SelectionPaletteProvider API instead of the SmartConnectorAPI. Please rename the artifacts accordingly.

Other than that the change works really well!

tortmayr · 2024-03-24T21:30:38Z

examples/workflow-server/src/common/provider/workflow-smart-connector-item-provider.ts

+    };
+
+    protected override nodeOperationFilter = {
+        [ModelTypes.AUTOMATED_TASK]: [ModelTypes.WEIGHTED_EDGE, ModelTypes.AUTOMATED_TASK, ModelTypes.MANUAL_TASK,


This could be handled generically. All the required information is present in the typehints of the DiagramConfiguration.
Could be moved up to the DefaultSmartConnectorProvider.

I don't expect that this is handled with this PR but we should create a follow-up for that.

tortmayr · 2024-03-24T21:33:04Z

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

+ * A {@link ContextActionsProvider} for {@link PaletteItem}s in the Smart Connector which appears when a node is selected.
+ */
+@injectable()
+export abstract class SmartConnectorItemProvider implements ContextActionsProvider {


As discussed offline we would like to use a more generic SelectionPaletteProvider API (that is inline with CommandPaletteProvider and ToolpaletteProvider) and the current SmartConnector is then just the default implementation of that provider.
So please rename this to SelectionPaletteProvider.

tortmayr · 2024-03-24T21:33:50Z

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

+      };
+
+@injectable()
+export class DefaultSmartConnectorItemProvider extends SmartConnectorItemProvider {


Suggested change

export class DefaultSmartConnectorItemProvider extends SmartConnectorItemProvider {

export class DefaultSelectionPaletteProvider` extends SelectionPaletteProvider {

tortmayr · 2024-03-24T21:34:42Z

packages/server/src/common/features/contextactions/smart-connector-item-provider.ts

+     * Returns the context id of the provider.
+     */
+    get contextId(): string {
+        return 'smart-connector';


Suggested change

return 'smart-connector';

return 'selection-palette';

tortmayr · 2024-03-24T21:38:05Z

packages/server/src/common/gmodel/gmodel-create-node-operation-handler.ts

@@ -54,6 +54,14 @@ export abstract class GModelCreateNodeOperationHandler extends GModelOperationHa
            container.children.push(element);
            element.parent = container;
            this.actionDispatcher.dispatchAfterNextUpdate(SelectAction.create({ selectedElementsIDs: [element.id] }));
+            // Creates default edge on node creation when a source ID is given in the CreateNodeOperation


I understand why this is done this way, but we should find a more generic solution here.

Ideally we would dispatch a CompoundOperation on the client-side that contains the CreateNode and CreateEdge operations. Currently the API does not support this, because we need context-specific information. i.e. the CreateEdge operation needs to know the id of the newly created node it should connect to.

We should create a follow-up for that.

tortmayr · 2024-03-24T21:39:48Z

packages/server/src/common/features/contextactions/smart-connector-action-handler.ts

+import { GNode } from '@eclipse-glsp/graph';
+
+@injectable()
+export class OpenSmartConnectorActionHandler implements ActionHandler {


This should be handled entirely on client side.
The server should only provide the selection palette actions via the RequestContextActions handler but should not need to know any other implementation details about how they will be handled/rendered on the client side.

tortmayr · 2024-03-24T21:41:32Z

packages/server/src/common/di/diagram-module.ts

@@ -216,6 +219,7 @@ export abstract class DiagramModule extends GLSPModule {
        binding.add(SaveModelActionHandler);
        binding.add(UndoRedoActionHandler);
        binding.add(ComputedBoundsActionHandler);
+        binding.add(OpenSmartConnectorActionHandler);


Should be handled on client side

…handler, is now handled client side

tortmayr · 2024-04-24T10:25:47Z

@yentelmanero
Thank your for this awesome contribution.
I have reviewed and tested the changes. Everything seems to work as expected and all review comments have been addressed.
Nice work!

We will keep this PR open and merge it after the 2.2.0 Release is done (end of May). This way we have a full release cycle to polish the feature and address follow-up issues before we are shipping it to adopters.

In any case, from our side this concludes the practical aspect of your bachelor thesis. We don't require/desire any more changes from your side. Congrats!

yentelmanero added 7 commits October 30, 2023 23:06

added server components (handler, item provider) for smart connector

32ceb71

added possibility to set position for smart connector containers (lef…

ca2e9b1

…t, right, up, down)

Merge remote-tracking branch 'upstream/main'

510c9f7

added customization options and workflow example for smart connector

85cb92c

Merge remote-tracking branch 'upstream/main'

b79650e

addressed lint issues

8b77069

Merge branch 'main' of https://github.com/yentelmanero/glsp-server-node

0edc62d

haydar-metin suggested changes Dec 19, 2023

View reviewed changes

yentelmanero mentioned this pull request Dec 27, 2023

CSS for Smart Connector UIExtension eclipse-glsp/glsp-theia-integration#188

Open

Implemented suggested changes from PR

cb71c3b

yentelmanero mentioned this pull request Dec 27, 2023

Smart Connector UIExtension eclipse-glsp/glsp-client#308

Open

haydar-metin reviewed Jan 10, 2024

View reviewed changes

yentelmanero and others added 2 commits January 30, 2024 15:28

Merge pull request #1 from eclipse-glsp/main

1f8cb5a

merge newest to fork

Implemented suggested changes from PR eclipse-glsp#2

6a88438

yentelmanero and others added 2 commits February 12, 2024 01:17

Merge branch 'eclipse-glsp:main' into main

19d6020

applied prettier formatting

c6ba7bd

tortmayr self-requested a review March 25, 2024 08:00

tortmayr requested changes Mar 25, 2024

View reviewed changes

yentelmanero added 2 commits April 1, 2024 18:02

renamed smart connector to selection palette, removed related action …

6b01139

…handler, is now handled client side

renamed createSelectionPaletteItems to createSelectionPaletteItem

c97bc4b

tortmayr self-requested a review April 24, 2024 10:25

tortmayr approved these changes Apr 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handlers for Smart Connector UIExtension #70

Handlers for Smart Connector UIExtension #70

yentelmanero commented Nov 30, 2023 •

edited

haydar-metin commented Dec 19, 2023 •

edited

haydar-metin Dec 19, 2023

haydar-metin Dec 19, 2023

haydar-metin left a comment

yentelmanero commented Feb 1, 2024

tortmayr left a comment

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr Mar 24, 2024

tortmayr commented Apr 24, 2024

	export class DefaultSmartConnectorItemProvider extends SmartConnectorItemProvider {
	export class DefaultSelectionPaletteProvider` extends SelectionPaletteProvider {

Handlers for Smart Connector UIExtension #70

Are you sure you want to change the base?

Handlers for Smart Connector UIExtension #70

Conversation

yentelmanero commented Nov 30, 2023 • edited

haydar-metin commented Dec 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haydar-metin left a comment

Choose a reason for hiding this comment

yentelmanero commented Feb 1, 2024

tortmayr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tortmayr commented Apr 24, 2024

yentelmanero commented Nov 30, 2023 •

edited

haydar-metin commented Dec 19, 2023 •

edited