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

[3758] Store all form payload in a context #3844

Merged
merged 2 commits into from
Aug 29, 2024
Merged

Conversation

mcharfadi
Copy link
Contributor

Bug: #3758

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 Aug 7, 2024
@mcharfadi mcharfadi linked an issue Aug 7, 2024 that may be closed by this pull request
@mcharfadi mcharfadi force-pushed the mch/enh/form-payload branch 7 times, most recently from 20af62b to b8f0367 Compare August 8, 2024 07:28
@sbegaudeau sbegaudeau modified the milestones: 2024.7.0, 2024.9.0 Aug 13, 2024
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.

Could you also rebase the PR to merge it quickly after that, thanks

/>
</div>
))}
const renderedForm = useMemo(() => {
Copy link
Member

Choose a reason for hiding this comment

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

Please stop with the useMemo memo, useCallbacketc unless we have a performance issue identified that needs to be fixed (i.e. a Github issue). Premature optimization does not help and React 19 is supposed to provide that for free so we will have to remove this kind of code quite soon.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seemed worth it to me there, but I also took the wrong habit to use these too much.
I'll remove it there.


const onComplete = () => setState((prevState) => ({ ...prevState, complete: true }));

const { error, loading } = useSubscription<GQLFormEventSubscription, GQLFormEventVariables>(
Copy link
Member

Choose a reason for hiding this comment

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

Why not destructure data here like that { data, error, loading } and remove the payload from the state? You would also remove one re-rendering with the setState line57 which would disappear.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay I modified all the custom hook to act like this.

@mcharfadi mcharfadi force-pushed the mch/enh/form-payload branch from b8f0367 to f66dfd7 Compare August 26, 2024 14:37
@sbegaudeau sbegaudeau self-assigned this Aug 27, 2024
@mcharfadi mcharfadi force-pushed the mch/enh/form-payload branch 5 times, most recently from e0ce686 to 2a130e0 Compare August 29, 2024 08:00
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 take into account the various comments that I've added to this PR and ensure that it gets merge to release the Sirius Web RC1.

@sbegaudeau sbegaudeau force-pushed the mch/enh/form-payload branch from 2a130e0 to 1edf925 Compare August 29, 2024 09:06
Signed-off-by: Stéphane Bégaudeau <[email protected]>
@sbegaudeau
Copy link
Member

I'll wait for the build, merge it and release the Sirius Web 2024.9.0 RC1 (which will be the milestone 2024.7.11)

@sbegaudeau sbegaudeau merged commit 74b59b2 into master Aug 29, 2024
4 checks passed
@sbegaudeau sbegaudeau deleted the mch/enh/form-payload branch August 29, 2024 09:43
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.

Store form and property payload in a context
2 participants