Plugins: Move filter back to DataSourceWithBackend #74147
Merged
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
ryantxu
requested review from
tskarhed,
eledobleefe,
academo,
gillesdemey,
VikaCep,
konrad147,
soniaAguilarPeiron and
oshirohugo
and removed request for
a team
ryantxu
changed the title
|
(Open the links below in a new tab to go to the correct steps)
|
github-actions
bot
added
the
levitate breaking change
academo
requested changes
Aug 31, 2023
oshirohugo
reviewed
Aug 31, 2023
Comment on lines
270
to
278
| /** | ||
| * Override to skip executing a query | ||
| * | ||
| * @returns false if the query should be skipped | ||
| * | ||
| * @virtual | ||
| */ | ||
| filterQuery?(query: TQuery): boolean; | ||
|
|
There was a problem hiding this comment.
I think we can add a note in this documentation, stating that the filterQuery won't work if the query method from DataSourceWithBackend is overwritten.
In the docs it says that DataSoruceWithBackend.query is ideally final, but there are normal situations like streaming plugins where it needs to be overwritten.
academo
approved these changes
Sep 1, 2023
oshirohugo
approved these changes
Sep 1, 2023
3 tasks
chauchausoup
pushed a commit
to chauchausoup/grafana
that referenced
this pull request
Sep 15, 2023
3 tasks
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.
In #41317 (two years ago! 😬). the filterQuery api was moved to the root datasource api level. However it is only executed within DataSourceWithBackend
In #74116 -- the proposal is to execute this in the panel query runner.
It is easy to argue that either approach is a breaking change -- executing somethign that was previously not executed, or a possible type error while developing. The 2nd seems safer to me
Who is this feature for?
Plugin developers
Which issue(s) does this PR fix?:
Fixes #47876