refactor: scale improvements #1383

monfera · 2021-09-17T06:26:32Z

Summary

Switch to TS 4.4; simplifications; type strength increase via lots of any replacements. Replacement and future prevention of coercive == and != ops

BREAKING CHANGE

The public type variations for domains are discontinued, in favor of retaining the single DomainRange export, which however now has a mandatory {min: number, max: number}. The user can supply NaN where a finite min, max or both aren't defined (ie. in place of former omisison or undefined).
Some console.warn punctuations changed.

Details

All anys removed from continuous and band scales; one any removed from Scale. Some of these any fixes needed some new type assertions in more specific, localized places (very low count), future PRs can attempt to solve those too with type guards or generics.
Lots of code refactoring, optionality removal, parameter removal, function removal, and removal of some ad-hoc types
350 lines removed 👯‍♀️ if we don't count the yarn lock growth due to deps bump

Note to reviewers:

please double check the unit test changes if they're in line with the original intent of those cases
please check the type changes, esp. in place of anys, and the downstream type assertions necessitated by any removal, because the numerous preexisting (and still extant) anys mean that information can't always be learned from other types
ideas about, or follow-up PRs for the reduction of remaining any (eg. in Scale) and the as assertions, necessitated by the removal of the any instances are welcome, due to your experience with the Cartesian implementation and use cases within Elastic

Issues

Checklist

