[Dashboards] Replace contentClient with getContentClient on DashboardStart server api#217586
Merged
nickpeihl merged 2 commits intoelastic:mainfrom Apr 10, 2025
Merged
Conversation
nickpeihl
added
backport:version
nickpeihl
added
the
Team:Presentation
Contributor
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]
History
|
botelastic
bot
added
the
Team:actionable-obs
Contributor
|
Pinging @elastic/obs-ux-management-team (Team:obs-ux-management) |
Contributor
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/14388117195 |
Contributor
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
nickpeihl
added a commit
to nickpeihl/kibana
that referenced
this pull request
Apr 11, 2025
…Start server api (elastic#217586) ## Summary Changes the DashboardStart server api to provide a getContentClient function. In elastic#214788, we set the `contentClient` returned from the content management register method after start lifecycle of all plugins. This means the `contentClient` returned from the `DashboardStart` contract was undefined. This PR changes the start contract to provide a getContentClient function instead. Only one consumer was using the contentClient from DashboardStart and this PR also updates that consumer. (cherry picked from commit 72d18d8) # Conflicts: # x-pack/solutions/observability/plugins/observability/server/routes/alerts/route.ts
Contributor
Author
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added
the
backport missing
Contributor
|
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
1 similar comment
Contributor
|
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
nickpeihl
added a commit
that referenced
this pull request
Apr 15, 2025
…hboardStart server api (#217586) (#217989) # Backport This will backport the following commits from `main` to `8.x`: - [[Dashboards] Replace contentClient with getContentClient on DashboardStart server api (#217586)](#217586) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Nick Peihl","email":"nick.peihl@elastic.co"},"sourceCommit":{"committedDate":"2025-04-10T18:52:38Z","message":"[Dashboards] Replace contentClient with getContentClient on DashboardStart server api (#217586)\n\n## Summary\n\nChanges the DashboardStart server api to provide a getContentClient\nfunction.\n\nIn #214788, we set the\n`contentClient` returned from the content management register method\nafter start lifecycle of all plugins. This means the `contentClient`\nreturned from the `DashboardStart` contract was undefined. This PR\nchanges the start contract to provide a getContentClient function\ninstead.\n\nOnly one consumer was using the contentClient from DashboardStart and\nthis PR also updates that consumer.","sha":"72d18d8b992c99bb0be42123406453f0379f29d8","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Presentation","release_note:plugin_api_changes","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0"],"title":"[Dashboards] Replace contentClient with getContentClient on DashboardStart server api","number":217586,"url":"https://github.com/elastic/kibana/pull/217586","mergeCommit":{"message":"[Dashboards] Replace contentClient with getContentClient on DashboardStart server api (#217586)\n\n## Summary\n\nChanges the DashboardStart server api to provide a getContentClient\nfunction.\n\nIn #214788, we set the\n`contentClient` returned from the content management register method\nafter start lifecycle of all plugins. This means the `contentClient`\nreturned from the `DashboardStart` contract was undefined. This PR\nchanges the start contract to provide a getContentClient function\ninstead.\n\nOnly one consumer was using the contentClient from DashboardStart and\nthis PR also updates that consumer.","sha":"72d18d8b992c99bb0be42123406453f0379f29d8"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/217586","number":217586,"mergeCommit":{"message":"[Dashboards] Replace contentClient with getContentClient on DashboardStart server api (#217586)\n\n## Summary\n\nChanges the DashboardStart server api to provide a getContentClient\nfunction.\n\nIn #214788, we set the\n`contentClient` returned from the content management register method\nafter start lifecycle of all plugins. This means the `contentClient`\nreturned from the `DashboardStart` contract was undefined. This PR\nchanges the start contract to provide a getContentClient function\ninstead.\n\nOnly one consumer was using the contentClient from DashboardStart and\nthis PR also updates that consumer.","sha":"72d18d8b992c99bb0be42123406453f0379f29d8"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
kibanamachine
removed
the
backport missing
Member
|
@nickpeihl just out of curiosity, what is the |
Contributor
Author
|
@florent-leborgne In the context of this PR, we changed how our built-in plugins can access the CRUD client from the dashboard. It is probably not worth noting in our release notes as the changes should not impact external users. |
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
6 participants
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
Changes the DashboardStart server api to provide a getContentClient function.
In #214788, we set the
contentClientreturned from the content management register method after start lifecycle of all plugins. This means thecontentClientreturned from theDashboardStartcontract was undefined. This PR changes the start contract to provide a getContentClient function instead.Only one consumer was using the contentClient from DashboardStart and this PR also updates that consumer.