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

Improve session timeout deprecation messages. #115020

Merged
merged 8 commits into from
Oct 19, 2021
Merged

Improve session timeout deprecation messages. #115020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4308398
Improve session timeout deprecation messages.
azasypkin Oct 14, 2021
82d62f4
Eliminate documentation link and make a manual fix more detailed.
azasypkin Oct 14, 2021
b8a3baa
Merge branch '7.x' into issue-xxx-session-deprecations
azasypkin Oct 15, 2021
4380ce4
Use Word Joiner (U+2060) to prevent wrapping timeout format.
azasypkin Oct 15, 2021
8f225de
Merge branch '7.x' into issue-xxx-session-deprecations
azasypkin Oct 18, 2021
ab2cb08
Merge branch '7.x' into issue-xxx-session-deprecations
azasypkin Oct 18, 2021
cf6bad4
Merge branch '7.x' into issue-xxx-session-deprecations
azasypkin Oct 19, 2021
ed26309
Update deprecation message to mention 8 hours instead of 1.
azasypkin Oct 19, 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
10 changes: 5 additions & 5 deletions x-pack/plugins/security/server/config_deprecations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ describe('Config Deprecations', () => {
Array [
Object {
"level": "warning",
"message": "The session idle timeout will default to 1 hour in 8.0.",
"message": "User sessions will automatically time out after 8 hours of inactivity starting in 8.0. Override this value to change the timeout.",
},
Object {
"level": "warning",
"message": "The session lifespan will default to 30 days in 8.0.",
"message": "Users are automatically required to log in again after 30 days starting in 8.0. Override this value to change the timeout.",
},
]
`);
Expand All @@ -72,7 +72,7 @@ describe('Config Deprecations', () => {
Array [
Object {
"level": "warning",
"message": "The session idle timeout will default to 1 hour in 8.0.",
"message": "User sessions will automatically time out after 8 hours of inactivity starting in 8.0. Override this value to change the timeout.",
},
]
`);
Expand All @@ -86,7 +86,7 @@ describe('Config Deprecations', () => {
Array [
Object {
"level": "warning",
"message": "The session lifespan will default to 30 days in 8.0.",
"message": "Users are automatically required to log in again after 30 days starting in 8.0. Override this value to change the timeout.",
},
]
`);
Expand All @@ -111,7 +111,7 @@ describe('Config Deprecations', () => {
},
Object {
"level": "warning",
"message": "The session lifespan will default to 30 days in 8.0.",
"message": "Users are automatically required to log in again after 30 days starting in 8.0. Override this value to change the timeout.",
},
]
`);
Expand Down
30 changes: 15 additions & 15 deletions x-pack/plugins/security/server/config_deprecations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,25 +225,25 @@ export const securityConfigDeprecationProvider: ConfigDeprecationProvider = ({
}
},
// Default values for session expiration timeouts.
(settings, fromPath, addDeprecation, { branch }) => {
(settings, fromPath, addDeprecation) => {
if (settings?.xpack?.security?.session?.idleTimeout === undefined) {
addDeprecation({
configPath: 'xpack.security.session.idleTimeout',
level: 'warning',
title: i18n.translate('xpack.security.deprecations.idleTimeoutTitle', {
defaultMessage: 'The "xpack.security.session.idleTimeout" default is changing',
defaultMessage: '"xpack.security.session.idleTimeout" is now 8 hours',
}),
message: i18n.translate('xpack.security.deprecations.idleTimeoutMessage', {
defaultMessage: 'The session idle timeout will default to 1 hour in 8.0.',
defaultMessage:
'User sessions will automatically time out after 8 hours of inactivity starting in 8.0. Override this value to change the timeout.',
}),
documentationUrl: `https://www.elastic.co/guide/en/kibana/${branch}/xpack-security-session-management.html#session-idle-timeout`,
correctiveActions: {
manualSteps: [
i18n.translate('xpack.security.deprecations.idleTimeout.manualStepOneMessage', {
defaultMessage: `Set "xpack.security.session.idleTimeout" in your Kibana configuration to override the default session idle timeout.`,
}),
i18n.translate('xpack.security.deprecations.idleTimeout.manualStepTwoMessage', {
defaultMessage: `To disable the session idle timeout, set "xpack.security.session.idleTimeout" to 0.`,
defaultMessage:
'To configure a custom timeout, set "xpack.security.session.idleTimeout". Use the format <count>⁠[ms|s|m|h|d|w|M|Y], for example, 20m, 24h, 7d, 1w. A value of 0 disables the timeout.',
description:
'Please preserve a Word Joiner (U+2060) symbol after <count> in translation.',
}),
],
},
Expand All @@ -255,19 +255,19 @@ export const securityConfigDeprecationProvider: ConfigDeprecationProvider = ({
configPath: 'xpack.security.session.lifespan',
level: 'warning',
title: i18n.translate('xpack.security.deprecations.lifespanTitle', {
defaultMessage: 'The "xpack.security.session.lifespan" default is changing',
defaultMessage: '"xpack.security.session.lifespan" is now 30 days',
}),
message: i18n.translate('xpack.security.deprecations.lifespanMessage', {
defaultMessage: 'The session lifespan will default to 30 days in 8.0.',
defaultMessage:
'Users are automatically required to log in again after 30 days starting in 8.0. Override this value to change the timeout.',
}),
documentationUrl: `https://www.elastic.co/guide/en/kibana/${branch}/xpack-security-session-management.html#session-lifespan`,
correctiveActions: {
manualSteps: [
i18n.translate('xpack.security.deprecations.lifespan.manualStepOneMessage', {
defaultMessage: `Set "xpack.security.session.lifespan" in your Kibana configuration to override the default session lifespan.`,
}),
i18n.translate('xpack.security.deprecations.lifespan.manualStepTwoMessage', {
defaultMessage: `To disable the session lifespan, set "xpack.security.session.lifespan" to 0.`,
defaultMessage:
'To configure a custom timeout, set "xpack.security.session.lifespan". Use the format <count>⁠[ms|s|m|h|d|w|M|Y], for example, 20m, 24h, 7d, 1w. A value of 0 disables the timeout.',
description:
'Please preserve a Word Joiner (U+2060) symbol after <count> in translation.',
}),
],
},
Expand Down