Expose current `branch` and `version` to config deprecation providers #113600

pgayvallet · 2021-10-01T08:36:18Z

Summary

Introduce a new ConfigDeprecationContext type containing the current branch and version, and expose it as an additional parameter to ConfigDeprecation.

Example

const someDeprecation: ConfigDeprecation = (settings, fromPath, addDeprecation, { branch }) => {
  if (settings.foo?.deprecated) {
    addDeprecation({
      documentationUrl: `https://www.elastic.co/guide/en/kibana/${branch}/foo.html`,
      message: '"foo.deprecated" has been deprecated and will be removed in 8.0.',
      correctiveActions: {
        manualSteps: [`Remove "foo.deprecated" from your kibana configs.`],
      },
    });
  }
};

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

pgayvallet · 2021-10-01T15:17:29Z

retest

…ation-context

elasticmachine · 2021-10-04T09:08:57Z

Pinging @elastic/kibana-core (Team:Core)

ymao1

Alerting changes LGTM

elasticmachine · 2021-10-04T12:02:52Z

Pinging @elastic/fleet (Team:Fleet)

joshdover

Fleet changes LGTM

azasypkin

Changes in Security/Spaces deprecation tests LGTM.

tsullivan

AppServices test mock changes LGTM

TinaHeiligers

Adding the context here is going to make life so much easier down the road if and when we need to hunt down when something was deprecated. Nice work!
LGTM 😄

TinaHeiligers · 2021-10-05T21:05:44Z

packages/kbn-config/src/deprecation/types.ts

