Skip to content

[6118] Support auto_until_change layout option#6130

Open
frouene wants to merge 1 commit intomasterfrom
fro/enh/opening-layout
Open

[6118] Support auto_until_change layout option#6130
frouene wants to merge 1 commit intomasterfrom
fro/enh/opening-layout

Conversation

@frouene
Copy link
Copy Markdown
Contributor

@frouene frouene commented Jan 27, 2026

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?

@frouene frouene linked an issue Feb 2, 2026 that may be closed by this pull request
Add support for auto layout until change on diagram #6118
Open
@frouene frouene force-pushed the fro/enh/opening-layout branch 2 times, most recently from e5ee20e to b7a4c57 Compare March 4, 2026 14:26
@frouene frouene added this to the 2026.3.0 milestone Mar 4, 2026
@frouene frouene force-pushed the fro/enh/opening-layout branch 5 times, most recently from af1c2b1 to 81922c1 Compare March 10, 2026 11:00
@frouene frouene force-pushed the fro/enh/opening-layout branch 4 times, most recently from 5d666e9 to d9bd6d5 Compare March 17, 2026 09:54
@frouene frouene marked this pull request as ready for review March 17, 2026 12:58
sbegaudeau
sbegaudeau requested changes Mar 17, 2026
View reviewed changes
.../backend/sirius-components-collaborative-diagrams/src/main/resources/schema/diagram.graphqls
id: ID!
label: String!
autoLayout: Boolean!
layoutOption: DiagramLayoutOption!
Copy link
Copy Markdown
Member

@sbegaudeau sbegaudeau Mar 17, 2026

Choose a reason for hiding this comment

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

Now that we will have a way to retrieve ELK "Layout options" from the backend in the upcoming days / weeks, this would have to be renamed very quickly to something clearly related to the auto-layout behavior. We may merge this as is, but it will have to be renamed during the cool down. It can't stay this way now.

...e/sirius/web/application/controllers/diagrams/undo/UndoEdgeLayoutDiagramControllerTests.java Outdated
var bendingPoints = List.of(new Position(10, 10), new Position(20, 20), new Position(30, 30));
var edgeLayoutDataInput = new EdgeLayoutDataInput(siriusWebApplicationEdgeId.get(), bendingPoints, List.of());
var diagramLayoutDataInput = new DiagramLayoutDataInput(List.of(nodeLayoutDataInput), List.of(edgeLayoutDataInput), List.of());
var diagramLayoutDataInput = new DiagramLayoutDataInput(List.of(nodeLayoutDataInput), List.of(edgeLayoutDataInput), List.of(), false, false);
Copy link
Copy Markdown
Member

@sbegaudeau sbegaudeau Mar 17, 2026

Choose a reason for hiding this comment

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

How can this compile? This commit does not introduce any change to this DTO.

Copy link
Copy Markdown
Contributor Author

@frouene frouene Mar 19, 2026

Choose a reason for hiding this comment

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

I squashed the two commits

@frouene frouene force-pushed the fro/enh/opening-layout branch 2 times, most recently from 318bdfc to 654e88f Compare March 19, 2026 13:05
@frouene
[6118] Support auto_until_change layout option
9e661ce 
Bug: #6118
Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>
@frouene frouene force-pushed the fro/enh/opening-layout branch from 654e88f to 9e661ce Compare March 19, 2026 13:16
@sbegaudeau sbegaudeau removed this from the 2026.3.0 milestone Mar 27, 2026
@sbegaudeau sbegaudeau changed the title Fro/enh/opening layout [6118] Support auto_until_change layout option Mar 27, 2026
@sbegaudeau sbegaudeau added this to the 2026.5.0 milestone Mar 27, 2026
sbegaudeau
sbegaudeau requested changes Mar 27, 2026
View reviewed changes
...ditingcontext/migration/participants/DiagramDescriptionLayoutOptionMigrationParticipant.java
@Service
public class DiagramDescriptionLayoutOptionMigrationParticipant implements IMigrationParticipant {

private static final String PARTICIPANT_VERSION = "2026.3.0-202601161500";
Copy link
Copy Markdown
Member

@sbegaudeau sbegaudeau Mar 27, 2026

Choose a reason for hiding this comment

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

This will, of course, have to be updated to 2026.5...

...c/main/java/org/eclipse/sirius/components/collaborative/diagrams/DiagramCreationService.java
Comment on lines +235 to +239
boolean autoLaidOut = switch (layoutDiagramInput.diagramLayoutData().autoLayoutState()) {
case ACTIVATE -> true;
case DEACTIVATE -> false;
case UNCHANGED -> diagram.getLayoutData().autoLaidOut();
};
Copy link
Copy Markdown
Member

@sbegaudeau sbegaudeau Mar 27, 2026

Choose a reason for hiding this comment

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

There's something odd at the heart of this in terms of lifecycle. If I create a diagram with NONE as a LayoutOption and then if I perform one arrangeAll, my diagram see to be marked as autoLaidOut even after other changes (creating a new element for example).

There are still again issues related to state management and lifecycle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sbegaudeau sbegaudeau sbegaudeau requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

pr: to review later priority: low

Projects

None yet

Milestone

2026.5.0

Development

Successfully merging this pull request may close these issues.

Add support for auto layout until change on diagram

2 participants

@frouene @sbegaudeau