feat: make dshboards "refreshable" #1784
Open
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
Preview components from this PR in consuming applicationIn consuming application project install preview versions of shared packages generated by this PR: |
filipgutica
commented
Nov 14, 2024
| @@ -127,6 +129,7 @@ const { | |||
| queryFn, | |||
| averageLatencies, | |||
| abortController: props.abortController, | |||
| refreshCounter: toRef(props, 'refreshCounter'), | |||
There was a problem hiding this comment.
If we don't toRef it here, it loses reactivity since it's being passed off to a util function 🤔
adorack
requested changes
Nov 15, 2024
| @@ -39,6 +39,7 @@ interface FetcherOptions { | |||
| queryFn: AnalyticsBridge['queryFn'] | |||
| averageLatencies: Ref<boolean>, | |||
| abortController?: AbortController | |||
| refreshCounter?: Ref<number> | |||
There was a problem hiding this comment.
Since the prop has a default value, this option will always be available.
Suggested change
| refreshCounter?: Ref<number> | |
| refreshCounter: Ref<number> |
| @@ -115,7 +115,7 @@ export default function useMetricFetcher(opts: MetricFetcherOptions): FetcherRes | |||
| // need to have some uniqueness in the cache key to avoid collisions. | |||
| // this was happening when there are multiple providers on the same page with the same dimensions and metrics. | |||
| // For example the singleProvider and multiProvider that appear in the test harness. | |||
| return `metric-fetcher-${opts.timeframe.value.cacheKey()}-${opts.dimensions?.join('-')}-${opts.metrics.value?.join('-')}-${additionalFilterKey}` | |||
| return `metric-fetcher-${opts.timeframe.value.cacheKey()}-${opts.dimensions?.join('-')}-${opts.metrics.value?.join('-')}-${additionalFilterKey}-${opts.refreshCounter?.value}` | |||
There was a problem hiding this comment.
Suggested change
| return `metric-fetcher-${opts.timeframe.value.cacheKey()}-${opts.dimensions?.join('-')}-${opts.metrics.value?.join('-')}-${additionalFilterKey}-${opts.refreshCounter?.value}` | |
| return `metric-fetcher-${opts.timeframe.value.cacheKey()}-${opts.dimensions?.join('-')}-${opts.metrics.value?.join('-')}-${additionalFilterKey}-${opts.refreshCounter.value}` |
(With the above suggestion.)
| @@ -173,7 +173,7 @@ export default function useMetricFetcher(opts: MetricFetcherOptions): FetcherRes | |||
| }) | |||
|
|
|||
| return { | |||
| isLoading: computed(() => STATE.PENDING === metricRequestState.value), | |||
| isLoading: computed(() => [STATE.PENDING, STATE.VALIDATING, STATE.VALIDATING_HAS_DATA].includes(metricRequestState.value)), | |||
There was a problem hiding this comment.
Hmmm. This makes the auto-refresh UX very noisy -- the page drops to loading states every time the charts update. I'm not aware of many uses of auto-refresh right now, so this is probably an acceptable trade-off right now, but I'll poke Christian and Helen.
| @@ -16,4 +16,5 @@ export interface MetricFetcherOptions { | |||
| queryReady: Ref<boolean> | |||
| queryFn: AnalyticsBridge['queryFn'] | |||
| abortController?: AbortController | |||
| refreshCounter?: Ref<number> | |||
There was a problem hiding this comment.
Suggested change
| refreshCounter?: Ref<number> | |
| refreshCounter: Ref<number> |
| @@ -31,8 +31,10 @@ const props = withDefaults(defineProps<{ | |||
| context: DashboardRendererContextInternal, | |||
| height?: number, | |||
| queryReady: boolean, | |||
| refreshCounter?: number, | |||
There was a problem hiding this comment.
Does this need to be optional? The renderer is the only thing that renders tiles, and it always provides the counter...
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.
Summary
https://konghq.atlassian.net/browse/MA-3089
https://www.loom.com/share/afcd026de712408da886e722cb044395