[Config] Expose TTLDurationMapping as data module configuration #20
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
commented
Dec 14, 2021
| import DataSourceStore from './data-source-store/dataSourceStore'; | ||
| import { SubscriptionResponse } from '../data-sources/site-wise/types.d'; | ||
| import { DataCache } from './data-cache/dataCacheWrapped'; | ||
| import { Request } from './data-cache/requestTypes'; | ||
| import { requestRange } from './data-cache/requestRange'; | ||
| import { getDateRangesToRequest } from './data-cache/caching/caching'; | ||
| import { viewportEndDate, viewportStartDate } from '../common/viewport'; | ||
| import { MINUTE_IN_MS, SECOND_IN_MS } from '../common/time'; | ||
|
|
||
| // given duration specified as a key, it may only be re-requested after the provided TTL value |
There was a problem hiding this comment.
I'll move this (and more) into doc-site documentation once we align on an approach.
boweihan
commented
Dec 14, 2021
| /** | ||
| * Create a new data module, optionally with a pre-hydrated data cache. | ||
| * | ||
| */ | ||
| constructor(initialDataCache?: DataStreamsStore) { | ||
| constructor(configuration: IotAppKitDataModuleConfiguration = {}) { | ||
| const { initialDataCache, ttlDurationMapping = DEFAULT_TTL_DURATION_MAPPING } = configuration; |
There was a problem hiding this comment.
I thought about having ttlDurationMapping be even more granular and attached to a DataStreamStore but I think that's overkill for now. Especially because other time-series offerings like Grafana don't even offer this type of granular customization.
If we want to add granularity per stream in the future it should be fairly straightforward - more specific configuration will simply override this data module scoped configuration.
boweihan
changed the title
boweihan
force-pushed
the
ttl-rules
branch
3 times, most recently
from
24681ab
to
19a7dd5
Compare
diehbria
reviewed
Dec 15, 2021
| @@ -506,6 +508,87 @@ describe('caching', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| describe('cache settings', () => { | |||
| let getDateRangesToRequestSpy = jest.spyOn(caching, 'getDateRangesToRequest'); | |||
diehbria
approved these changes
Dec 15, 2021
sheilaXu
pushed a commit
that referenced
this pull request
Sep 23, 2022
Allow entering entity id with autosuggest Co-authored-by: Zuraiz Zafar 🙃 <zuraiz@amazon.com>
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
The IoT App Kit takes a granular approach to time-series caching rules. The idea is to allow data points to be re-requested at different frequencies depending on how close those data points are to chart boundaries - e.g. more "recent" data can be refreshed with higher frequency.
This change allows IoT App Kit consumers to customize cache invalidation rules by overriding the default
ttlDurationMapping.Tests
https://github.com/boweihan/iot-app-kit/runs/4523021422?check_suite_focus=true
Legal
This project is available under the Apache 2.0 License.