[8.11] [Cloud Security] CloudSecurityDataTable component (#167587) (#…

…168056) # Backport This will backport the following commits from `main` to `8.11`: - [[Cloud Security] CloudSecurityDataTable component (#167587)](#167587)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Paulo Henrique <[email protected]>
elastic · Oct 5, 2023 · 9a5c2dd · 9a5c2dd
1 parent 6518d71
commit 9a5c2dd
Show file tree

Hide file tree

Showing 27 changed files with 911 additions and 745 deletions.
diff --git a/x-pack/plugins/cloud_security_posture/kibana.jsonc b/x-pack/plugins/cloud_security_posture/kibana.jsonc
@@ -11,6 +11,7 @@
     "requiredPlugins": [
       "navigation",
       "data",
+      "dataViews",
       "fleet",
       "unifiedSearch",
       "taskManager",
@@ -19,7 +20,8 @@
       "discover",
       "cloud",
       "licensing",
-      "share"
+      "share",
+      "kibanaUtils"
     ],
     "optionalPlugins": ["usageCollection"],
     "requiredBundles": ["kibanaReact", "usageCollection"]

diff --git a/x-pack/plugins/cloud_security_posture/public/common/api/use_filtered_data_view.ts b/x-pack/plugins/cloud_security_posture/public/common/api/use_filtered_data_view.ts
diff --git a/x-pack/plugins/cloud_security_posture/public/common/api/use_latest_findings_data_view.ts b/x-pack/plugins/cloud_security_posture/public/common/api/use_latest_findings_data_view.ts
@@ -8,8 +8,45 @@
 import { useQuery } from '@tanstack/react-query';
 import { useKibana } from '@kbn/kibana-react-plugin/public';
 import type { DataView } from '@kbn/data-plugin/common';
+import { i18n } from '@kbn/i18n';
+import { LATEST_FINDINGS_INDEX_PATTERN } from '../../../common/constants';
 import { CspClientPluginStartDeps } from '../../types';
 
+const cloudSecurityFieldLabels: Record<string, string> = {
+  'result.evaluation': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.resultColumnLabel',
+    { defaultMessage: 'Result' }
+  ),
+  'resource.id': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.resourceIdColumnLabel',
+    { defaultMessage: 'Resource ID' }
+  ),
+  'resource.name': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.resourceNameColumnLabel',
+    { defaultMessage: 'Resource Name' }
+  ),
+  'resource.sub_type': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.resourceTypeColumnLabel',
+    { defaultMessage: 'Resource Type' }
+  ),
+  'rule.benchmark.rule_number': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.ruleNumberColumnLabel',
+    { defaultMessage: 'Rule Number' }
+  ),
+  'rule.name': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.ruleNameColumnLabel',
+    { defaultMessage: 'Rule Name' }
+  ),
+  'rule.section': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.ruleSectionColumnLabel',
+    { defaultMessage: 'CIS Section' }
+  ),
+  '@timestamp': i18n.translate(
+    'xpack.csp.findings.findingsTable.findingsTableColumn.lastCheckedColumnLabel',
+    { defaultMessage: 'Last Checked' }
+  ),
+} as const;
+
 /**
  *  TODO: use perfected kibana data views
  */
@@ -19,11 +56,23 @@ export const useLatestFindingsDataView = (dataView: string) => {
   } = useKibana<CspClientPluginStartDeps>().services;
 
   const findDataView = async (): Promise<DataView> => {
-    const dataViewObj = (await dataViews.find(dataView))?.[0];
+    const [dataViewObj] = await dataViews.find(dataView);
     if (!dataViewObj) {
       throw new Error(`Data view not found [Name: {${dataView}}]`);
     }
 
+    if (dataView === LATEST_FINDINGS_INDEX_PATTERN) {
+      Object.entries(cloudSecurityFieldLabels).forEach(([field, label]) => {
+        if (
+          !dataViewObj.getFieldAttrs()[field]?.customLabel ||
+          dataViewObj.getFieldAttrs()[field]?.customLabel === field
+        ) {
+          dataViewObj.setFieldCustomLabel(field, label);
+        }
+      });
+      await dataViews.updateSavedObject(dataViewObj);
+    }
+
     return dataViewObj;
   };
 

