fix(SceneDataTransformer): preserve undefined annotations when source has none - #1623
Draft
sidsri14 wants to merge 1 commit into
Draft
Conversation
… has none
SceneDataTransformer.transform() was unconditionally setting `annotations` to `[]` even when source data had `annotations: undefined`.
Consumers such as Grafana's TimeSeriesPanel and CandlestickPanel guard on presence of `data.annotations` (e.g. `{data.annotations && <ExemplarsPlugin ... />}`). Promoting `undefined` to `[]` caused ExemplarsPlugin and its EventsCanvas uPlot draw hook to be mounted on every panel with a transformation, resulting in unnecessary state updates and render cycles on pan, zoom, and cursor redraws.
This updates SceneDataTransformer to preserve `undefined` when `annotations.length === 0` and `data.annotations === undefined`.
Contributor
Signed commits report1 of 1 commit between
This repository requires all commits to be signed. See GitHub docs on commit signature verification. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Fixes #1612.
SceneDataTransformer.transform()was previously always returningannotations: []even when the inputdata.annotationswasundefinedand no annotations were created.In consumers like Grafana's
TimeSeriesPanelandCandlestickPanel, components guard on presence ofdata.annotations(e.g.{data.annotations && <ExemplarsPlugin ... />}). Promotingundefinedto[]causedExemplarsPlugin(and itsEventsCanvaswith uPlot draw hook) to mount on every panel with a transformation, resulting in unnecessary React re-renders on pan/zoom/cursor redraws.Changes
packages/scenes/src/querying/SceneDataTransformer.ts:Set
annotations: annotations.length > 0 || data.annotations !== undefined ? annotations : undefined.This preserves
undefinedwhen no annotations existed on the source data and none were produced by transformations, while correctly retaining[]if a transformer explicitly reduced existing annotations to empty.packages/scenes/src/querying/SceneDataTransformer.test.ts:Added a unit test verifying that
data.annotationsremainsundefinedwhen transforming source data without annotations.Verification
yarn workspace @grafana/scenes test packages/scenes/src/querying/SceneDataTransformer.test.ts --watchAll=falsepassed 100% (20 passed, 1 skipped).yarn turbo typecheck --filter=@grafana/scenespassed with 0 errors.