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

[3634] Simplifying the contribution to the GraphQL subscription of the diagram for custom nodes #3639

Merged
merged 2 commits into from
Jun 20, 2024
Merged

[3634] Simplifying the contribution to the GraphQL subscription of the diagram for custom nodes #3639

merged 2 commits into from
Jun 20, 2024

Conversation

mcharfadi
Copy link
Contributor

@mcharfadi mcharfadi commented Jun 18, 2024 •
edited
Loading

Bug: #3634

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?

@mcharfadi mcharfadi added this to the 2024.7.0 milestone Jun 18, 2024
@mcharfadi mcharfadi force-pushed the mch/enh/documentTransform branch from e98ed58 to 15afbed Compare June 18, 2024 09:06
@mcharfadi mcharfadi linked an issue Jun 18, 2024 that may be closed by this pull request
Simplifying the contribution to the GraphQL subscription of the diagram for custom nodes #3634
Closed
sbegaudeau
sbegaudeau requested changes Jun 19, 2024
View reviewed changes
packages/sirius-web/frontend/sirius-web-application/src/graphql/useCreateApolloClient.ts Outdated
let apolloClientOptions: ApolloClientOptions<NormalizedCacheObject> = {
link,
cache,
connectToDevTools: true,
defaultOptions,
documentTransform: documentTransformToLoad,
Copy link
Member

Choose a reason for hiding this comment

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

Why do you need another extension point when configurers just a couple line below can transform as they like the options?

By the way, please write commit messages that explain what they do and not how they do it. Nobody will understand what this extension point means. Write instead that you are simplifying the contribution to the GraphQL subscription of the diagram for custom nodes.

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 the extension point because I wanted to make it more explicit but I'll remove it then.
I'll modify the commite message.

@mcharfadi mcharfadi force-pushed the mch/enh/documentTransform branch from 15afbed to 1cefa7e Compare June 19, 2024 08:17
@mcharfadi mcharfadi changed the title [3634] Add apolloClientOptionsDocumentTransformConfigurersExtensionPoint [3634] Simplifying the contribution to the GraphQL subscription of the diagram for custom nodes Jun 19, 2024
sbegaudeau
sbegaudeau reviewed Jun 20, 2024
View reviewed changes
packages/sirius-web/frontend/sirius-web/src/index.tsx Outdated
const apolloClientOptionsConfigurer: ApolloClientOptionsConfigurer = (currentOptions) => {
return {
...currentOptions,
documentTransform: ellipseNodeStyleDocumentTransform,
Copy link
Member

Choose a reason for hiding this comment

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

If another configurer has created some documentTransform, it will override it, we should consider merging them instead

Copy link
Member

Choose a reason for hiding this comment

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

Nobody does that today but the code of sirius-web-application may change later

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I had the concat method before when I created a dedicated extension point. I removed it because I then thought that it would be the responsibility of the contributor then.

@sbegaudeau sbegaudeau force-pushed the mch/enh/documentTransform branch from 1cefa7e to 7c6f72c Compare June 20, 2024 12:51
@sbegaudeau sbegaudeau force-pushed the mch/enh/documentTransform branch 2 times, most recently from 94eba3c to edc6852 Compare June 20, 2024 13:47
@sbegaudeau sbegaudeau linked an issue Jun 20, 2024 that may be closed by this pull request
Add the ability to customize the TypeResolver #3656
Closed
mcharfadi and others added 2 commits June 20, 2024 15:54
@sbegaudeau sbegaudeau force-pushed the mch/enh/documentTransform branch from edc6852 to a99e0cd Compare June 20, 2024 14:03
@sbegaudeau sbegaudeau merged commit 486c28b into master Jun 20, 2024
3 of 4 checks passed
@sbegaudeau sbegaudeau deleted the mch/enh/documentTransform branch June 20, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbegaudeau sbegaudeau sbegaudeau approved these changes

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

Assignees
No one assigned
Labels
pr: to review soon priority: high
Projects
None yet
Milestone
2024.7.0
2 participants
@mcharfadi @sbegaudeau