[Data Plugin] Allow server-side date formatters to accept custom timezone by tsullivan · Pull Request #70668 · elastic/kibana

tsullivan · 2020-07-02T21:58:12Z

Summary

Related to: https://github.com/elastic/kibana/pull/29977/files and adds the timezone formatting capability for the date_server field formatter.

When Advanced Settings shows the date format timezone to be "Browser,"
this means nothing to field formatters in the server-side context. The
field formatters need a way to accept custom format parameters. This
allows a server-side module that creates a FieldFormatMap to set a
timezone as a custom parameter. When custom formatting parameters exist,
they get combined with the defaults.

Changes:

Copy DateNanosFormat from being a "common" field formatter to being 2 different formatters for browser and server
Add setCustomParams to the FieldFormatsRegistry class

For context, this change is needed by this PR: https://github.com/elastic/kibana/pull/67027/files#diff-fc7a35232cdea756fb74dd6433e1e086R94

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

tsullivan · 2020-07-02T21:59:19Z

src/plugins/data/common/field_formats/constants/base_formatters.ts

DateNanosFormat should not be a "common" formatter, since it requires different server-side behavior. It needs this because of the possibility that dateFormat:tz setting could be Browser

tsullivan · 2020-07-02T22:01:56Z

src/plugins/data/server/field_formats/converters/date_nanos_server.ts

This section is copied from the date_server file

…zone When Advanced Settings shows the date format timezone to be "Browser," this means nothing to field formatters in the server-side context. The field formatters need a way to accept custom format parameters. This allows a server-side module that creates a FieldFormatMap to set a timezone as a custom parameter. When custom formatting parameters exist, they get combined with the defaults.

joelgriffith

Changes, as far as I can grok them, seem to be good

tsullivan · 2020-07-07T21:56:03Z

@mattkime @lizozom can you let me know if the general approach I explored here seems reasonable from the App Arch side? If so, I will keep pursuing this PR to make it ready for merge.

If yes, then I will need to work on fixing the functional tests. I'm not sure but it looks like I have broken date_nanos formatting for other plugins. I could use a pointer on where to look there, or figure out who to ask.

mattkime · 2020-07-08T17:42:13Z

@tsullivan looks good to me!

src/plugins/data/public/index.ts

elasticmachine · 2020-07-08T21:57:04Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.fieldformats.md

tsullivan · 2020-07-09T23:21:21Z

src/plugins/data/common/field_formats/field_formats_registry.ts

+    };

-    return this.getInstance(conf.id, conf.params);
+    return this.getInstance(conf.id, instanceParams);


This allows timezone to be passed from the browser and formatted correctly on the server

tsullivan · 2020-07-13T04:18:28Z

@elasticmachine merge upstream

src/plugins/data/server/field_formats/converters/date_nanos_server.ts

kibanamachine · 2020-07-13T18:53:04Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: ed749eb

Build metrics

✅ unchanged

History

💔 Build #60947 failed 4e5eebd
💔 Build #60729 failed 54fa2fe
💔 Build #60641 failed 1b6e9e8
💔 Build #60556 failed 736e9ee
💔 Build #59903 failed 5aa2d80

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

tsullivan · 2020-07-13T21:00:04Z

@elastic/kibana-app-arch @mattkime would anyone be able to give the final approval for this? I have a PR targeted for 7.9 that depends on this. Thanks!

…zone (elastic#70668) * [Data Plugin] Allow server-side date formatters to accept custom timezone When Advanced Settings shows the date format timezone to be "Browser," this means nothing to field formatters in the server-side context. The field formatters need a way to accept custom format parameters. This allows a server-side module that creates a FieldFormatMap to set a timezone as a custom parameter. When custom formatting parameters exist, they get combined with the defaults. * add more to tests - need help though * simplify changes * api doc changes * fix src/plugins/data/public/field_formats/constants.ts * rerun api changes * re-use public code in server, add test * fix path for tests * weird api change needed but no real diff * 3td time api doc chagens * move shared code to common Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

…zone (#70668) (#71556) * [Data Plugin] Allow server-side date formatters to accept custom timezone When Advanced Settings shows the date format timezone to be "Browser," this means nothing to field formatters in the server-side context. The field formatters need a way to accept custom format parameters. This allows a server-side module that creates a FieldFormatMap to set a timezone as a custom parameter. When custom formatting parameters exist, they get combined with the defaults. * add more to tests - need help though * simplify changes * api doc changes * fix src/plugins/data/public/field_formats/constants.ts * rerun api changes * re-use public code in server, add test * fix path for tests * weird api change needed but no real diff * 3td time api doc chagens * move shared code to common Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

tsullivan commented Jul 2, 2020

View reviewed changes

tsullivan added release_note:skip Skip the PR/issue when compiling release notes v7.9.0 v8.0.0 Team:AppArch labels Jul 2, 2020

tsullivan added 3 commits July 6, 2020 09:58

add more to tests - need help though

6428455

simplify changes

1789afc

tsullivan force-pushed the data/allow-custom-formatting branch from 21cc35d to 1789afc Compare July 6, 2020 16:58

tsullivan requested review from lizozom and mattkime July 6, 2020 16:59

tsullivan mentioned this pull request Jul 6, 2020

[Reporting] Formatting fixes for CSV export in Discover, CSV download from Dashboard panel #67027

Merged

4 tasks

joelgriffith approved these changes Jul 7, 2020

View reviewed changes

tsullivan added 2 commits July 8, 2020 12:04

Merge branch 'master' into data/allow-custom-formatting

76e2c30

api doc changes

5aa2d80

tsullivan commented Jul 8, 2020

View reviewed changes

src/plugins/data/public/index.ts Show resolved Hide resolved

tsullivan marked this pull request as ready for review July 8, 2020 21:57

tsullivan requested a review from a team as a code owner July 8, 2020 21:57

tsullivan added 2 commits July 9, 2020 15:03

Merge branch 'master' into data/allow-custom-formatting

206aed6

Merge branch 'master' into data/allow-custom-formatting

d42275c

tsullivan commented Jul 9, 2020

View reviewed changes

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.fieldformats.md Show resolved Hide resolved

tsullivan commented Jul 9, 2020

View reviewed changes

tsullivan added 4 commits July 9, 2020 16:31

fix src/plugins/data/public/field_formats/constants.ts

231f793

rerun api changes

1e1d3c5

re-use public code in server, add test

1bebcc8

fix path for tests

736e9ee

tsullivan added 2 commits July 10, 2020 14:51

Merge branch 'master' into data/allow-custom-formatting

fc9ff7b

weird api change needed but no real diff

1b6e9e8

elasticmachine and others added 3 commits July 12, 2020 22:18

Merge branch 'master' into data/allow-custom-formatting

54fa2fe

Merge branch 'master' into data/allow-custom-formatting

34df331

3td time api doc chagens

4e5eebd

tsullivan commented Jul 13, 2020

View reviewed changes

src/plugins/data/server/field_formats/converters/date_nanos_server.ts Outdated Show resolved Hide resolved

move shared code to common

ed749eb

mattkime approved these changes Jul 13, 2020

View reviewed changes

tsullivan merged commit 3222951 into elastic:master Jul 13, 2020

tsullivan deleted the data/allow-custom-formatting branch July 13, 2020 21:53

tsullivan mentioned this pull request Jul 13, 2020

[7.x] [Data Plugin] Allow server-side date formatters to accept custom timezone (#70668) #71556

Merged

tsullivan mentioned this pull request Sep 23, 2020

CSV file generated with erroneous @timestamp field #42231

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data Plugin] Allow server-side date formatters to accept custom timezone#70668

[Data Plugin] Allow server-side date formatters to accept custom timezone#70668
tsullivan merged 17 commits intoelastic:masterfrom
tsullivan:data/allow-custom-formatting

tsullivan commented Jul 2, 2020 •

edited

Loading

Uh oh!

tsullivan Jul 2, 2020

Uh oh!

tsullivan Jul 2, 2020

Uh oh!

joelgriffith left a comment

Uh oh!

tsullivan commented Jul 7, 2020

Uh oh!

mattkime commented Jul 8, 2020

Uh oh!

Uh oh!

elasticmachine commented Jul 8, 2020

Uh oh!

Uh oh!

tsullivan Jul 9, 2020

Uh oh!

tsullivan commented Jul 13, 2020

Uh oh!

Uh oh!

kibanamachine commented Jul 13, 2020

Uh oh!

tsullivan commented Jul 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

tsullivan commented Jul 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

tsullivan Jul 2, 2020

Choose a reason for hiding this comment

Uh oh!

tsullivan Jul 2, 2020

Choose a reason for hiding this comment

Uh oh!

joelgriffith left a comment

Choose a reason for hiding this comment

Uh oh!

tsullivan commented Jul 7, 2020

Uh oh!

mattkime commented Jul 8, 2020

Uh oh!

Uh oh!

elasticmachine commented Jul 8, 2020

Uh oh!

Uh oh!

tsullivan Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

tsullivan commented Jul 13, 2020

Uh oh!

Uh oh!

kibanamachine commented Jul 13, 2020

💚 Build Succeeded

Build metrics

History

Uh oh!

tsullivan commented Jul 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tsullivan commented Jul 2, 2020 •

edited

Loading