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.

Sign up for GitHub

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

Jump to bottom

Changes rewriteBasePath core config deprecation level to warning #114566

Merged
merged 2 commits into from
Oct 12, 2021
Merged

Changes rewriteBasePath core config deprecation level to warning #114566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67cfad4
Changes deprecation level to warning
TinaHeiligers Oct 11, 2021
7842f7f
Merge branch 'master' into kbn-103915-change-rewriteBasePath-level
kibanamachine Oct 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/core/server/config/deprecation/core_deprecations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ describe('core deprecations', () => {

describe('rewriteBasePath', () => {
it('logs a warning is server.basePath is set and server.rewriteBasePath is not', () => {
const { messages } = applyCoreDeprecations({
const { messages, levels } = applyCoreDeprecations({
server: {
basePath: 'foo',
},
Expand All @@ -64,6 +64,11 @@ describe('core deprecations', () => {
"You should set server.basePath along with server.rewriteBasePath. Starting in 7.0, Kibana will expect that all requests start with server.basePath rather than expecting you to rewrite the requests in your reverse proxy. Set server.rewriteBasePath to false to preserve the current behavior and silence this warning.",
]
`);
expect(levels).toMatchInlineSnapshot(`
Array [
"warning",
]
`);
});

it('does not log a warning if both server.basePath and server.rewriteBasePath are unset', () => {
Expand Down
1 change: 1 addition & 0 deletions src/core/server/config/deprecation/core_deprecations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const rewriteBasePathDeprecation: ConfigDeprecation = (settings, fromPath, addDe
'will expect that all requests start with server.basePath rather than expecting you to rewrite ' +
'the requests in your reverse proxy. Set server.rewriteBasePath to false to preserve the ' +
'current behavior and silence this warning.',
level: 'warning',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed the level to warning for this deprecation to help with cleaning up UA. We need to do some research before deciding on an approach for fully handling the deprecation.

correctiveActions: {
manualSteps: [
`Set 'server.rewriteBasePath' in the config file, CLI flag, or environment variable (in Docker only).`,
Expand Down