Skip to content

[3647] Add support for diagram style with background customization#3648

Open
frouene wants to merge 5 commits intocooldownfrom
fro/enh/diagram-background
Open

[3647] Add support for diagram style with background customization#3648
frouene wants to merge 5 commits intocooldownfrom
fro/enh/diagram-background

Conversation

@frouene
Copy link
Contributor

@frouene frouene commented Jun 19, 2024

Bug: #3647

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 added this to the 2024.7.0 milestone Jun 19, 2024
@frouene frouene linked an issue Jun 19, 2024 that may be closed by this pull request
@frouene frouene force-pushed the fro/enh/diagram-background branch 2 times, most recently from 71dd68a to 799de23 Compare June 20, 2024 12:13
@frouene frouene requested a review from sbegaudeau as a code owner June 20, 2024 12:13
@frouene frouene force-pushed the fro/enh/diagram-background branch 3 times, most recently from b5eb6d3 to 5f4f453 Compare June 20, 2024 13:45
@sbegaudeau sbegaudeau self-assigned this Jun 20, 2024
@frouene frouene force-pushed the fro/enh/diagram-background branch 2 times, most recently from 09295ae to d0364d5 Compare June 21, 2024 14:49
@sbegaudeau sbegaudeau force-pushed the fro/enh/diagram-background branch from d0364d5 to 973ec87 Compare June 25, 2024 12:50
</>
) : (
<Background style={{ backgroundColor }} color={backgroundColor} />
<Background style={{ background }} color={'transparent'} />
Copy link
Member

Choose a reason for hiding this comment

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

color="transparent"

@frouene frouene force-pushed the fro/enh/diagram-background branch 3 times, most recently from 515352f to da1b807 Compare July 3, 2024 14:43
@frouene frouene modified the milestones: 2024.7.0, 2024.9.0 Jul 10, 2024
@frouene frouene force-pushed the fro/enh/diagram-background branch 2 times, most recently from 3588434 to 3394409 Compare July 26, 2024 16:58
@frouene frouene force-pushed the fro/enh/diagram-background branch 3 times, most recently from 45ce690 to 7ca5f59 Compare August 12, 2024 14:07
@frouene frouene force-pushed the fro/enh/diagram-background branch from 7ca5f59 to 1cde282 Compare August 26, 2024 16:02
@sbegaudeau sbegaudeau force-pushed the fro/enh/diagram-background branch from 1cde282 to 0c22c94 Compare August 27, 2024 14:14
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 still have a couple of things to review but this first point is an important one because it could give a wrong impression for downstream consumers (they may believe that this code works).

}

@Override
public boolean isDiagramEmpty(IDiagramService diagramService) {
Copy link
Member

Choose a reason for hiding this comment

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

This must be new since the last time I reviewed this PR because this cannot work. I could accept that in the services of Papaya diagrams because it would work in this case but imagine that I have 1 node in my diagram which has 10 child nodes and the view deletion request is for one of its child node then this code does not work.

Imagine now that I have 3 nodes in my diagram and a tool triggers the creation of 3 view deletion request then this code would not work either. Finding out that a diagram is empty in all use case is more complex than what you algorithm suggest. Please move both the implementation of this service and its definition out of IDiagramServices for now and into something in the Java services of Papaya (since I suspect that you are only using it there).

You could also improve this algorithm to make it work all the time but it will require some testing of corner cases. Consumers of Sirius Web such as SysON would be quite interested by such service.

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 moved this method in papaya services

@frouene frouene force-pushed the fro/enh/diagram-background branch 2 times, most recently from 1920f68 to b109d3c Compare September 2, 2024 15:39
@frouene frouene modified the milestones: 2024.9.0, 2024.11.0 Oct 1, 2024
@sbegaudeau sbegaudeau removed this from the 2024.11.0 milestone Nov 21, 2024
@frouene frouene force-pushed the fro/enh/diagram-background branch 4 times, most recently from 926292e to 47c08e1 Compare January 17, 2025 08:59
@frouene frouene force-pushed the fro/enh/diagram-background branch 3 times, most recently from 1175bb7 to 69be149 Compare March 19, 2026 15:28
@frouene frouene changed the base branch from master to cooldown March 19, 2026 15:29
@frouene frouene force-pushed the fro/enh/diagram-background branch from 69be149 to 09ae4b5 Compare March 19, 2026 15:34
@frouene frouene added this to the 2026.5.0 milestone Mar 20, 2026
@frouene frouene force-pushed the fro/enh/diagram-background branch from 09ae4b5 to d9d135b Compare March 24, 2026 14:31
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
@frouene frouene force-pushed the fro/enh/diagram-background branch from d9d135b to 1493746 Compare March 24, 2026 15:55
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
…ecifications

Bug: #6313
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
… based applications

Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
@frouene frouene force-pushed the fro/enh/diagram-background branch 3 times, most recently from 8ac3922 to 1e6b742 Compare March 26, 2026 08:55
Bug: #3647
Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>
@frouene frouene force-pushed the fro/enh/diagram-background branch from 1e6b742 to 29b3d14 Compare March 26, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add diagram style with background properties

3 participants