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

[1305] Fix update of the default tools of the palette's tool sections #2001

Merged
merged 1 commit into from May 31, 2023

Conversation

AxelRICHARD
Copy link
Contributor

Bug: #1305

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?

@AxelRICHARD AxelRICHARD added this to the 2023.6.0 milestone May 26, 2023
@AxelRICHARD AxelRICHARD linked an issue May 26, 2023 that may be closed by this pull request
4 tasks
@AxelRICHARD AxelRICHARD force-pushed the ari/fix/defaultTool branch 2 times, most recently from 058a06c to 5ceb972 Compare May 26, 2023 16:57
@AxelRICHARD
Copy link
Contributor Author

Cypress test seems unpredictable, need to find an alternative.

@@ -14,5 +14,6 @@ import { GQLTool, GQLToolSection } from '../ContextualPalette.types';

export interface ToolSectionProps {
toolSection: GQLToolSection;
defaultToolId: string | undefined;
Copy link
Member

Choose a reason for hiding this comment

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

Minor nitpick, either you want to explicitly handle nothing as an explicit value and in this case use string | null but if you want to provide an optional prop on a component you should probably use defaultToolId?: string. With this, you do not have to specify <ToolSection defaultToolId={undefined} /> which is not very sexy.

Most of the time, I prefer that we handle explicitly null values but for the props of a component, an optional prop is perfectly fine. It works the same for simple boolean-based props for example to be able to have something like this:

<Something />
<Something />
<Something disabled />
<Something />

And not

<Something disabled={false} />
<Something disabled={false} />
<Something disabled={true} />
<Something disabled={false} />

Bug: #1305
Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
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 merge it once the build is green

@sbegaudeau sbegaudeau merged commit c30dd77 into master May 31, 2023
4 checks passed
@sbegaudeau sbegaudeau deleted the ari/fix/defaultTool branch May 31, 2023 14:47
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.

The default tool of a tool section is not updated as it should
3 participants