[2418] Extract synchronize with selection into a hook #2419

gcoutable · 2023-09-26T09:11:36Z

Pull request template

General purpose

What is the main goal of this pull request?

Project management

Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
Have the relevant issues been added to the pull request?
Have the relevant labels been added to the issues? (area:, difficulty:, type:)
Have the relevant issues been added to the same project and milestone as the pull request?
Has the CHANGELOG.adoc been updated to reference the relevant issues?
Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

Does the title of the commit contributing the ADR start with [doc]?
Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

Are all the event handlers tested?
Are the event processor tested?
Is the business code (services) tested?
Are diagram layout changes tested?

Architecture

Are data structure classes properly separated from behavioral classes?
Are all the relevant fields final?
Is any data structure mutable? If so, please write a comment indicating why
Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

Has the Kiwi TCMS test suite been updated with tests for this contribution?

CHANGELOG.adoc

pcdavid · 2023-12-11T13:17:30Z

CHANGELOG.adoc

@@ -156,6 +158,7 @@ These color palettes are accessible in studio projects but are not visible in th
 - [ADR-104] Add support for Help Expressions in Form widgets
 - [ADR-105] Add custom widget to edit EMF references
 - [ADR-106] Add the support for the palette with react flow
+- [ADR-107] - Improve frontend selection support


Should be moved to 2023.12 (and remove the " -" which is not present in the others.

We're now at ADR 122, this would be (at least) ADR 123.

pcdavid · 2023-12-11T13:27:16Z

doc/adrs/107_improve_frontend_selection_support.adoc

+
+```
+
+This makes sense because the selection is relative to a particular project/editing context.


Actually, maybe not always.
I am working on Portals support, where one I need more control on how the selection inside the representations displayed in a portal are synchronized with the global, project-wide selection.

This is just a remark, it seems that even with this new approach I should be able to locally override the selection handling for my case. It might be worth mentioning, you decide.

Actually I see that the pattern is used in e.g. modals to get a local selection.

pcdavid · 2023-12-11T13:29:06Z

doc/adrs/107_improve_frontend_selection_support.adoc

@@ -0,0 +1,75 @@
+= ADR-107 - Improve frontend selection support


This does not mention the SynchonizeWithSelection API also added here.

pcdavid · 2023-12-11T13:35:56Z

packages/core/frontend/sirius-components-core/src/selection/SelectionContext.tsx

+
+  const setSelection = useCallback((selection: Selection) => {
+    const selectedRepresentation = selection.entries.filter(isRepresentation);
+    setState((prevState) => ({ ...prevState, selection, selectedRepresentation }));


selectedRepresentation is not declared in SelectionContextProviderState.
If the frontend still compiles I guess it means it's not actually used anywhere?

I suppose it should be used in the workbench, but the code there continues to read the full selection and do its own filtering (equivalent to this one):

const representations: Representation[] = selection.entries.filter((entry) => entry.kind.startsWith('siriusComponents://representation') );

pcdavid · 2023-12-11T13:46:06Z

packages/core/frontend/sirius-components-core/src/workbench/WorkbenchMachine.ts

@@ -170,9 +148,9 @@ export const workbenchMachine = Machine<WorkbenchContext, WorkbenchStateSchema,

          const newSelectedRepresentations = [...representations, ...newRepresentations];

-          return { selection, displayedRepresentation, representations: newSelectedRepresentations };
+          return { displayedRepresentation, representations: newSelectedRepresentations };


It seems we're losing the test we had before which prevented "changing" the state with the same selected representations.

packages/trees/frontend/sirius-components-trees/src/views/ExplorerView.tsx

packages/sirius-web/frontend/sirius-web/src/views/edit-project/EditProjectView.tsx

pcdavid · 2023-12-11T13:56:34Z

...eb/src/views/edit-project/TreeToolBarContributions/SynchronizedWithSelectionContribution.tsx

+    toggleSynchronizeWithSelection();
+  };
+
+  const preferenceButtonSynchroniseTitle = isSynchronized


The code uses the US spelling ("synchroni[z]ed" with a "z") except for here (variable names an titles, use the UK spelling, with an "s").

Obsolete.

gcoutable · 2023-12-19T14:33:42Z

I have some doubt about the implementation here, @sbegaudeau we should discuss about that

Bug: #2418 Signed-off-by: Guillaume Coutable <guillaume.coutable@obeo.fr>

gcoutable added pr: to review later priority: low labels Sep 26, 2023

gcoutable added this to the 2023.12.0 milestone Sep 26, 2023

gcoutable requested review from pcdavid and sbegaudeau as code owners September 26, 2023 09:11

gcoutable linked an issue Sep 26, 2023 that may be closed by this pull request

Extract synchonize with selection from the TreeToolBar into a hook #2418

Open

sbegaudeau modified the milestones: 2023.12.0, 2024.1.0 Nov 23, 2023

gcoutable force-pushed the gco/enh/useselection branch from 3be6959 to b257a82 Compare December 4, 2023 16:32

gcoutable requested a review from AxelRICHARD as a code owner December 4, 2023 16:32

gcoutable force-pushed the gco/enh/useselection branch from b257a82 to 7ea4569 Compare December 4, 2023 16:34

pcdavid previously requested changes Dec 11, 2023

View reviewed changes

sbegaudeau force-pushed the gco/enh/useselection branch 8 times, most recently from 35cbc34 to e262c60 Compare December 15, 2023 13:23

Base automatically changed from gco/enh/useselection to master December 15, 2023 13:39

gcoutable force-pushed the gco/enh/synchronizeWithSelection-hook branch 2 times, most recently from a30af8c to 2ee28ac Compare December 19, 2023 14:23

gcoutable assigned sbegaudeau Dec 19, 2023

gcoutable force-pushed the gco/enh/synchronizeWithSelection-hook branch 2 times, most recently from 5aeaf09 to 05b3848 Compare December 19, 2023 14:44

sbegaudeau modified the milestones: 2024.1.0, 2024.3.0 Jan 23, 2024

gcoutable modified the milestones: 2024.3.0, 2024.5.0 Apr 2, 2024

gcoutable force-pushed the gco/enh/synchronizeWithSelection-hook branch from 05b3848 to 1faf644 Compare April 2, 2024 10:42

[2418] Extract synchronize with selection into a hook

42cfbaa

Bug: #2418 Signed-off-by: Guillaume Coutable <guillaume.coutable@obeo.fr>

gcoutable force-pushed the gco/enh/synchronizeWithSelection-hook branch from 1faf644 to 42cfbaa Compare April 2, 2024 10:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2418] Extract synchronize with selection into a hook #2419

[2418] Extract synchronize with selection into a hook #2419

gcoutable commented Sep 26, 2023

pcdavid Dec 11, 2023

gcoutable Apr 2, 2024

pcdavid Dec 11, 2023

pcdavid Dec 11, 2023

pcdavid Dec 11, 2023

pcdavid Dec 11, 2023

pcdavid Dec 11, 2023

pcdavid Dec 11, 2023

gcoutable commented Dec 19, 2023


		```

		This makes sense because the selection is relative to a particular project/editing context.

		@@ -0,0 +1,75 @@
		= ADR-107 - Improve frontend selection support

[2418] Extract synchronize with selection into a hook #2419

Are you sure you want to change the base?

[2418] Extract synchronize with selection into a hook #2419

Conversation

gcoutable commented Sep 26, 2023

Pull request template

General purpose

Project management

Architectural decision records (ADR)

Dependencies

Frontend

General purpose

Typing

Backend

General purpose

Architecture

Review

How to test this PR?

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

gcoutable commented Dec 19, 2023