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

refactor(react-components): move caching into separate class in architecture #4910

Merged
merged 9 commits into from
Dec 2, 2024

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Nov 28, 2024

Type of change

Refactor

Jira ticket 📘

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

Description 📝

Move caches from context providers and into their own domain object. This is a preliminary step to be able to use the cache's functionality for fetching data on click from within the architecture

Most of the codeline changes are putting hooks in separate files (so you don't have to read them closely, they're unchanged).
But there are a couple of other changes:

  • We no longer use context providers for the different caches because
  • The caches have been moved into a separate CachesDomainObject, provided to the render target on initialization
  • Some logic in RevealContext has been rewired to make this initialization happen

How has this been tested? 🔍

Test instructions ℹ️

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.

@haakonflatval-cognite haakonflatval-cognite changed the title refactor(react-components): move caching into domain object refactor(react-components): move caching into separate class in architecture Dec 1, 2024
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

@haakonflatval-cognite haakonflatval-cognite enabled auto-merge (squash) December 2, 2024 07:21
@haakonflatval-cognite haakonflatval-cognite merged commit 5a203f5 into master Dec 2, 2024
14 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/centralize-caching branch December 2, 2024 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants