[Unified Histogram] [Discover] Unified Histogram solutions cleanup by davismcphee · Pull Request #146352 · elastic/kibana

davismcphee · 2022-11-27T01:02:04Z

Summary

This PR includes a number of updates to Unified Histogram to prepare for sharing with solutions, as well as updating its usage in Discover:

Unified Histogram:

Adds a disableAutoFetching prop, similar to Unified Field List, to disable automatic Unified Histogram refetching based on prop changes.
Accepts an input$ observable prop that can be used to control manual refetches.
Removes refetchId used internally and replaces it with an observables based approach to simplify refetch logic.
Introduces a use_stable_callback utility hook to create callback functions with stable identities which simplifies useCallback logic — should be replaced with useEvent or whatever the React team comes up with to solve this specific issue when available: RFC: useEvent reactjs/rfcs#220.
Eliminates debouncing logic in Unified Histogram since it was hacky — manual refetching should be used instead if debouncing is needed.
Accepts query, filters, and timeRange props to remove dependencies on specific services.
Updates use_request_params to export getTimeRange and updateTimeRange functions for easier absolute time range handling.
Exposes some Lens embeddable props to allow further customizing Unified Histogram behaviour.

Discover:

Exports a fetch$ observable from use_saved_search to allow listening for when data fetches should be triggered.
Uses new manual refetching support in Unified Histogram to simplify refetching logic.
Passes query, filters, and timeRange props to Unified Histogram.

Checklist

~~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
~~Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

src/plugins/unified_histogram/public/layout/layout.tsx

…, and prevent multiple fetches

…sing trigger callbacks to Lens embeddable or disabling them

…quest was sent, resulting in it being unavailable in the inspector

…-fix'

elasticmachine · 2023-01-09T19:19:32Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

src/plugins/discover/public/application/main/hooks/use_saved_search.ts

kertal · 2023-01-13T14:11:24Z

src/plugins/discover/public/application/main/hooks/use_saved_search.ts

+    [
      data,
+      initialFetchStatus,
+      inspectorAdapters.requests,
      main$,
      refetch$,
      searchSessionManager,
      searchSource,
-      initialFetchStatus,
-    });
+      services.toastNotifications,
+      setAutoRefreshDone,
+      timefilter,
+    ]
+  );


those deps will soon be gone, just saying ... with the whole file saved from a hook ... #148614

kertal · 2023-01-13T14:28:34Z

src/plugins/unified_histogram/public/chart/use_stable_callback.ts

