feat: Refactor SiteWise components to use query and provider interfaces #54
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boweihan
force-pushed
the
query-builder-pt-2
branch
from
24416a1 to
4c58650
Compare
| this.provider = this.query.build(this.appKit.session(this.widgetId), this.defaultSettings); | ||
| } | ||
|
|
||
| @Listen('dateRangeChange') |
There was a problem hiding this comment.
Why not build and listen in the connector component?
There was a problem hiding this comment.
I did this for two reasons:
- I wanted to separate the presentational concerns (App kit component) from data fetching concerns (iot time series connector).
dateRangeChangeis a synchro-charts specific functionality so it should belong in the "presentational" layer - users should be able to implement their own presentational components on-top of iot-time-series-connector, for example. I was also thinking there might be a case where we want to handle viewport updates differently depending on the type of presentational component. - The appKit session has an optional componentId and I figured it made sense to pass in widgetId directly in these base charts rather than having users define their own (this is why we call build() in this class).
There was a problem hiding this comment.
This makes perfect sense. Thank you!
diehbria
approved these changes
Feb 11, 2022
sheilaXu
pushed a commit
that referenced
this pull request
Sep 23, 2022
* Updated the function definitions for getAvailableTimeRanges(), triggerLiveVideoUpload() and triggerOnDemandVideoUploadRequest() * Removed unnecessary try-catch blocks
TheEvilDev
pushed a commit
that referenced
this pull request
Nov 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Move away from the current "bag of props" component interface. Components now accept a generic Query interface. Any queries that conform to the interface are guaranteed to "provide" the component with the data it needs to render. Think of them as generic data connectors that can be easily reimplemented!
For SiteWise components we also handle gestures from SynchroCharts that result in viewport updates. This custom logic is the responsibility of our SiteWiseTimeSeriesDataProvider.
Tests
https://github.com/boweihan/iot-app-kit/actions/runs/1825938466
Legal
This project is available under the Apache 2.0 License.