diff --git a/x-pack/plugins/cloud_security_posture/public/common/constants.ts b/x-pack/plugins/cloud_security_posture/public/common/constants.ts
@@ -38,6 +38,8 @@ export const CSP_MOMENT_FORMAT = 'MMMM D, YYYY @ HH:mm:ss.SSS';
 export const MAX_FINDINGS_TO_LOAD = 500;
 export const DEFAULT_VISIBLE_ROWS_PER_PAGE = 25;
 
+export const LOCAL_STORAGE_DATA_TABLE_PAGE_SIZE_KEY = 'cloudPosture:dataTable:pageSize';
+export const LOCAL_STORAGE_DATA_TABLE_COLUMNS_KEY = 'cloudPosture:dataTable:columns';
 export const LOCAL_STORAGE_PAGE_SIZE_FINDINGS_KEY = 'cloudPosture:findings:pageSize';
 export const LOCAL_STORAGE_PAGE_SIZE_BENCHMARK_KEY = 'cloudPosture:benchmark:pageSize';
 export const LOCAL_STORAGE_PAGE_SIZE_RULES_KEY = 'cloudPosture:rules:pageSize';

diff --git a/...d_security_posture/public/common/hooks/use_cloud_posture_table/use_cloud_posture_table.ts b/...d_security_posture/public/common/hooks/use_cloud_posture_table/use_cloud_posture_table.ts
@@ -8,33 +8,36 @@ import { Dispatch, SetStateAction, useCallback } from 'react';
 import { type DataView } from '@kbn/data-views-plugin/common';
 import { BoolQuery } from '@kbn/es-query';
 import { CriteriaWithPagination } from '@elastic/eui';
+import { DataTableRecord } from '@kbn/discover-utils/types';
 import { useUrlQuery } from '../use_url_query';
 import { usePageSize } from '../use_page_size';
 import { getDefaultQuery, useBaseEsQuery, usePersistedQuery } from './utils';
-
-interface QuerySort {
-  direction: string;
-  id: string;
-}
+import { LOCAL_STORAGE_DATA_TABLE_COLUMNS_KEY } from '../../constants';
 
 export interface CloudPostureTableResult {
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
   setUrlQuery: (query: any) => void;
-  // TODO: remove any, this sorting is used for both EuiGrid and EuiTable which uses different types of sorts
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
   sort: any;
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
   filters: any[];
   query?: { bool: BoolQuery };
   queryError?: Error;
   pageIndex: number;
   // TODO: remove any, urlQuery is an object with query fields but we also add custom fields to it, need to assert usages
   urlQuery: any;
   setTableOptions: (options: CriteriaWithPagination<object>) => void;
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
   handleUpdateQuery: (query: any) => void;
   pageSize: number;
   setPageSize: Dispatch<SetStateAction<number | undefined>>;
   onChangeItemsPerPage: (newPageSize: number) => void;
   onChangePage: (newPageIndex: number) => void;
-  onSort: (sort: QuerySort[]) => void;
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
+  onSort: (sort: any) => void;
   onResetFilters: () => void;
+  columnsLocalStorageKey: string;
+  getRowsFromPages: (data: Array<{ page: DataTableRecord[] }> | undefined) => DataTableRecord[];
 }
 
 /*
@@ -44,10 +47,13 @@ export const useCloudPostureTable = ({
   defaultQuery = getDefaultQuery,
   dataView,
   paginationLocalStorageKey,
+  columnsLocalStorageKey,
 }: {
+  // TODO: Remove any when all finding tables are converted to CloudSecurityDataTable
   defaultQuery?: (params: any) => any;
   dataView: DataView;
   paginationLocalStorageKey: string;
+  columnsLocalStorageKey?: string;
 }): CloudPostureTableResult => {
   const getPersistedDefaultQuery = usePersistedQuery(defaultQuery);
   const { urlQuery, setUrlQuery } = useUrlQuery(getPersistedDefaultQuery);
@@ -120,6 +126,13 @@ export const useCloudPostureTable = ({
     [setUrlQuery]
   );
 
+  const getRowsFromPages = (data: Array<{ page: DataTableRecord[] }> | undefined) =>
+    data
+      ?.map(({ page }: { page: DataTableRecord[] }) => {
+        return page;
+      })
+      .flat() || [];
+
   return {
     setUrlQuery,
     sort: urlQuery.sort,
@@ -136,5 +149,7 @@ export const useCloudPostureTable = ({
     onChangePage,
     onSort,
     onResetFilters,
+    columnsLocalStorageKey: columnsLocalStorageKey || LOCAL_STORAGE_DATA_TABLE_COLUMNS_KEY,
+    getRowsFromPages,
   };
 };