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.

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

[3763] Split the SelectionDialogDescription to prepare the Tree support #3857

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

florianbarbin
Copy link
Contributor

The SelectionDialogDescription will now just hold the message information
The SelectionDialogDescription will now have a
selectionDialogTreeDescription to make it possible for the specifier to display the selectable elements as a tree.
The selectionDialogTreeDescription will be relatively simple at first time.

Bug: #3763

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?

The current SelectionDialog behavior is still the same.

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

@florianbarbin florianbarbin added this to the 2024.9.0 milestone Aug 12, 2024
@florianbarbin florianbarbin force-pushed the fba/enh/treeViewForSelectionDialog branch from b3152b3 to db4c87f Compare August 12, 2024 20:15
@florianbarbin florianbarbin force-pushed the fba/enh/treeViewForSelectionDialog branch 2 times, most recently from 7c026f5 to ce47cea Compare August 14, 2024 10:07
@florianbarbin florianbarbin force-pushed the fba/enh/treeViewForSelectionDialog branch 2 times, most recently from af8ac8a to c59f3a4 Compare August 19, 2024 14:25
@florianbarbin florianbarbin force-pushed the fba/enh/treeViewForSelectionDialog branch 2 times, most recently from dd123a8 to 251994c Compare August 21, 2024 14:48
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.

Most of the code looks good, I'll rebase it and fix the tiny issues detected here and there (it should mostly be conflicts with master)


@Override
public void postObjectLoading(EObject eObject, JsonObject jsonObject) {
if (eObject instanceof SelectionDialogDescription selectionDialogDescription) {
Copy link
Member

Choose a reason for hiding this comment

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

Can't we use a flatMap somewhere?

The SelectionDialogDescription will now just hold the message information
The SelectionDialogDescription will now have a selectionDialogTreeDescription
to make it possible for the specifier to display the selectable elements as a tree.
The selectionDialogTreeDescription will be relatively simple at first time.

Bug: #3763
Signed-off-by: Florian Barbin <[email protected]>
@sbegaudeau sbegaudeau force-pushed the fba/enh/treeViewForSelectionDialog branch from 251994c to eb4c34b Compare August 26, 2024 09:27
@sbegaudeau
Copy link
Member

I'll wait for the build and merge it

@sbegaudeau sbegaudeau merged commit 5f845ea into master Aug 26, 2024
4 checks passed
@sbegaudeau sbegaudeau deleted the fba/enh/treeViewForSelectionDialog branch August 26, 2024 09:50
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.

Make it possible to display the content of the Selection Dialog using a tree viewer
3 participants