Extracted DiscoverGrid to a package named @kbn/unified-data-table as UnifiedDataTable component

[YulNaumenko]

Summary

Current PR includes the next set of changes:

1. Moved DiscoverGrid component to a package @kbn/unified-data-table and added @elastic/kibana-data-discovery as code owners.

2. Changed @kbn/unified-data-table package naming for data grid related components and methods to correspond UnifiedDataTable instead of Discover.

3. Moved hooks useColumns and useRowHeightsOptions to a package as its logic belongs to UnifiedDataTable.

4. Renamed DiscoverGridContext to UnifiedDataTableContext.

5. Extended UnifiedDataTable interface and functionality with the next customization options:

• renderDocumentView?: (displayedRows: DataTableRecord[],displayedColumns: string[]) => JSX.Element | undefined; - callback to render DocumentView when the document is expanded
• configRowHeight?: number; - optional value for providing configuration setting for UnifiedDataTable rows height
• showMultiFields?: boolean; - optional value for providing configuration setting for enabling to display the complex fields in the table. Default is true.
• maxDocFieldsDisplayed?: number; - optional value for providing configuration setting for maximum number of document fields to display in the table. Default is 50.
• externalControlColumns?: EuiDataGridControlColumn[]; - optional value for providing EuiDataGridControlColumn list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select.

• externalAdditionalControls?: React.ReactNode; - optional value for providing the additional controls available in the UnifiedDataTable toolbar to manage it's records or state. UnifiedDataTable includes Columns, Sorting and Bulk Actions.

• rowsPerPageOptions?: number[]; - optional list of number type values to set custom UnifiedDataTable paging options to display the records per page.
• renderCustomGridBody?: (args: EuiDataGridCustomBodyProps) => React.ReactNode; - An optional function called to completely customize and control the rendering of EuiDataGrid's body and cell placement.

• trailingControlColumns?: EuiDataGridControlColumn[]; - optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid.
• visibleCellActions?: number; - optional value for a custom number of the visible cell actions in the table

• externalCustomRenderers?: Record<string,(props: EuiDataGridCellValueElementProps) => React.ReactNode>; - an optional settings for a specified fields rendering like links. Applied only for the listed fields rendering:

• consumer - optional string value for the name of the UnifiedDataTable consumer component or application.

6. Extended UnifiedDataGrid services with the two additional:
   storage: Storage;
data: DataPublicPluginStart;
   replaced core: CoreStart; with theme: ThemeServiceStart;, because core is used only to get theme
7. Replaced DocumentView property with renderDocumentView?: (displayedRows: DataTableRecord[],displayedColumns: string[]) => JSX.Element | undefined; callback function, which allows not to use DiscoverGridFlyout definition for the documents rendering.

    /**
   * Document detail view component
   */
  DocumentView?: typeof DiscoverGridFlyout;

8. Removed the next properties from the data table interface, because it was used to render DiscoverGridFlyout:

   /**
   * Filters applied by saved search embeddable
   */
  filters?: Filter[];
  /**
   * Query applied by KQL bar or text based editor
   */
  query?: Query | AggregateQuery;
  /**
   * Saved search id used for links to single doc and surrounding docs in the flyout
   */
  savedSearchId?: string;

9. Added usage examples and interface description to README file.
10. Changed grid styles naming from .dscDiscoverGrid* to .udtDataTable*
11. Migrated discover plugin to use UnifiedDataTable instead of DiscoverGrid

Extra changes were needed to avoid the circular dependancies:

• moved DocViewFilterFn and FieldMapping from discover plugin to packages/kbn-discover-utils/src/types.ts
• added own export type SortOrder = [string, string]; to avoid deps for saved-search plugin

[lukasolson]

This is awesome! Thanks for taking this on. I tested a few different scenarios and everything seems to be functional. Just a couple of very minor notes below.

[lukasolson]

Hmm, I'm not exactly sure what this is supposed to do but it seems we're not setting tourStep anywhere, so I'm wondering if that was just missed somehow.

[YulNaumenko]

Great catch!

[YulNaumenko]

fixed in the commit 5a7067f

[lukasolson]

Just a note that we will either want to eventually extract these into some sort of wrapper for this component or add props for what necessitates these services (not for this PR).

[mitodrummer]

Is there a reason pageIndex is handled by internal state? I was surprised to see it not in the list of props. Is this a design decision wrt to browser history maybe?

[kertal]

It's just that there was no need to handle the pagination externally in Discover so far, which doesn't mean it could be useful for other use cases

[mitodrummer]

Cool, yea I'm looking to make use of this new table in Cloud security (Findings). Currently pageIndex is part of our url history, but I wonder what the standard across all of kibana is. I can't imagine deep linking to a particular page of results is all that useful, but the back/forward behavior wrt to switching pages could be something customers expect. cc @dimadavid if you had any thoughts around this, and if we have any established UX guidelines. cc @kfirpeled (is it important we keep pageIndex as part of the urlQuery?)

[davismcphee]

Awesome work on this! I wanted to hold off on my review until you got a chance to address the Unified Doc Viewer conflicts, but looks like those are all solved now. The code changes look great, and I tested pretty extensively locally and didn't encounter any changes in behaviour. Thanks for all the effort on this, it's a huge help. LGTM 👍

[davismcphee]

Thanks for adding this, it's super helpful!

[YulNaumenko]

@elasticmachine merge upstream

[kibana-ci]

💔 Build Failed

• Buildkite Build
• Commit: e38f5a6
• Interpreting CI Failures

Failed CI Steps

• Serverless Observability Tests
• Serverless Security Cypress Tests #5
• Serverless Security Cypress Tests #7
• Serverless Security Cypress Tests #15
• Serverless Security Cypress Tests #16
• Serverless Security Cypress Tests #16
• Serverless Security Explore Cypress Tests #2

Test Failures

• [job] [logs] Serverless Observability Tests / serverless common API scripted fields disabled "before all" hook for "scripted fields are ignored when disabled"

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
discover	598	631	+33

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
@kbn/unified-data-table	-	39	+39

Async chunks

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

id	before	after	diff
discover	504.6KB	550.3KB	+45.7KB

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
@kbn/unified-data-table	-	1	+1
@kbn/unified-doc-viewer	5	6	+1
total			+2

Page load bundle

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

id	before	after	diff
discover	29.6KB	29.7KB	+116.0B

Unknown metric groups

API count

id	before	after	diff
@kbn/unified-data-table	-	88	+88

async chunk count

id	before	after	diff
discover	17	18	+1

ESLint disabled line counts

id	before	after	diff
@kbn/unified-data-table	-	5	+5
discover	32	24	-8
total			-3

Total ESLint disabled count

id	before	after	diff
@kbn/unified-data-table	-	5	+5
discover	32	24	-8
total			-3

History

• 💔 Build #155881 failed 541c41d
• 💔 Build #155875 failed 5069afd
• 💔 Build #155865 failed 5f22bb5
• 💔 Build #155859 failed 0134512

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

cc @YulNaumenko