+ * Accepts a callback and returns a function with a stable identity
+ * that will always call the latest version of the callback when invoked
+ */
+export const useStableCallback = <T extends (...args: any[]) => any>(fn: T | undefined) => {


maybe thats's something for react-use of @vadimkibana ?

https://github.com/streamich/react-use

That's actually where I went looking for an implementation originally, but unfortunately had to fall back on a custom one. Definitely a useful pattern, although I wonder how useful an addition it would be if the React team intends to implement an official version in the near future -- or so they say 😄

kertal · 2023-01-13T14:40:00Z

src/plugins/unified_histogram/public/chart/chart.tsx

+  disableTriggers,
+  disabledActions,


to understand it correctly, we offer disableTriggers + disableActions just for alignment, but don't set custom values ... I'm interested, what's the user case to set them?

Yeah this change was more in anticipation of future needs from other consumers. The main use case would be to disable adding/removing filters from the legend, disable time range scrubbing, etc. for cases where filters or the time range might not be modifiable. These actions also integrate with the search service by default which might not be used in some situations.

kertal

Code LGMT, nice cleanups under the hood! Tested a-la-carte and didn't manage to break it.
Now this PR is also linked on the react repo page

Since I guess you're famous now, I'm looking for this meet in greet near Disneyworld even more!

kertal · 2023-01-16T08:50:09Z

@elasticmachine merge upstream

jughosta · 2023-01-16T10:16:48Z

When testing noticed that after switching data views, the time selection becomes weird (both via chart and via the time picker):

davismcphee · 2023-01-18T04:04:39Z

@jughosta Great catch! That was a really tricky one -- since use_query_subscriber depends on the session.state$ observable to update the time range, searchSessionManager.getNextSearchSessionId() must be called before the histogram is refetched in order for the time range to get updated. But changing the data view causes the fetch$ observable subscription to resubscribe in use_discover_histogram, which changes the execution order between it and the fetch$ subscription in use_saved_search (which used to call searchSessionManager.getNextSearchSessionId()), resulting in the time range being outdated. 🤯

I added a functional for this one now so hopefully we don't run into a similar issue in the future. Commit here: 27b8f47.

…to update properly on time range changes

kibana-ci · 2023-01-18T05:38:06Z

💚 Build Succeeded

Buildkite Build
Commit: 24add10

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`unifiedHistogram`	15	16	+1

Async chunks

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

id	before	after	diff
`discover`	395.9KB	396.8KB	+928.0B
`unifiedHistogram`	33.8KB	33.5KB	-309.0B
total			+619.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
`unifiedHistogram`	0	1	+1

Page load bundle

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

id	before	after	diff
`unifiedHistogram`	4.7KB	4.6KB	-56.0B

Unknown metric groups

API count

id	before	after	diff
`unifiedHistogram`	52	63	+11

ESLint disabled line counts

id	before	after	diff
`discover`	40	39	-1
`unifiedHistogram`	2	1	-1
total			-2

Total ESLint disabled count

id	before	after	diff
`discover`	41	40	-1
`unifiedHistogram`	2	1	-1
total			-2

History

💔 Build #100915 failed 27b8f47
💔 Build #100913 failed 19cc2975a3e28722dfef0a6846c9d099dd1e4920
💚 Build #100864 succeeded 9067931
💚 Build #100400 succeeded 70448e4
💚 Build #98853 succeeded bfcd21a

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

cc @davismcphee

jughosta

Thanks! LGTM 👍

…lastic#146352) ## Summary This PR includes a number of updates to Unified Histogram to prepare for sharing with solutions, as well as updating its usage in Discover: Unified Histogram: - Adds a `disableAutoFetching` prop, similar to Unified Field List, to disable automatic Unified Histogram refetching based on prop changes. - Accepts an `input$` observable prop that can be used to control manual refetches. - Removes `refetchId` used internally and replaces it with an observables based approach to simplify refetch logic. - Introduces a `use_stable_callback` utility hook to create callback functions with stable identities which simplifies `useCallback` logic — should be replaced with `useEvent` or whatever the React team comes up with to solve this specific issue when available: reactjs/rfcs#220. - Eliminates debouncing logic in Unified Histogram since it was hacky — manual refetching should be used instead if debouncing is needed. - Accepts `query`, `filters`, and `timeRange` props to remove dependencies on specific services. - Updates `use_request_params` to export `getTimeRange` and `updateTimeRange` functions for easier absolute time range handling. - Exposes some Lens embeddable props to allow further customizing Unified Histogram behaviour. Discover: - Exports a `fetch$` observable from `use_saved_search` to allow listening for when data fetches should be triggered. - Uses new manual refetching support in Unified Histogram to simplify refetching logic. - Passes `query`, `filters`, and `timeRange` props to Unified Histogram. ### Checklist - [ ] ~Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)~ - [ ] ~[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~ - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] ~Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/))~ - [ ] ~Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))~ - [ ] ~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ - [ ] ~This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))~ - [ ] ~This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)~ ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

davismcphee self-assigned this Nov 27, 2022

davismcphee force-pushed the unified-histogram-manual-fetch branch 3 times, most recently from 374df21 to 7e62e31 Compare December 12, 2022 01:00

kertal reviewed Dec 14, 2022

View reviewed changes

src/plugins/unified_histogram/public/layout/layout.tsx Outdated Show resolved Hide resolved

davismcphee force-pushed the unified-histogram-manual-fetch branch 2 times, most recently from 9755251 to ff9af0b Compare December 16, 2022 03:35

davismcphee force-pushed the unified-histogram-manual-fetch branch from 8eb9760 to 0057c9d Compare January 6, 2023 01:00

davismcphee and others added 17 commits January 9, 2023 11:51

[UnifiedHistogram] Change search params to be taken as props

eb7064c

[Unified Histogram] Add support for fetch$ and input$ observables

10e38a7

[Unified Histogram] Working on unified messaging system

78e894f

[Unified Histogram] Working on unified messaging system 2

b658892

[Unified Histogram] Added initial unified messaging

9b85a77

[Unified Histogram] Remove lastReloadRequestTime

030841c

[Unified Histogram] Add manual refresh support

ab4925a

Continue work implementing manual fetch

c4c5184

Cleanup use_discover_histogram hook

e7b658c

Remove unified histogram debounce, fix time range getting out of sync…

e850c60

…, and prevent multiple fetches

Remove unused params from use_request_params, and add support for pas…

39436c4

…sing trigger callbacks to Lens embeddable or disabling them

Fix broken unified histogram Jest tests

a2d94c2

Fix broken Discover Jest tests

eb97401

Remove poc messaging code

d03ef53

Skip refetching when Lens chart is shown

6072c71

Fix issue where request adapter was being cleared after total hits re…

9afe492

…quest was sent, resulting in it being unavailable in the inspector

[CI] Auto-commit changed files from 'node scripts/ts_project_linter -…

562a78e

…-fix'

davismcphee added 2 commits January 9, 2023 11:51

Update and add Jest tests

d347622

Fix broken type in discover_layout.test.tsx

bfcd21a

davismcphee force-pushed the unified-histogram-manual-fetch branch from 7cbc16c to bfcd21a Compare January 9, 2023 16:22

davismcphee added the Feature:UnifiedHistogram Issues related to the Unified Histogram plugin label Jan 9, 2023

davismcphee changed the title ~~[Discover] Unified Histogram solutions cleanup~~ [Unified Histogram] [Discover] Unified Histogram solutions cleanup Jan 9, 2023

davismcphee marked this pull request as ready for review January 9, 2023 19:19

davismcphee requested a review from a team as a code owner January 9, 2023 19:19

kertal self-requested a review January 13, 2023 14:04

kertal reviewed Jan 13, 2023

View reviewed changes

src/plugins/discover/public/application/main/hooks/use_saved_search.ts Show resolved Hide resolved

kertal reviewed Jan 13, 2023

View reviewed changes

kertal approved these changes Jan 13, 2023

View reviewed changes

Merge branch 'main' into unified-histogram-manual-fetch

70448e4

Merge branch 'main' into unified-histogram-manual-fetch

9067931

[Discover] Fix issue where switching data views causes histogram not …

27b8f47

…to update properly on time range changes

davismcphee force-pushed the unified-histogram-manual-fetch branch from 19cc297 to 27b8f47 Compare January 18, 2023 04:24

Fix broken types

24add10

jughosta approved these changes Jan 18, 2023

View reviewed changes

davismcphee merged commit 96d6b89 into elastic:main Jan 18, 2023

kibanamachine added the backport:skip This PR does not require backporting label Jan 18, 2023

davismcphee deleted the unified-histogram-manual-fetch branch January 18, 2023 13:56

Comments

Conversation

davismcphee commented Nov 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

Uh oh!

elasticmachine commented Jan 9, 2023

Uh oh!

Uh oh!

kertal Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

kertal Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

davismcphee Jan 16, 2023

Choose a reason for hiding this comment

Uh oh!

kertal Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

davismcphee Jan 16, 2023

Choose a reason for hiding this comment

Uh oh!

kertal left a comment

Choose a reason for hiding this comment

Uh oh!

kertal commented Jan 16, 2023

Uh oh!

jughosta commented Jan 16, 2023

Uh oh!

davismcphee commented Jan 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kibana-ci commented Jan 18, 2023

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

jughosta left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

davismcphee commented Nov 27, 2022 •

edited

Loading

davismcphee commented Jan 18, 2023 •

edited

Loading