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

feat(react-components): remove all URL-mutations #4739

Merged
merged 11 commits into from
Sep 6, 2024

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Sep 5, 2024

Type of change

Feat

Jira ticket 📘

https://cognitedata.atlassian.net/browse/

Description 📝

Removes all URL-mutating functionality in react-components, so that we no longer change the URL for any reason within the library itself. I think this is good practice for a library in general, as the URL should be fully controlled by the application. In particular, this also solves a problem for FRS use in Canvas, which does not like the re-rendering that is caused by our URL-mutation.

This PR:

  • Removes Measurement button, it's already superseded by the Measurements functionality made by Nils Petter
  • Removes URL-state storage in the slicing tool. I hope this won't be a problem, but this tool is also largely superseded by the new cropping tool
  • Changes withCameraUrlState to instead consume the setter and getter to manipulate the camera state, regardless of how it's backed by the application

How has this been tested? 🔍

Test instructions ℹ️

Link into fusion with this PR: https://github.com/cognitedata/fusion/pull/8047

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

Copy link
Contributor

@danpriori danpriori left a comment

Choose a reason for hiding this comment

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

LGTM. I like the decision made to remove the URL params being controlled by react components and let the app drive this.

@haakonflatval-cognite haakonflatval-cognite added the auto-update Makes bulldozer automatically update this PR when there are changes to the target branch label Sep 6, 2024
@haakonflatval-cognite haakonflatval-cognite merged commit c054f6b into master Sep 6, 2024
14 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/remove-url-mutations branch September 6, 2024 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-update Makes bulldozer automatically update this PR when there are changes to the target branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants