Upgrade elastic charts v43.1.1 by nickofthyme · Pull Request #121593 · elastic/kibana

nickofthyme · 2021-12-18T21:17:24Z

Summary

This PR updates @elastic/charts to v43.0.0 which included some breaking changes listed below per version.

`v41.0.0`

Removal of config from Partition, Heatmap, Goal and Wordcloud specs. The config props were moved to either the respective spec or theme section. See details breaking changes from v41.0.0.

`v42.0.0`

types: The xAccessor and yAccessor are now required on all xy chart specs. Stronger typing on data prop that may cause type errors when using untyped array (i.e. const arr: never[] = []). Other minor type changes related to spec types.
heatmap: The heatmap yAxisLabel.padding style type is changed from Pixel | Partial to Pixels | Padding. The heatmap axis labels are now correctly subjected to padding calculations and it will result in a slightly different position of labels.

`v43.0.0`

xy: The time axis labels of a time-series chart configured without the timeZone prop are now rendering the labels with the local browser timezone instead of UTC.

Followup needed to deprecate EuiChartTheme.partition in elastic/eui#5492. Workaround used for now.

Checklist

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

elasticmachine · 2022-01-05T21:07:03Z

Pinging @elastic/datavis (Feature:ElasticCharts)

elasticmachine · 2022-01-05T21:07:05Z

Pinging @elastic/kibana-vis-editors @elastic/kibana-vis-editors-external (Team:VisEditors)

nickofthyme · 2022-01-20T21:09:14Z

@stratoula Ok sorry for the delay. I just updated the branch with the two bug fixes that you mentioned. Ready for your review when you have time. Thanks!

nickofthyme · 2022-01-21T16:24:58Z

@elasticmachine merge upstream

nickofthyme · 2022-01-21T16:27:16Z

@elastic/kibana-operations could you review 81d7707?

We removed the need for the ResizeObserver pollyfill in charts and noticed all the jest tests failed. Are you ok adding this pollyfill to the jest preset setup?

Example error ⬇️ Link

FAIL  src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.test.tsx (33.765 s)
--
  | ● Console
  |  
  | console.error
  | Error: Uncaught [ReferenceError: ResizeObserver is not defined]
  | at reportException (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/helpers/runtime-script-errors.js:62:24)
  | at innerInvokeEventListeners (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:333:9)
  | at invokeEventListeners (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:274:3)
  | at HTMLUnknownElementImpl._dispatch (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:221:9)
  | at HTMLUnknownElementImpl.dispatchEvent (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:94:17)
  | at HTMLUnknownElement.dispatchEvent (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/jest-environment-jsdom/node_modules/jsdom/lib/jsdom/living/generated/EventTarget.js:231:34)
  | at Object.invokeGuardedCallbackDev (/opt/local-ssd/buildkite/builds/kb-n2-4-311b2dfa96b59569/elastic/kibana-pull-request/kibana/node_modules/react-dom/cjs/react-dom.development.js:385:16)

stratoula · 2022-01-24T07:30:17Z

@elasticmachine merge upstream

stratoula

@nickofthyme thank you so much for fixing everything! I can't find any other regression! Code LGTM!

spalger · 2022-01-24T15:17:59Z

packages/kbn-test/src/jest/setup/polyfills.js

 // https://github.com/elastic/eui/issues/3713
 global._isJest = true;
+
+global.ResizeObserver = require('resize-observer-polyfill');


It looks like we typically use ResizeObserver via import { ResizeObserver } from 'resize-observer-polyfill' and not via the global. We don't currently do something like this in the browser, and if this polyfill is necessary for @elastic/charts we should probably include the polyfill in packages/kbn-ui-shared-deps-src/src/polyfills.js

Hey @spalger actually the ResizeObserver is supported by all major browsers we support and we don't need anymore the polyfill.
That's why I've removed the polyfill from the @elastic/charts package.

The problem is that the ResizeObserver object is not available in the window object of JSDOM when running the Jest test. Looks like it is not implemented in JSDOM@26.

I don't think we need to include it into packages/kbn-ui-shared-deps-src/src/polyfills.js and I don't think I need to revert our changes in charts to bring back that polyfill. The polyfill should just live in the test environment because is not supported, but we should not include it in our distribution. What do you think?

I think I've found the issue: in TS the ResizeObserver object is available as a global and it got compiled correctly.
Instead, in JSDOM it is not global but is only a window object.
I've changed the chart compiled code to use window.ResizeObserver instead and the tests are passing. I will push an update into charts soon to fix that

Nice, thanks!

Actually, this doesn't solve the problem, I can't figure it ATM so I'm reverting back our commit in the elastic-charts and to include back again the polyfill.
This is anyway an issue that needs to be solved: JSDOM doesn't mock/support the ResizeObserver API, Kibana is using 3 years old with no commits resize-observer-polyfill library.

kibana-ci · 2022-01-26T15:09:50Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	2.8MB	2.8MB	+158.0B
`dataVisualizer`	539.4KB	539.4KB	+30.0B
`expressionHeatmap`	15.0KB	15.0KB	-42.0B
`expressionPie`	39.4KB	39.6KB	+179.0B
`lens`	1.0MB	1.0MB	+72.0B
`ml`	3.5MB	3.5MB	+51.0B
`uptime`	704.1KB	704.2KB	+70.0B
`visTypeTimelion`	121.3KB	121.3KB	+38.0B
total			+556.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`kibana`	944	929	-15

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`charts`	58.3KB	58.3KB	+23.0B
`kbnUiSharedDeps-npmDll`	6.1MB	6.1MB	+5.8KB
`observability`	84.0KB	83.9KB	-69.0B
total			+5.8KB

History

💔 Build #19499 failed 417c401
💔 Build #19241 failed e10b732
💚 Build #18985 succeeded a6534d1
💚 Build #18909 succeeded 1418ec5
💔 Build #18844 failed 98597ab

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

dominiqueclarke

RUM charts LGTM

dgieselaar

Looked at the code changes and did a quick scan of APM app charts, LGTM!

We bring back the polyfill removing the changes made to the jest polyfill global env #121593 (comment)

nickofthyme added 4 commits December 18, 2021 14:16

bump version

2b95c18

fix breaking changes in partition charts

ab60941

fix breaking changes in heatmap charts

40c513d

fix more type errors

d6e4973

nickofthyme added Feature:ElasticCharts Issues related to the elastic-charts library Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// Feature:Vis Editor Visualization editor issues Feature:Lens labels Dec 18, 2021

nickofthyme requested review from darnautov, markov00 and stratoula December 18, 2021 21:17

nickofthyme added the blocked label Dec 19, 2021

nickofthyme mentioned this pull request Dec 20, 2021

Update elastic-charts to v41.0.1 elastic/eui#5492

Merged

nickofthyme added 3 commits January 4, 2022 15:26

Merge branch 'main' into upgrade-charts-41-breaking

76ac2f3

use workaround for eui blocking changes

b9071a4

fix pr check errors

da31c8e

nickofthyme changed the title ~~Upgrade elastic charts v41.0.0 - breaking~~ Upgrade elastic charts v41.0.1 - breaking Jan 5, 2022

fix pr check errors

1d1ac03

nickofthyme marked this pull request as ready for review January 5, 2022 21:07

nickofthyme requested a review from a team January 5, 2022 21:07

nickofthyme requested review from a team as code owners January 5, 2022 21:07

nickofthyme added v7.17.0 v8.1.0 backport:skip This PR does not require backporting and removed blocked backport:skip This PR does not require backporting labels Jan 5, 2022

add ResizeObserver pollyfill to jest setup

81d7707

nickofthyme requested a review from a team as a code owner January 21, 2022 16:24

Merge branch 'main' into upgrade-charts-41-breaking

1418ec5

Merge branch 'main' into upgrade-charts-41-breaking

a6534d1

stratoula approved these changes Jan 24, 2022

View reviewed changes

angorayc approved these changes Jan 24, 2022

View reviewed changes

spalger previously requested changes Jan 24, 2022

View reviewed changes

Revert adding resize observer polyfill

e10b732

markov00 mentioned this pull request Jan 24, 2022

[charts] Fix timezone regression in charts #123663

Merged

markov00 added 2 commits January 25, 2022 19:35

Merge remote-tracking branch 'upstream/main' into pr/121593

f48385c

Update charts to 43.1.0

417c401

markov00 force-pushed the upgrade-charts-41-breaking branch from 1296e36 to 417c401 Compare January 25, 2022 18:40

markov00 added 2 commits January 26, 2022 14:02

Revert removal of resize-observer-polyfill

7daab93

Merge remote-tracking branch 'upstream/main' into pr/121593

68e6570

This was referenced Jan 26, 2022

Update dependency @elastic/charts to v43 #123543

Closed

Update dependency @elastic/charts to v43 (main) #123553

Closed

dominiqueclarke self-requested a review January 26, 2022 15:54

markov00 requested a review from spalger January 26, 2022 16:00

dominiqueclarke approved these changes Jan 26, 2022

View reviewed changes

dgieselaar approved these changes Jan 27, 2022

View reviewed changes

markov00 changed the title ~~Upgrade elastic charts v43.0.0~~ Upgrade elastic charts v43.1.1 Jan 27, 2022

markov00 merged commit 71e9c60 into elastic:main Jan 27, 2022

kibanamachine added the backport:skip This PR does not require backporting label Jan 27, 2022

nickofthyme deleted the upgrade-charts-41-breaking branch January 27, 2022 16:57

Conversation

nickofthyme commented Dec 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

v41.0.0

v42.0.0

v43.0.0

Checklist

Uh oh!

elasticmachine commented Jan 5, 2022

Uh oh!

elasticmachine commented Jan 5, 2022

Uh oh!

nickofthyme commented Jan 20, 2022

Uh oh!

nickofthyme commented Jan 21, 2022

Uh oh!

nickofthyme commented Jan 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stratoula commented Jan 24, 2022

Uh oh!

stratoula left a comment

Choose a reason for hiding this comment

Uh oh!

spalger Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

markov00 Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

markov00 Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

spalger Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

markov00 Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented Jan 26, 2022

💚 Build Succeeded

Metrics [docs]

Async chunks

Public APIs missing exports

Page load bundle

History

Uh oh!

dominiqueclarke left a comment

Choose a reason for hiding this comment

Uh oh!

dgieselaar left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

nickofthyme commented Dec 18, 2021 •

edited

Loading

`v41.0.0`

`v42.0.0`

`v43.0.0`

nickofthyme commented Jan 21, 2022 •

edited

Loading

spalger Jan 24, 2022 •

edited

Loading