Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Remove deprecated exploreId from QueryEditorProps #83971

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

Elfo404
Copy link
Member

@Elfo404 Elfo404 commented Mar 6, 2024

Removes the deprecated (in 10.3) exploreId property fromQueryEditorProps.

Fixes #78747

Release notice breaking change

Since #38942 exploreId is no longer supplied to query editors in Explore. The property was deprecated in 10.3.0 and is now removed. If your query editor needs to know from which app is being rendered, you can check the app prop in QueryEditorProps.

@Elfo404 Elfo404 requested review from a team as code owners March 6, 2024 13:10
@Elfo404 Elfo404 requested review from joshhunt, eledobleefe, mckn and a team and removed request for a team March 6, 2024 13:10
@grafana-delivery-bot grafana-delivery-bot bot added this to the 11.0.x milestone Mar 6, 2024
@Elfo404 Elfo404 added add to changelog breaking change Relevant for changelog generation no-backport Skip backport of PR labels Mar 6, 2024
@grafana-pr-automation
Copy link

⚠️   Possible breaking changes (md version)   ⚠️

grafana-data

Removals

ExploreQueryFieldProps.exploreId
/home/runner/work/grafana/grafana/base/grafana-data/dist/index.d.ts
exploreId?: string;

QueryEditorProps.exploreId
/home/runner/work/grafana/grafana/base/grafana-data/dist/index.d.ts
exploreId?: string;


Read our guideline
Console output

@grafana-pr-automation grafana-pr-automation bot added the levitate breaking change A label indicating a breaking change and assigned by Levitate. label Mar 6, 2024
@grafana-pr-automation grafana-pr-automation bot requested a review from a team March 6, 2024 13:15
Copy link
Contributor

@mckn mckn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to check how widely this is used outside of Grafana but I can only find usages within Grafana or bundled plugins so should be ok to remove.

Do we have any alternative ways to get the exploreId? Or it should not be needed anymore?

@Elfo404
Copy link
Member Author

Elfo404 commented Mar 7, 2024

@mckn it should not be needed anymore, it was used only to check if a plugin was rendered in explore or not, but there are now better ways to do that.

@mckn
Copy link
Contributor

mckn commented Mar 7, 2024

@mckn it should not be needed anymore, it was used only to check if a plugin was rendered in explore or not, but there are now better ways to do that.

Then the question is, what are the better ways of doing it?

@Elfo404
Copy link
Member Author

Elfo404 commented Mar 7, 2024

QueryEditorProps has an app props that can be used to check where the editor is being rendered. I've updated the breaking change note

@Elfo404 Elfo404 merged commit 937390b into main Mar 11, 2024
36 of 37 checks passed
@Elfo404 Elfo404 deleted the gio/chore/remove-exploreid branch March 11, 2024 12:09
xlson added a commit that referenced this pull request Mar 11, 2024
* main: (1014 commits)
  Dashboards: Update scenes lib to 3.10 (#84075)
  Playlist: run on Scenes (#83551)
  E2C: Add cloud migration is_target server config option (#83419)
  Update dependency marked to v12.0.1
  Chore: Remove deprecated ExploreQueryFieldProps (#83972)
  Chore: Remove deprecated exploreId from QueryEditorProps (#83971)
  Documentation: Updated yaml for influxdb data sources (#84119)
  Schemas: Reduce duplicated jenny code (#84061)
  Update dependency immer to v10.0.4
  CloudMigration: wires the service (#84081)
  Chore: Remove InputControl usage from explore (#83742)
  Chore: Remove Form components from TransformationsEditor (#83743)
  DatePickerWithInput: Set zIndex for popover correctly (#84154)
  Scenes/Repeats: Show reduced panel menu for repeat panels (#84085)
  Update dependency centrifuge to v5.0.2
  Update dependency autoprefixer to v10.4.18
  Accessibility: Improve landmark markup (#83576)
  Update dependency @types/node to v20.11.25
  Scenes: Row controls (#83607)
  Dashboard scenes: Remove panel menu options that are dashboard editing activities when not in edit mode. (#84156)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add to changelog area/frontend breaking change Relevant for changelog generation levitate breaking change A label indicating a breaking change and assigned by Levitate. no-backport Skip backport of PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explore: Remove deprecated exploreId from QueryEditorProps
4 participants