[Discover] Cell actions extension #190754

davismcphee · 2024-08-20T02:43:04Z

Summary

This PR adds a new cell actions extension to Discover using the kbn-cell-actions framework which Unified Data Table already supports, allowing profiles to register additional cell actions within the data grid:

The extension point supports the following:

Cell actions can be registered at the root or data source level.
Supports an isCompatible method, allowing cell actions to be shown for all cells in a column or conditionally based on the column field, etc.
Cell actions have access to a context object including the current field, value, dataSource, dataView, query, filters, and timeRange.

Note that currently cell actions do not have access to the entire record, only the current cell value. We can support this as a followup if needed, but it will require an enhancement to kbn-cell-actions.

Testing

Add discover.experimental.enabledProfiles: ['example-root-profile', 'example-data-source-profile', 'example-document-profile'] to kibana.dev.yml and start Kibana.
Ingest the Discover context awareness example data using the following command: node scripts/es_archiver --kibana-url=http://elastic:changeme@localhost:5601 --es-url=http://elastic:changeme@localhost:9200 load test/functional/fixtures/es_archiver/discover/context_awareness.
Navigate to Discover and create a my-example-logs data view or target the index in an ES|QL query.
Confirm that the example cell actions appear in expanded cell popover menus and are functional.

Resolves #186576.

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
Flaky Test Runner was used on any tests changed
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

davismcphee · 2024-08-20T02:44:01Z

/ci

davismcphee · 2024-09-01T01:35:15Z

/ci

davismcphee · 2024-09-01T01:43:30Z

/ci

davismcphee · 2024-09-05T22:41:03Z

/ci

davismcphee · 2024-09-06T02:32:20Z

/ci

davismcphee

