[8.11] [Discover/CSV Reporting] Fix support for nested field columns in CSV reports (#172240) (#172335)

# Backport This will backport the following commits from `main` to `8.11`: - [[Discover/CSV Reporting] Fix support for nested field columns in CSV reports (#172240)](https://github.com/elastic/kibana/pull/172240)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
2025-04-24 09:48:58 -04:00 · 2023-12-01 11:56:34 -04:00 · 2023-12-01 11:56:34 -04:00 · 11eb765f54
commit 11eb765f54
parent fb019230f0
4 changed files with 48 additions and 3 deletions
--- a/src/plugins/discover/public/utils/get_sharing_data.test.ts
+++ b/src/plugins/discover/public/utils/get_sharing_data.test.ts
@ -16,7 +16,7 @@ import {
  SORT_DEFAULT_ORDER_SETTING,
  SEARCH_FIELDS_FROM_SOURCE,
 } from '@kbn/discover-utils';
-import { dataViewMock } from '@kbn/discover-utils/src/__mocks__';
+import { buildDataViewMock, dataViewMock } from '@kbn/discover-utils/src/__mocks__';
 import { getSharingData, showPublicUrlSwitch } from './get_sharing_data';

 describe('getSharingData', () => {
@ -162,6 +162,38 @@ describe('getSharingData', () => {
    ]);
  });

+  test('getSearchSource supports nested fields', async () => {
+    const index = buildDataViewMock({
+      name: 'the-data-view',
+      timeFieldName: 'cool-timefield',
+      fields: [
+        ...dataViewMock.fields,
+        {
+          name: 'cool-field-2.field',
+          type: 'keyword',
+          subType: {
+            nested: {
+              path: 'cool-field-2.field.path',
+            },
+          },
+        },
+      ] as DataView['fields'],
+    });
+    const searchSourceMock = createSearchSourceMock({ index });
+    const { getSearchSource } = await getSharingData(
+      searchSourceMock,
+      {
+        columns: ['cool-field-1', 'cool-field-2'],
+      },
+      services
+    );
+    expect(getSearchSource({}).fields).toStrictEqual([
+      { field: 'cool-timefield', include_unmapped: 'true' },
+      { field: 'cool-field-1', include_unmapped: 'true' },
+      { field: 'cool-field-2.*', include_unmapped: 'true' },
+    ]);
+  });
+
  test('fields have prepended timeField', async () => {
    const index = { ...dataViewMock } as DataView;
    index.timeFieldName = 'cool-timefield';
--- a/src/plugins/discover/public/utils/get_sharing_data.ts
+++ b/src/plugins/discover/public/utils/get_sharing_data.ts
@ -17,6 +17,7 @@ import type { Filter } from '@kbn/es-query';
 import type { SavedSearch, SortOrder } from '@kbn/saved-search-plugin/public';
 import {
  DOC_HIDE_TIME_COLUMN_SETTING,
+  isNestedFieldParent,
  SEARCH_FIELDS_FROM_SOURCE,
  SORT_DEFAULT_ORDER_SETTING,
 } from '@kbn/discover-utils';
@ -113,7 +114,17 @@ export async function getSharingData(
      if (useFieldsApi) {
        searchSource.removeField('fieldsFromSource');
        const fields = columns.length
-          ? columns.map((field) => ({ field, include_unmapped: 'true' }))
+          ? columns.map((column) => {
+              let field = column;
+
+              // If this column is a nested field, add a wildcard to the field name in order to fetch
+              // all leaf fields for the report, since the fields API doesn't support nested field roots
+              if (isNestedFieldParent(column, index)) {
+                field = `${column}.*`;
+              }
+
+              return { field, include_unmapped: 'true' };
+            })
          : [{ field: '*', include_unmapped: 'true' }];

        searchSource.setField('fields', fields);
--- a/x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.test.ts
+++ b/x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.test.ts
@ -18,6 +18,7 @@ import { ReportingAPIClient } from '../lib/reporting_api_client';
 import type { ReportingPublicPluginStartDendencies } from '../plugin';
 import type { ActionContext } from './get_csv_panel_action';
 import { ReportingCsvPanelAction } from './get_csv_panel_action';
+import { dataViewMock } from '@kbn/discover-utils/src/__mocks__';

 const core = coreMock.createSetup();
 let apiClient: ReportingAPIClient;
@ -124,7 +125,7 @@ describe('GetCsvReportPanelAction', () => {
      createCopy: () => mockSearchSource,
      removeField: jest.fn(),
      setField: jest.fn(),
-      getField: jest.fn(),
+      getField: jest.fn((name) => (name === 'index' ? dataViewMock : undefined)),
      getSerializedFields: jest.fn().mockImplementation(() => ({ testData: 'testDataValue' })),
    } as unknown as SearchSource;
    context.embeddable.getSavedSearch = () => {
--- a/x-pack/plugins/reporting/tsconfig.json
+++ b/x-pack/plugins/reporting/tsconfig.json
@ -42,6 +42,7 @@
    "@kbn/core-http-router-server-internal",
    "@kbn/core-http-common",
    "@kbn/react-kibana-context-theme",
+    "@kbn/discover-utils",
  ],
  "exclude": [
    "target/**/*",