The proper chart type label has been added (e.g. :xy, :partition)
The proper feature labels have been added (e.g. :interactions, :axis)
All related issues have been linked (i.e. closes #123, fixes #123)
New public API exports have been added to packages/charts/src/index.ts
Unit tests have been added or updated to match the most common scenarios
The proper documentation and/or storybook story has been added or updated
The code has been checked for cross-browser compatibility (Chrome, Firefox, Safari, Edge)

monfera · 2021-09-17T10:46:43Z

test this

monfera · 2021-09-17T11:02:27Z

test this

monfera · 2021-09-17T17:00:06Z

test this

monfera · 2021-09-17T20:15:59Z

test this

monfera · 2021-09-17T20:51:28Z

test this

packages/charts/src/components/portal/tooltip_portal.tsx

Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com>

monfera · 2021-09-21T19:06:41Z

test this

nickofthyme

Latest code changes LGTM! Great work Robert!!

nickofthyme · 2021-09-21T22:45:20Z

packages/charts/src/chart_types/xy_chart/utils/specs.ts

-export type UnboundedDomainWithInterval = DomainBase;
-
-/** @public */
-export type DomainRange = LowerBoundedDomain | UpperBoundedDomain | CompleteBoundedDomain | UnboundedDomainWithInterval;
 /** @public */
 export type YDomainRange = YDomainBase & DomainRange & LogScaleOptions;



I failed to find an simple solution to this in the form of some deep partial keys on the spec factory. I'll keep the PR here for reference. #1399

markov00

Great work here Robert, thanks for taking care of this.
I failed miserably the last time I've tried typing the scale, but you did it an awesome job here!

* switch to TS 4.4 and bump other deps * type strength increase via removing many `any` occurrences * domain oriented generic typing for scales * replacement and future prevention of coercive `==` and `!=` ops * refactoring: simplification and shortening of numerous functions, about 300 runtime lines gone * removal of numerous let, if/then, optional parameters etc. BREAKING CHANGE: The public type varieties for domains are discontinued, in favor of retaining the single `DomainRange` export, which now has a mandatory `{min: number, max: number}`. The developer can supply `NaN` where a finite min, max or both aren't defined (ie. in place of former effective `undefined`). In addition, some console.warn punctuations changed Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com> Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

# [37.0.0](v36.0.0...v37.0.0) (2021-10-05) ### Bug Fixes * **debug:** add predictable axis labels sorting order ([#1418](#1418)) ([60fbe7a](60fbe7a)) * **deps:** update dependency @elastic/eui to ^38.1.0 ([#1409](#1409)) ([4ffd018](4ffd018)) * **deps:** update dependency @elastic/eui to ^38.2.0 ([#1416](#1416)) ([34707c3](34707c3)) ### Code Refactoring * cleanup colors ([#1397](#1397)) ([348c061](348c061)) * scale improvements and TS 4.4 ([#1383](#1383)) ([0003bc1](0003bc1)) ### BREAKING CHANGES * `DEFAULT_CHART_MARGINS`, `DEFAULT_GEOMETRY_STYLES`, `DEFAULT_CHART_PADDING` and `DEFAULT_MISSING_COLOR` are no longer exposed as part of the API * The public type varieties for domains are discontinued, in favor of retaining the single `DomainRange` export, which now has a mandatory `{min: number, max: number}`. The developer can supply `NaN` where a finite min, max or both aren't defined (ie. in place of former effective `undefined`). In addition, some console.warn punctuations changed Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com> Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

test: undefined baseline with granular domain override

63a8d02

monfera added :axis Axis related issue :data Data/series/scales related issue :heatmap Heatmap/Swimlane chart related issue :xy Bar/Line/Area chart related code quality wip work in progress labels Sep 17, 2021

monfera added 3 commits September 17, 2021 08:45

fix: ensure at least two array elements

d31d2e0

test: restore singleton undefined for now

63dad76

fix: removing unnecessary let

6c6185d

monfera force-pushed the time-axis-06 branch 3 times, most recently from d3d94a0 to 2d2142a Compare September 17, 2021 08:33

test: typescript four point four

6a5a69e

monfera force-pushed the time-axis-06 branch from 2d2142a to 6a5a69e Compare September 17, 2021 10:30

monfera added 4 commits September 17, 2021 14:26

refactor: enjoying typescript four point four

6ab43ac

refactor: yielding a true or false literal can always be simplified

08838a9

chore: linter appeasement

5d12a2a

test: removing more scale assertions 01

abfd291

test: removing more scale assertions 02

5a1b349

test: relax a type for truthfulness as strings do also occur

ae9b210

monfera force-pushed the time-axis-06 branch from 0751744 to ae9b210 Compare September 17, 2021 20:36

monfera commented Sep 17, 2021

View reviewed changes

packages/charts/src/components/portal/tooltip_portal.tsx Outdated Show resolved Hide resolved

monfera removed the wip work in progress label Sep 17, 2021

monfera requested a review from nickofthyme September 17, 2021 21:38

monfera and others added 7 commits September 21, 2021 17:22

refactor: eq neq optimizations 04 part 2

e61c7eb

chore: remove duplication

cea8e19

Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

chore: remove eslint exemption

3f44bd6

Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

chore: remove eslint exemption

854ea38

Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

test: remove overtyping

0de55eb

Co-authored-by: Nick Partridge <nick.ryan.partridge@gmail.com>

test: remove overtyping update

604a1e0

refactor: simpler uniqueValues

820f3fd

Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com>

monfera force-pushed the time-axis-06 branch from 85cbf96 to 820f3fd Compare September 21, 2021 15:34

monfera added 8 commits September 21, 2021 17:39

refactor: eq neq optimizations 05 - just comments and minor reorg

908a7f8

chore: linter wants one line

9dd03e1

refactor: eq neq optimizations 06

7cdd7a9

refactor: eq neq optimizations 07

78342e3

refactor: eq neq optimizations 08

6f8bf4c

refactor: eq neq optimizations 09

23513e2

fix: simplification regression

2a69ec5

test: yield false and simplify type

e532321

monfera requested review from markov00 and nickofthyme September 21, 2021 18:49

chore: remove unused try/catch

8a90a96

nickofthyme approved these changes Sep 21, 2021

View reviewed changes

markov00 approved these changes Sep 22, 2021

View reviewed changes

monfera merged this pull request into master Sep 22, 2021

monfera deleted the time-axis-06 branch September 22, 2021 09:44

markov00 mentioned this pull request Oct 5, 2021

Update dependency @elastic/charts to v37 (master) elastic/kibana#113968

Merged

markov00 mentioned this pull request Jan 12, 2022

fix(xy): switch default timezone to local #1544

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: scale improvements #1383

refactor: scale improvements #1383

monfera commented Sep 17, 2021 •

edited

Loading

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 21, 2021

nickofthyme left a comment

nickofthyme Sep 21, 2021

markov00 left a comment

refactor: scale improvements #1383

refactor: scale improvements #1383

Conversation

monfera commented Sep 17, 2021 • edited Loading

Summary

BREAKING CHANGE

Details

Issues

Checklist

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 17, 2021

monfera commented Sep 21, 2021

nickofthyme left a comment

Choose a reason for hiding this comment

nickofthyme Sep 21, 2021

Choose a reason for hiding this comment

markov00 left a comment

Choose a reason for hiding this comment

monfera commented Sep 17, 2021 •

edited

Loading