Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[4286] Make default explorer DnD work only for the default explorer #4288

Merged
merged 1 commit into from
Jan 13, 2025
Merged

[4286] Make default explorer DnD work only for the default explorer #4288

merged 1 commit into from
Jan 13, 2025

Conversation

gdaniel
Copy link
Contributor

@gdaniel gdaniel commented Dec 11, 2024

Bug: #4286

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

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).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

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?

gdaniel
gdaniel commented Dec 11, 2024
View reviewed changes
...clipse/sirius/web/application/studio/services/representations/DomainDropTreeItemHandler.java Outdated
* @author gdaniel
*/
@Service
public class DomainDropTreeItemHandler extends ExplorerDropTreeItemHandler implements IDropTreeItemHandler {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this class to keep the existing behavior in the domain explorer. This may be a wrong idea, because it adds an IDropTreeItemHandler in all the downstream applications (even if it won't work in these applications).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I you want to share some behavior between DomainDropTreeItemHandler and ExplorerDropTreeItemHandler, you will need to do it thanks to composition not inheritance.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

gdaniel
gdaniel commented Dec 11, 2024
View reviewed changes
...rc/main/java/org/eclipse/sirius/components/collaborative/trees/api/IDropTreeItemHandler.java
@@ -24,7 +24,7 @@
*/
public interface IDropTreeItemHandler {

boolean canHandle(Tree tree);
boolean canHandle(IEditingContext editingContext, Tree tree);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the editingContext parameter for handlers that need to access it (e.g. to retrieve the view description of the explorer tree)

@AxelRICHARD AxelRICHARD added this to the 2025.1.0 milestone Dec 12, 2024
@AxelRICHARD AxelRICHARD linked an issue Dec 12, 2024 that may be closed by this pull request
Make ExplorerDropTreeItemHandler work only for the default explorer #4286
Closed
1 task
AxelRICHARD
AxelRICHARD reviewed Dec 13, 2024
View reviewed changes
Copy link
Contributor

@AxelRICHARD AxelRICHARD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small remark, but otherwise it is ok on my side.
@sbegaudeau if it is ok for you I will merge it as soon as possible.

...rc/main/java/org/eclipse/sirius/components/collaborative/trees/api/IDropTreeItemHandler.java
@@ -24,7 +24,7 @@
*/
public interface IDropTreeItemHandler {

boolean canHandle(Tree tree);
boolean canHandle(IEditingContext editingContext, Tree tree);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an API break, you should update the CHANGELOG accordingly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@gdaniel gdaniel force-pushed the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch from 2aab1f7 to 578bb28 Compare December 13, 2024 14:02
sbegaudeau
sbegaudeau requested changes Dec 18, 2024
View reviewed changes
...clipse/sirius/web/application/studio/services/representations/DomainDropTreeItemHandler.java Outdated
* @author gdaniel
*/
@Service
public class DomainDropTreeItemHandler extends ExplorerDropTreeItemHandler implements IDropTreeItemHandler {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I you want to share some behavior between DomainDropTreeItemHandler and ExplorerDropTreeItemHandler, you will need to do it thanks to composition not inheritance.

...clipse/sirius/web/application/studio/services/representations/DomainDropTreeItemHandler.java Outdated

public DomainDropTreeItemHandler(IObjectService objectService, IMessageService messageService, IViewRepresentationDescriptionSearchService viewRepresentationDescriptionSearchService) {
super(objectService, messageService);
this.viewRepresentationDescriptionSearchService = viewRepresentationDescriptionSearchService;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why it needs to be nullable?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I fixed it

@gdaniel gdaniel force-pushed the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch from 578bb28 to 2056b01 Compare December 18, 2024 16:14
@sbegaudeau sbegaudeau removed this from the 2025.1.0 milestone Dec 22, 2024
sbegaudeau
sbegaudeau reviewed Jan 13, 2025
View reviewed changes
Copy link
Member

@sbegaudeau sbegaudeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll just perform a quick check, rebase and merge it if no issue appears.

sbegaudeau
sbegaudeau reviewed Jan 13, 2025
View reviewed changes
...clipse/sirius/web/application/studio/services/representations/DomainDropTreeItemHandler.java Outdated
@Service
public class DomainDropTreeItemHandler implements IDropTreeItemHandler {

private final ExplorerDropTreeItemHandler explorerDropTreeItemHandler;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I somehow missed that you are using a dependency without an interface here. We are using interfaces on purpose, here we would need to extract the common behavior in a dedicated service instead. I'll update the PR and ensure that it gets merged.

@sbegaudeau sbegaudeau force-pushed the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch 2 times, most recently from 31cda80 to 163f05c Compare January 13, 2025 16:31
@sbegaudeau sbegaudeau added this to the 2025.2.0 milestone Jan 13, 2025
@sbegaudeau sbegaudeau force-pushed the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch 2 times, most recently from 7114599 to 5135b5f Compare January 13, 2025 16:42
@gdaniel @sbegaudeau
[4286] Make default explorer DnD work only for the default explorer
365c652 
Bug: eclipse-sirius#4286
Signed-off-by: Gwendal Daniel <gwendal.daniel@obeosoft.com>
@sbegaudeau sbegaudeau force-pushed the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch from 5135b5f to 365c652 Compare January 13, 2025 21:17
@sbegaudeau sbegaudeau merged commit 21b453d into eclipse-sirius:master Jan 13, 2025
3 checks passed
@sbegaudeau sbegaudeau deleted the gda/enh/restrainExplorerDropItemToolToDefaultExplorer branch January 13, 2025 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AxelRICHARD AxelRICHARD AxelRICHARD left review comments

@sbegaudeau sbegaudeau sbegaudeau approved these changes

@pcdavid pcdavid Awaiting requested review from pcdavid pcdavid is a code owner

Assignees
No one assigned
Labels
pr: to review soon priority: high
Projects
None yet
Milestone
2025.2.0
Development

Successfully merging this pull request may close these issues.

Make ExplorerDropTreeItemHandler work only for the default explorer
3 participants
@gdaniel @sbegaudeau @AxelRICHARD