I think I may still have to investigate the page load bundle increase (we'll see what CI says), but otherwise this should be good to review now.

davismcphee · 2024-09-06T04:33:50Z

src/plugins/discover/public/embeddable/components/search_embeddable_grid_component.tsx

+  // Security Solution overrides our cell actions -- this is a temporary workaroud to keep
+  // things working as they do currently until we can migrate their actions to One Discover
+  const isInSecuritySolution =
+    useObservable(discoverServices.application.currentAppId$) === 'securitySolutionUI';


@elastic/security-threat-hunting-investigations I wanted to build this extension point on top of kbn-cell-actions since Unified Data Table already supports it, rather than introducing an alternative approach. Unfortunately this conflicts with the saved search embeddable cell action overrides currently active within the Security Solution UI.

So I needed a way to disable the cell actions extension point when it would conflict with the overrides and couldn't figure out another way other than this. I'm open to ideas for a cleaner approach, but my thinking is that this won't be needed eventually anyway since ideally we'll migrate the current Security actions to a context aware Discover profile instead.

elasticmachine · 2024-09-06T04:35:49Z

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

davismcphee · 2024-09-06T04:35:54Z

/ci

jughosta

Looks great!

The additional cell actions don't appear on Surrounding Documents page. Is it expected?

jughosta · 2024-09-09T12:55:41Z

src/plugins/discover/public/application/main/components/layout/discover_documents.tsx

@@ -264,6 +272,21 @@ function DiscoverDocumentsComponent({
    [documentState.esqlQueryColumns]
  );

+  const { filters } = useQuerySubscriber({ data: services.data });


Can we rather take filters via useAppStateSelector hook above as we do for query?

I'd prefer to do something like that, but unfortunately the app state filters don't include the pinned filters.

davismcphee

The additional cell actions don't appear on Surrounding Documents page. Is it expected?

Nope not expected, I just missed it, thanks! Updated to support surrounding docs here: 2d66307

davismcphee · 2024-09-10T01:37:02Z

src/plugins/discover/public/application/main/components/layout/discover_documents.tsx

@@ -264,6 +272,21 @@ function DiscoverDocumentsComponent({
    [documentState.esqlQueryColumns]
  );

+  const { filters } = useQuerySubscriber({ data: services.data });


I'd prefer to do something like that, but unfortunately the app state filters don't include the pinned filters.

jughosta

LGTM, thanks!

kibana-ci · 2024-09-10T23:44:23Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: fc50e51

Failed CI Steps

FTR Configs #45

Test Failures

[job] [logs] FTR Configs #45 / serverless observability UI Observability Logs Explorer DataSourceSelector with installed integrations and uncategorized data streams "after all" hook in "with installed integrations and uncategorized data streams"
[job] [logs] FTR Configs #45 / serverless observability UI Observability Logs Explorer DataSourceSelector with installed integrations and uncategorized data streams "before all" hook in "with installed integrations and uncategorized data streams"

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`discover`	973	988	+15

Async chunks

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

id	before	after	diff
`cloudSecurityPosture`	495.8KB	496.0KB	+185.0B
`discover`	797.2KB	807.9KB	+10.7KB
`esqlDataGrid`	152.6KB	152.8KB	+195.0B
`securitySolution`	19.7MB	19.7MB	+975.0B
`slo`	852.1KB	852.3KB	+183.0B
total			+12.2KB

Page load bundle

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

id	before	after	diff
`discover`	47.9KB	47.2KB	-744.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/unified-data-table`	184	185	+1

History

💔 Build #233228 failed cc68fec
💔 Build #232935 failed 2d66307
💛 Build #232927 was flaky 194a43b
💚 Build #232652 succeeded 3e6e750
💚 Build #232352 succeeded 00a5d44

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

cc @davismcphee

## Summary This PR adds a new cell actions extension to Discover using the [`kbn-cell-actions`](packages/kbn-cell-actions) framework which Unified Data Table already supports, allowing profiles to register additional cell actions within the data grid: <img width="2168" alt="cell_actions" src="https://github.com/user-attachments/assets/f01a97be-d90f-4284-9cbf-4a2e1a5dd78c"> The extension point supports the following: - Cell actions can be registered at the root or data source level. - Supports an `isCompatible` method, allowing cell actions to be shown for all cells in a column or conditionally based on the column field, etc. - Cell actions have access to a `context` object including the current `field`, `value`, `dataSource`, `dataView`, `query`, `filters`, and `timeRange`. **Note that currently cell actions do not have access to the entire record, only the current cell value. We can support this as a followup if needed, but it will require an enhancement to `kbn-cell-actions`.** ## Testing - Add `discover.experimental.enabledProfiles: ['example-root-profile', 'example-data-source-profile', 'example-document-profile']` to `kibana.dev.yml` and start Kibana. - Ingest the Discover context awareness example data using the following command: `node scripts/es_archiver --kibana-url=http://elastic:changeme@localhost:5601 --es-url=http://elastic:changeme@localhost:9200 load test/functional/fixtures/es_archiver/discover/context_awareness`. - Navigate to Discover and create a `my-example-logs` data view or target the index in an ES|QL query. - Confirm that the example cell actions appear in expanded cell popover menus and are functional. Resolves elastic#186576. ### 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 - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] 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)

davismcphee added Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph) Project:OneDiscover Enrich Discover with contextual awareness / Merge with Logs Explorer labels Aug 20, 2024

davismcphee self-assigned this Aug 20, 2024

davismcphee force-pushed the discover-cell-actions-extension branch from 68000ef to 82ecafc Compare August 20, 2024 22:27

davismcphee force-pushed the discover-cell-actions-extension branch from e901ed7 to ffebaab Compare September 1, 2024 01:43

davismcphee added 7 commits September 5, 2024 17:12

Initial cell actions extension implementation

6d929e7

Improve use_cell_actions hook

1cd3791

Support passing params to cell actions

ffd46ca

Rename use_cell_actions to use_additional_cell_actions

ddac792

Update ID generation

d5d8be5

Remove orig file

4eb4538

Add cell actions embeddable support and Jest tests

b16eccd

davismcphee force-pushed the discover-cell-actions-extension branch from ffebaab to b16eccd Compare September 5, 2024 20:12

Fix Jest tests

ea864ff

davismcphee added 3 commits September 5, 2024 19:57

Add createDataSource util

e4f03e4

Add workaround for security cell actions

6c4a524

Add Jest tests

dcffd95

davismcphee added 3 commits September 6, 2024 00:25

Add functional tests

90b11bf

Remove test cell action definitions

f41ba76

Move DISCOVER_CELL_ACTIONS_TRIGGER definition

00a5d44

davismcphee added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Sep 6, 2024

davismcphee commented Sep 6, 2024

View reviewed changes

davismcphee marked this pull request as ready for review September 6, 2024 04:35

davismcphee requested a review from a team as a code owner September 6, 2024 04:35

davismcphee added 3 commits September 9, 2024 01:34

Merge branch 'main' into discover-cell-actions-extension

bd6a959

Update Disover plugin imports to try to address bundle size

8558261

Fix file license headers

3e6e750

jughosta reviewed Sep 9, 2024

View reviewed changes

davismcphee added 2 commits September 9, 2024 20:48

Merge branch 'main' into discover-cell-actions-extension

194a43b

Add surrounding docs support for cell actions extension

2d66307

davismcphee commented Sep 10, 2024

View reviewed changes

jughosta approved these changes Sep 10, 2024

View reviewed changes

davismcphee added 2 commits September 10, 2024 16:23

Merge branch 'main' into discover-cell-actions-extension

cc68fec

Fix context tests

fc50e51

davismcphee merged commit 034625a into elastic:main Sep 11, 2024
46 of 48 checks passed

davismcphee deleted the discover-cell-actions-extension branch September 11, 2024 00:24

kibanamachine added the v8.16.0 label Sep 11, 2024

szaffarano mentioned this pull request Sep 13, 2024

[Telemetry][Security Solution] Fix integration tests on branch 9.0 #192842

Merged

1 task

davismcphee mentioned this pull request Sep 18, 2024

[APM][ECO] Service name and trace id links on Logs Explorer and Discover #192349

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Cell actions extension #190754

[Discover] Cell actions extension #190754

davismcphee commented Aug 20, 2024 •

edited

Loading

davismcphee commented Aug 20, 2024

davismcphee commented Sep 1, 2024

davismcphee commented Sep 1, 2024

davismcphee commented Sep 5, 2024

davismcphee commented Sep 6, 2024

davismcphee left a comment

davismcphee Sep 6, 2024

elasticmachine commented Sep 6, 2024

davismcphee commented Sep 6, 2024

jughosta left a comment

jughosta Sep 9, 2024

davismcphee Sep 10, 2024

davismcphee left a comment

davismcphee Sep 10, 2024

jughosta left a comment

kibana-ci commented Sep 10, 2024

API count

[Discover] Cell actions extension #190754

[Discover] Cell actions extension #190754

Conversation

davismcphee commented Aug 20, 2024 • edited Loading

Summary

Testing

Checklist

For maintainers

davismcphee commented Aug 20, 2024

davismcphee commented Sep 1, 2024

davismcphee commented Sep 1, 2024

davismcphee commented Sep 5, 2024

davismcphee commented Sep 6, 2024

davismcphee left a comment

Choose a reason for hiding this comment

davismcphee Sep 6, 2024

Choose a reason for hiding this comment

elasticmachine commented Sep 6, 2024

davismcphee commented Sep 6, 2024

jughosta left a comment

Choose a reason for hiding this comment

jughosta Sep 9, 2024

Choose a reason for hiding this comment

davismcphee Sep 10, 2024

Choose a reason for hiding this comment

davismcphee left a comment

Choose a reason for hiding this comment

davismcphee Sep 10, 2024

Choose a reason for hiding this comment

jughosta left a comment

Choose a reason for hiding this comment

kibana-ci commented Sep 10, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

Page load bundle

API count

History

davismcphee commented Aug 20, 2024 •

edited

Loading