Skip to content

[Dashboard] Deprecate allow by value embeddables setting & remove usage#221165

Merged
ThomThomson merged 9 commits intoelastic:mainfrom
ThomThomson:techDebt/removeAllowByValueEmbeddables
May 28, 2025
Merged

[Dashboard] Deprecate allow by value embeddables setting & remove usage#221165
ThomThomson merged 9 commits intoelastic:mainfrom
ThomThomson:techDebt/removeAllowByValueEmbeddables

Conversation

@ThomThomson
Copy link
Contributor

@ThomThomson ThomThomson commented May 21, 2025

Summary

Removes usage of the allowByValueEmbeddables setting from the Dashboard plugin, and marks the setting as deprecated. Closes #137197

@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson ThomThomson changed the title Remove allow by value embeddables setting. May 22, 2025
@ThomThomson ThomThomson changed the title [Dashboard] Deprecate allow by value embeddables setting. May 22, 2025
@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson
Copy link
Contributor Author

/ci

@ThomThomson ThomThomson marked this pull request as ready for review May 27, 2025 20:41
@ThomThomson ThomThomson requested a review from a team as a code owner May 27, 2025 20:41
},
schema: configSchema,
deprecations: ({ deprecate }) => {
return [deprecate('allowByValueEmbeddables', '9.3.0', { level: 'warning' })];
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is version 9.3.0?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This key is called removeBy - I read that as "this warning will tell Kibana administrators to remove this YML config by this minor"

We're planning on removing this in 10.0, so I figured that it might be good to remind any admins that have this setting to remove it ASAP. If this is meant to remind us when to remove the YML config, then it's 10.0.

A lot of usages of this seem to have "a future version" in that field. I'd be happy to leave it as 9.3, or to switch it to 10.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

why 9.3 instead of the released version of 9.1. 9.3 seems like an odd choice.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True. I just thought "sometime in the future - but not too far in the future" 😄 The guidelines here seem really loose, so I'd honestly be happy with any version.

Copy link
Contributor

Choose a reason for hiding this comment

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

lets go with 9.1 since its marked as deprecated in that version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in a77b155

@ThomThomson ThomThomson added Feature:Dashboard Dashboard related features release_note:deprecation Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// technical debt Improvement of the software architecture and operational architecture backport:prev-minor labels May 28, 2025
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@ThomThomson ThomThomson added loe:small Small Level of Effort impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. labels May 28, 2025
});

export const config: PluginConfigDescriptor<TypeOf<typeof configSchema>> = {
exposeToBrowser: {
Copy link
Contributor

Choose a reason for hiding this comment

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

Does allowByValueEmbeddables still need to be exposed to browser if its no longer used any where. I think we could remove exposeToBrowser section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done in d20db46

Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

LGTM
code review only

@ThomThomson ThomThomson requested a review from a team as a code owner May 28, 2025 16:47
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
dashboard 83 84 +1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
dashboard 18.1KB 17.8KB -231.0B
Unknown metric groups

API count

id before after diff
dashboard 88 89 +1

History

Copy link
Contributor

@kc13greiner kc13greiner left a comment

Choose a reason for hiding this comment

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

LGTM!

@ThomThomson ThomThomson merged commit 754afac into elastic:main May 28, 2025
10 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/15309132711

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
9.0 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 221165

Questions ?

Please refer to the Backport tool documentation

akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
…ge (elastic#221165)

Removes usage of the `allowByValueEmbeddables` setting
@ThomThomson
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

ThomThomson added a commit to ThomThomson/kibana that referenced this pull request May 29, 2025
…ge (elastic#221165)

Removes usage of the `allowByValueEmbeddables` setting

(cherry picked from commit 754afac)

# Conflicts:
#	src/platform/plugins/shared/dashboard/public/dashboard_actions/register_actions.ts
#	src/platform/plugins/shared/dashboard/public/plugin.tsx
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 29, 2025
@kibanamachine
Copy link
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.
cc: @ThomThomson

ThomThomson added a commit that referenced this pull request May 29, 2025
…ve usage (#221165) (#221952)

# Backport

This will backport the following commits from `main` to `9.0`:
- [[Dashboard] Deprecate allow by value embeddables setting & remove
usage (#221165)](#221165)

<!--- Backport version: 10.0.0 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Devon
Thomson","email":"devon.thomson@elastic.co"},"sourceCommit":{"committedDate":"2025-05-28T19:43:06Z","message":"[Dashboard]
Deprecate allow by value embeddables setting & remove usage
(#221165)\n\nRemoves usage of the `allowByValueEmbeddables`
setting","sha":"754afacb8e25e1b741a9f7a5b2cdc0b1ba243603","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Dashboard","release_note:deprecation","Team:Presentation","loe:small","technical
debt","impact:low","backport:prev-minor","v9.1.0"],"title":"[Dashboard]
Deprecate allow by value embeddables setting & remove
usage","number":221165,"url":"https://github.com/elastic/kibana/pull/221165","mergeCommit":{"message":"[Dashboard]
Deprecate allow by value embeddables setting & remove usage
(#221165)\n\nRemoves usage of the `allowByValueEmbeddables`
setting","sha":"754afacb8e25e1b741a9f7a5b2cdc0b1ba243603"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/221165","number":221165,"mergeCommit":{"message":"[Dashboard]
Deprecate allow by value embeddables setting & remove usage
(#221165)\n\nRemoves usage of the `allowByValueEmbeddables`
setting","sha":"754afacb8e25e1b741a9f7a5b2cdc0b1ba243603"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine added v9.0.2 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels May 29, 2025
@mistic
Copy link
Contributor

mistic commented Jun 3, 2025

This PR didn't make it into the latest 9.0.2 BC. Updating the labels.

@mistic mistic added v9.0.3 and removed v9.0.2 labels Jun 3, 2025
zacharyparikh pushed a commit to zacharyparikh/kibana that referenced this pull request Jun 4, 2025
…ge (elastic#221165)

Removes usage of the `allowByValueEmbeddables` setting
nickpeihl pushed a commit to nickpeihl/kibana that referenced this pull request Jun 12, 2025
…ge (elastic#221165)

Removes usage of the `allowByValueEmbeddables` setting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature:Dashboard Dashboard related features impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort release_note:deprecation Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// technical debt Improvement of the software architecture and operational architecture v9.0.3 v9.1.0

6 participants