@@ -229,4 +248,5 @@ export interface ConfigDeprecationFactory {
 export interface ConfigDeprecationWithContext {
  deprecation: ConfigDeprecation;
  path: string;
+  context: ConfigDeprecationContext;


The context is going to make our lives so much easier down the road!

TinaHeiligers · 2021-10-05T21:36:21Z

packages/kbn-config/src/config_service.ts

+
+const createDeprecationContext = (env: Env): ConfigDeprecationContext => {
+  return {
+    branch: env.packageInfo.branch,


I was looking at the type changes and started thinking about validation immediately. Now it all makes sense! 😄

…ation-context

kibanamachine · 2021-10-06T07:55:00Z

💚 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
`core`	1020	1019	-1

Unknown metric groups

API count

id	before	after	diff
`core`	2293	2300	+7

History

💚 Build #157365 succeeded 647c1f4
💚 Build #157134 succeeded dbc6d2d
💔 Build #157056 failed dbc6d2d
💔 Build #157040 failed bd9fa76
💔 Build #157030 failed 98822a6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…elastic#113600) * Expose deprecation context to config deprecations * fix import * add correct doc annotations * fix another test file * update generated doc * fix yet another test file * fix more types * add proper mock * fix import

kibanamachine · 2021-10-06T09:02:39Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…elastic#113600) * Expose deprecation context to config deprecations * fix import * add correct doc annotations * fix another test file * update generated doc * fix yet another test file * fix more types * add proper mock * fix import

…viders (#113600) (#114067) * Expose current `branch` and `version` to config deprecation providers (#113600) * Expose deprecation context to config deprecations * fix import * add correct doc annotations * fix another test file * update generated doc * fix yet another test file * fix more types * add proper mock * fix import * lint ? * restore changes to files removed in master

This was made possible via PR elastic#113600.

watson · 2021-10-07T11:54:22Z

Created two PRs to use this in 7.x and master: #114263 + #114264

…14264) This was made possible via PR #113600.

…ch (#114263) This was made possible via PR #113600.

cauemarcondes · 2021-10-15T18:39:57Z

@pgayvallet on APM I use core.deprecations.registerDeprecations to register a deprecation. I do it because I need to fetch some information on fleet and cloud plugins. Is there a way to get the branch variable in this case?

lukeelmers · 2021-10-15T19:47:45Z

@cauemarcondes We have a separate issue to track adding the branch info in registerDeprecations, but it hasn't been addressed yet: #114065

In the meantime, if you are using registerDeprecations, you can get this as part of the env info that's provided in the plugin initializer context: initializerContext.env.packageInfo.branch. More info on that in this discussion: #112221 (comment)

pgayvallet added 3 commits October 1, 2021 10:35

Expose deprecation context to config deprecations

efedbfa

fix import

ef0130e

add correct doc annotations

6408e36

pgayvallet changed the title ~~Expose current branch and version to deprecation providers~~ Expose current branch and version to config deprecation providers Oct 1, 2021

pgayvallet added 2 commits October 1, 2021 11:03

fix another test file

6cc1f8f

update generated doc

98822a6

pgayvallet added release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.16.0 v8.0.0 labels Oct 1, 2021

pgayvallet added 4 commits October 1, 2021 11:42

fix yet another test file

bd9fa76

fix more types

5605e92

add proper mock

7405098

fix import

dbc6d2d

pgayvallet mentioned this pull request Oct 1, 2021

Allow ConfigDeprecationProvider functions to access current "branch" #112221

Closed

Merge remote-tracking branch 'upstream/master' into kbn-112221-deprec…

647c1f4

…ation-context

pgayvallet marked this pull request as ready for review October 4, 2021 09:08

pgayvallet requested review from a team as code owners October 4, 2021 09:08

ymao1 approved these changes Oct 4, 2021

View reviewed changes

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 4, 2021

joshdover approved these changes Oct 4, 2021

View reviewed changes

azasypkin approved these changes Oct 4, 2021

View reviewed changes

tsullivan approved these changes Oct 5, 2021

View reviewed changes

TinaHeiligers approved these changes Oct 5, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/master' into kbn-112221-deprec…

b66acde

…ation-context

pgayvallet added the auto-backport Deprecated - use backport:version if exact versions are needed label Oct 6, 2021

pgayvallet merged commit 58bab91 into elastic:master Oct 6, 2021

kibanamachine mentioned this pull request Oct 6, 2021

[7.x] Expose current branch and version to config deprecation providers (#113600) #114064

Closed

This was referenced Oct 6, 2021

Allow deprecations registered via core.deprecations to access the current branch #114065

Closed

[7.x] Expose current branch and version to config deprecation providers (#113600) #114067

Merged

watson added a commit to watson/kibana that referenced this pull request Oct 7, 2021

[7.x] Ensure deprecation documentationUrl's point to correct doc branch

1aa7c6d

This was made possible via PR elastic#113600.

watson mentioned this pull request Oct 7, 2021

[7.x] Ensure deprecation documentationUrl's point to correct doc branch #114263

Merged

watson added a commit to watson/kibana that referenced this pull request Oct 7, 2021

Ensure deprecation documentationUrl's point to correct doc branch

fa808f5

This was made possible via PR elastic#113600.

watson mentioned this pull request Oct 7, 2021

Ensure deprecation documentationUrl's point to correct doc branch #114264

Merged

watson added a commit that referenced this pull request Oct 7, 2021

Ensure deprecation documentationUrl's point to correct doc branch (#1…

2eff6d0

…14264) This was made possible via PR #113600.

watson added a commit that referenced this pull request Oct 12, 2021

[7.x] Ensure deprecation documentationUrl's point to correct doc bran…

f64c66c

…ch (#114263) This was made possible via PR #113600.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose current `branch` and `version` to config deprecation providers #113600

Expose current `branch` and `version` to config deprecation providers #113600

pgayvallet commented Oct 1, 2021 •

edited

Loading

pgayvallet commented Oct 1, 2021

elasticmachine commented Oct 4, 2021

ymao1 left a comment

elasticmachine commented Oct 4, 2021

joshdover left a comment

azasypkin left a comment

tsullivan left a comment

TinaHeiligers left a comment

TinaHeiligers Oct 5, 2021

TinaHeiligers Oct 5, 2021

kibanamachine commented Oct 6, 2021

API count

kibanamachine commented Oct 6, 2021

watson commented Oct 7, 2021

cauemarcondes commented Oct 15, 2021

lukeelmers commented Oct 15, 2021

Expose current branch and version to config deprecation providers #113600

Expose current branch and version to config deprecation providers #113600

Conversation

pgayvallet commented Oct 1, 2021 • edited Loading

Summary

Example

Checklist

pgayvallet commented Oct 1, 2021

elasticmachine commented Oct 4, 2021

ymao1 left a comment

Choose a reason for hiding this comment

elasticmachine commented Oct 4, 2021

joshdover left a comment

Choose a reason for hiding this comment

azasypkin left a comment

Choose a reason for hiding this comment

tsullivan left a comment

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

TinaHeiligers Oct 5, 2021

Choose a reason for hiding this comment

TinaHeiligers Oct 5, 2021

Choose a reason for hiding this comment

kibanamachine commented Oct 6, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

API count

History

kibanamachine commented Oct 6, 2021

💚 Backport successful

watson commented Oct 7, 2021

cauemarcondes commented Oct 15, 2021

lukeelmers commented Oct 15, 2021

Expose current `branch` and `version` to config deprecation providers #113600

Expose current `branch` and `version` to config deprecation providers #113600

pgayvallet commented Oct 1, 2021 •

edited

Loading