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): initial support for Observations #4631

Merged
merged 23 commits into from
Jun 26, 2024

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Jun 21, 2024

Type of change

Feat

Jira ticket 📘

Description 📝

Initial support for observations. Includes a couple of other changes.

  • Add ObservationsTool which currently is used for visualizing ObservationDomainObjects, representing Observations stored in the backend. These concepts are all work in progress.
  • Add generic argument to the BaseView class, to make it explicit what DomainObject it concerns.
  • Change the CommandButton form to follow React conventions
  • Use useMemo to avoid recreating command objects repeatedly in React command buttons
  • Make sure filter in the instanceFilter query is made undefined if empty (otherwise it's an invalid request), as was done with the search endpoint earlier.

How has this been tested? 🔍

In storybook (Toolbar) and linked into Fusion

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.

Copy link
Contributor

@nilscognite nilscognite left a comment

Choose a reason for hiding this comment

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

In this PR you do to much outside of the architecture. Our observation should be in the domain object itself and added to the root at startup.

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. Some few comments but they are not blockers. Good job!
Note: Let's wait Nils reviews as he can see some more pitfalls that I'm not seeing right now since he knows this architecture better atm.

Copy link
Contributor

@nilscognite nilscognite left a comment

Choose a reason for hiding this comment

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

Better now. But here is things you still have misunderstood. Having a hard reference to a DomainObject directly in a tool wrong. I said in the course that number of references to a object should be minimum and controlled by the architecture. What happens for instance when another command delete it, but the reference is still in the tool? The architecture will guarantee that the domain objects hold by the root (as a hierarchy) is "alive".

Copy link
Contributor

@nilscognite nilscognite left a comment

Choose a reason for hiding this comment

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

Better now

@haakonflatval-cognite haakonflatval-cognite added auto-update Makes bulldozer automatically update this PR when there are changes to the target branch labels Jun 26, 2024
@haakonflatval-cognite haakonflatval-cognite merged commit c437a3f into master Jun 26, 2024
14 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/observations-ui branch June 26, 2024 11:13
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.

3 participants