Only set timezone when user setting is a valid timezone #57850

jbudz · 2020-02-18T14:53:36Z

Currently we set the global browser timezone based on the user's
advanced settings. This setting includes a list of timezones and a
non-standard 'Browser' option which can be translated as set the
timezone to my current. In order to avoid warnings and possible future
errors we only set timezone if it exists in moments list of installed
timezones

Closes #38515

Summary

Summarize your PR. If it involves visual changes include a screenshot or gif.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility, including a check against IE11

For maintainers

This was checked for breaking API changes and was labeled appropriately

Currently we set the global browser timezone based on the user's advanced settings. This setting includes a list of timezones and a non-standard 'Browser' option which can be translated as set the timezone to my current. In order to avoid warnings and possible future errors we only set timezone if it exists in moments list of installed timezones Closes elastic#38515

elasticmachine · 2020-02-18T14:53:38Z

Pinging @elastic/kibana-operations (Team:Operations)

elasticmachine · 2020-02-18T14:53:40Z

Pinging @elastic/kibana-platform (Team:Platform)

tylersmalley · 2020-02-18T16:29:23Z

src/core/public/integrations/moment/moment_service.ts

-    const setDefaultTimezone = (tz: string) => moment.tz.setDefault(tz);
+    const setDefaultTimezone = (tz: string) => {
+      const timezones = moment.tz.names();
+      const hasTimezone = timezones.includes(tz);


Looks like Moment has moment.tz.zone which checks for existance, returning the zone if loaded or null otherwise.

Could something like this work?

moment.tz.setDefault(moment.tz.zone(tz))

I gave it a try - zone ends up returning a Zone or null, and we have to access name. It ends up fairly close to this, so I could go either way. lemme know

const zone = moment.tz.zone(tz) if (zone) moment.tz.setDefault(zone.name)

Ah, Zone is an object. I do think it's better to use moment.tz.zone to check for existence, though.

joshdover · 2020-02-18T17:15:00Z

src/core/public/integrations/moment/moment_service.test.ts

+
+    service.start({ uiSettings });
+    await flushPromises();
+    expect(momentMock.tz.setDefault).not.toHaveBeenCalledWith('tz4');


Can we add an assertion that it was called with no args?

joshdover · 2020-02-18T17:15:42Z

src/core/public/integrations/moment/moment_service.test.ts

@@ -47,6 +47,30 @@ describe('MomentService', () => {
    expect(momentMock.updateLocale).toHaveBeenCalledWith('default-locale', { week: { dow: 0 } });
  });

+  it('uses the default timezone when a zone is not defined', async () => {
+    const tz$ = new BehaviorSubject('tz4');


This test might be a bit more obvious if the tz name was something like tz-does-not-exist

mshustov · 2020-02-21T19:08:57Z

src/core/public/integrations/moment/moment_service.ts

-    const setDefaultTimezone = (tz: string) => moment.tz.setDefault(tz);
+    const setDefaultTimezone = (tz: string) => {
+      const zone: string | undefined = get(moment.tz.zone(tz), 'name');
+      moment.tz.setDefault(zone);


could add a test that moment.tz.setDefault(undefined); doesn't remove previously set timezone?

src/core/public/integrations/moment/moment_service.test.ts

src/core/public/integrations/moment/moment_service.ts

Co-Authored-By: Mikhail Shustov <[email protected]>

mshustov · 2020-03-03T17:59:11Z

src/core/public/integrations/moment/moment_service.test.ts

@@ -47,6 +47,26 @@ describe('MomentService', () => {
    expect(momentMock.updateLocale).toHaveBeenCalledWith('default-locale', { week: { dow: 0 } });
  });

+  it('uses the default timezone when a zone is not defined', async () => {


would you mind to update the test suit name? does not set unknown zone

spalger · 2020-03-04T03:08:13Z

@elasticmachine merge upstream

jbudz · 2020-03-10T15:22:48Z

@elasticmachine merge upstream

tylersmalley · 2020-03-19T02:13:27Z

@jbudz, are we waiting for something with this? We have three approvals and green CI's.

jbudz · 2020-03-19T15:24:58Z

@elasticmachine merge upstream

jbudz · 2020-03-19T15:25:29Z

It's good, merging on green.

jbudz · 2020-03-19T20:15:10Z

jenkins, test it

kibanamachine · 2020-03-19T22:01:31Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 7ad2e8b

History

💚 Build #32099 succeeded 35af6e6
💔 Build #30620 failed ea81cc2
💔 Build #30501 failed 4d200d1
💚 Build #30453 succeeded 84c655b
💔 Build #30455 failed c7e412d

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

* Only set timezone when user setting is a valid timezone Currently we set the global browser timezone based on the user's advanced settings. This setting includes a list of timezones and a non-standard 'Browser' option which can be translated as set the timezone to my current. In order to avoid warnings and possible future errors we only set timezone if it exists in moments list of installed timezones Closes #38515 * feedback * only set timezone if defined * Update src/core/public/integrations/moment/moment_service.ts Co-Authored-By: Mikhail Shustov <[email protected]> * Update src/core/public/integrations/moment/moment_service.ts Co-Authored-By: Mikhail Shustov <[email protected]> * Update src/core/public/integrations/moment/moment_service.test.ts Co-Authored-By: Mikhail Shustov <[email protected]> * Update src/core/public/integrations/moment/moment_service.test.ts Co-Authored-By: Mikhail Shustov <[email protected]> * update test name Co-authored-by: Mikhail Shustov <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

jbudz · 2020-03-20T16:03:51Z

7.x f0059a3

* master: (55 commits) Update dependency @elastic/charts to v18.1.0 (elastic#60578) Only set timezone when user setting is a valid timezone (elastic#57850) [NP] Remove `ui/agg_types` dependencies and move paginated table to kibana_legacy (elastic#60276) [SIEM] Fix types in rules tests (elastic#60736) [Alerting] prevent flickering when fields are updated in an alert (elastic#60666) License checks for actions plugin (elastic#59070) Implemented ability to clear and properly validate alert interval (elastic#60571) WebElementWrapper: add findByTestSubject/findAllByTestSubject to search with data-test-subj (elastic#60568) [Maps] Update layer dependencies to NP (elastic#59585) [Discover] Remove StateManagementConfigProvider (elastic#60221) [ML] Listing all categorization wizard checks (elastic#60502) [Upgrade Assistant] First iteration of batch reindex docs (elastic#59887) [SIEM] Export timeline (elastic#58368) [SIEM] Add support for actions and throttle in Rules (elastic#59641) Fix ace a11y listener (elastic#60639) Add addInfo toast to core notifications service (elastic#60574) fix test description (elastic#60638) [SIEM] Cypress screenshots upload to google cloud (elastic#60556) [canvas/shareable_runtime] sync sass loaders with kbn/optimizer (elastic#60653) [SIEM] Fixes Modification of ML Rules (elastic#60662) ...

* master: Only set timezone when user setting is a valid timezone (elastic#57850) [NP] Remove `ui/agg_types` dependencies and move paginated table to kibana_legacy (elastic#60276) [SIEM] Fix types in rules tests (elastic#60736) [Alerting] prevent flickering when fields are updated in an alert (elastic#60666) License checks for actions plugin (elastic#59070) Implemented ability to clear and properly validate alert interval (elastic#60571) WebElementWrapper: add findByTestSubject/findAllByTestSubject to search with data-test-subj (elastic#60568) [Maps] Update layer dependencies to NP (elastic#59585) [Discover] Remove StateManagementConfigProvider (elastic#60221)

kibanamachine · 2020-03-21T16:08:44Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 57850 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-03-22T16:18:43Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 57850 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-03-23T16:28:43Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 57850 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-03-24T16:38:43Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 57850 or prevent reminders by adding the backport:skip label.

jbudz added review Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Team:Operations Team label for Operations Team release_note:fix v8.0.0 v7.7.0 labels Feb 18, 2020

jbudz requested a review from a team as a code owner February 18, 2020 14:53

tylersmalley reviewed Feb 18, 2020

View reviewed changes

joshdover approved these changes Feb 18, 2020

View reviewed changes

jbudz added 2 commits February 20, 2020 14:17

Merge branch 'master' into fix/moment

4ecefa7

feedback

07f5fc4

tylersmalley approved these changes Feb 20, 2020

View reviewed changes

mshustov reviewed Feb 21, 2020

View reviewed changes

jbudz added 2 commits March 2, 2020 10:33

Merge remote-tracking branch 'upstream/master' into fix/moment

f3bd5ed

only set timezone if defined

10d3edb

mshustov reviewed Mar 3, 2020

View reviewed changes

jbudz and others added 4 commits March 3, 2020 11:43

Update src/core/public/integrations/moment/moment_service.ts

60f76e3

Co-Authored-By: Mikhail Shustov <[email protected]>

Update src/core/public/integrations/moment/moment_service.ts

84c655b

Co-Authored-By: Mikhail Shustov <[email protected]>

Update src/core/public/integrations/moment/moment_service.test.ts

c23333b

Co-Authored-By: Mikhail Shustov <[email protected]>

Update src/core/public/integrations/moment/moment_service.test.ts

c7e412d

Co-Authored-By: Mikhail Shustov <[email protected]>

mshustov approved these changes Mar 3, 2020

View reviewed changes

mshustov reviewed Mar 3, 2020

View reviewed changes

jbudz added 3 commits March 3, 2020 13:27

update test name

d8f04bb

Merge branch 'master' into fix/moment

4bc4111

Merge branch 'fix/moment' of github.com:jbudz/kibana into fix/moment

4d200d1

Merge branch 'master' into fix/moment

ea81cc2

Merge branch 'master' into fix/moment

35af6e6

Merge branch 'master' into fix/moment

7ad2e8b

jbudz merged commit 854f242 into elastic:master Mar 20, 2020

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 21, 2020

jbudz added the backport:skip This commit does not require backporting label Mar 24, 2020

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Only set timezone when user setting is a valid timezone #57850

Only set timezone when user setting is a valid timezone #57850

jbudz commented Feb 18, 2020

elasticmachine commented Feb 18, 2020

elasticmachine commented Feb 18, 2020

tylersmalley Feb 18, 2020

jbudz Feb 18, 2020

tylersmalley Feb 18, 2020

joshdover Feb 18, 2020

joshdover Feb 18, 2020

mshustov Feb 21, 2020

mshustov Mar 3, 2020

spalger commented Mar 4, 2020

jbudz commented Mar 10, 2020

tylersmalley commented Mar 19, 2020

jbudz commented Mar 19, 2020

jbudz commented Mar 19, 2020

jbudz commented Mar 19, 2020

kibanamachine commented Mar 19, 2020

jbudz commented Mar 20, 2020

kibanamachine commented Mar 21, 2020

kibanamachine commented Mar 22, 2020

kibanamachine commented Mar 23, 2020

kibanamachine commented Mar 24, 2020

Only set timezone when user setting is a valid timezone #57850

Only set timezone when user setting is a valid timezone #57850

Conversation

jbudz commented Feb 18, 2020

Summary

Checklist

For maintainers

elasticmachine commented Feb 18, 2020

elasticmachine commented Feb 18, 2020

tylersmalley Feb 18, 2020

Choose a reason for hiding this comment

jbudz Feb 18, 2020

Choose a reason for hiding this comment

tylersmalley Feb 18, 2020

Choose a reason for hiding this comment

joshdover Feb 18, 2020

Choose a reason for hiding this comment

joshdover Feb 18, 2020

Choose a reason for hiding this comment

mshustov Feb 21, 2020

Choose a reason for hiding this comment

mshustov Mar 3, 2020

Choose a reason for hiding this comment

spalger commented Mar 4, 2020

jbudz commented Mar 10, 2020

tylersmalley commented Mar 19, 2020

jbudz commented Mar 19, 2020

jbudz commented Mar 19, 2020

jbudz commented Mar 19, 2020

kibanamachine commented Mar 19, 2020

💚 Build Succeeded

History

jbudz commented Mar 20, 2020

kibanamachine commented Mar 21, 2020

kibanamachine commented Mar 22, 2020

kibanamachine commented Mar 23, 2020

kibanamachine commented Mar 24, 2020