[Reporting/Discover] include the document's entire set of fields (#92730

) (#92921)

* fix get_sharing_data to provide a list of fields if none are selected as columns in the saved search

* add logging for download CSV that fields must be selected as columns

* add more functional test coverage

* fix ts in test

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

src/plugins/discover/public/application/helpers/get_sharing_data.ts

@@ -19,7 +19,10 @@ const getSharingDataFields = async (
   timeFieldName: string,
   hideTimeColumn: boolean
 ) => {
-  if (selectedFields.length === 1 && selectedFields[0] === '_source') {
+  if (
+    selectedFields.length === 0 ||
+    (selectedFields.length === 1 && selectedFields[0] === '_source')
+  ) {
     const fieldCounts = await getFieldCounts();
     return {
       searchFields: undefined,

x-pack/plugins/reporting/server/export_types/csv_from_savedobject/execute_job.ts

@@ -35,13 +35,19 @@ export const runTaskFnFactory: RunTaskFnFactory<ImmediateExecuteFn> = function e
 
   return async function runTask(jobId, jobPayload, context, req) {
     const generateCsv = createGenerateCsv(logger);
-    const { panel, visType } = jobPayload;
+    const { panel } = jobPayload;
 
-    logger.debug(`Execute job generating [${visType}] csv`);
+    logger.debug(`Execute job generating saved search CSV`);
 
     const savedObjectsClient = context.core.savedObjects.client;
     const uiSettingsClient = await reporting.getUiSettingsServiceFactory(savedObjectsClient);
-    const job = await getGenerateCsvParams(jobPayload, panel, savedObjectsClient, uiSettingsClient);
+    const job = await getGenerateCsvParams(
+      jobPayload,
+      panel,
+      savedObjectsClient,
+      uiSettingsClient,
+      logger
+    );
 
     const elasticsearch = reporting.getElasticsearchService();
     const { callAsCurrentUser } = elasticsearch.legacy.client.asScoped(req);

x-pack/plugins/reporting/server/export_types/csv_from_savedobject/lib/get_csv_job.test.ts

@@ -5,9 +5,12 @@
  * 2.0.
  */
 
+import { createMockLevelLogger } from '../../../test_helpers';
 import { JobParamsPanelCsv, SearchPanel } from '../types';
 import { getGenerateCsvParams } from './get_csv_job';
 
+const logger = createMockLevelLogger();
+
 describe('Get CSV Job', () => {
   let mockJobParams: JobParamsPanelCsv;
   let mockSearchPanel: SearchPanel;
@@ -42,7 +45,8 @@ describe('Get CSV Job', () => {
       mockJobParams,
       mockSearchPanel,
       mockSavedObjectsClient,
-      mockUiSettingsClient
+      mockUiSettingsClient,
+      logger
     );
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -94,7 +98,8 @@ describe('Get CSV Job', () => {
       mockJobParams,
       mockSearchPanel,
       mockSavedObjectsClient,
-      mockUiSettingsClient
+      mockUiSettingsClient,
+      logger
     );
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -149,7 +154,8 @@ describe('Get CSV Job', () => {
       mockJobParams,
       mockSearchPanel,
       mockSavedObjectsClient,
-      mockUiSettingsClient
+      mockUiSettingsClient,
+      logger
     );
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -203,7 +209,8 @@ describe('Get CSV Job', () => {
       mockJobParams,
       mockSearchPanel,
       mockSavedObjectsClient,
-      mockUiSettingsClient
+      mockUiSettingsClient,
+      logger
     );
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -275,7 +282,8 @@ describe('Get CSV Job', () => {
       mockJobParams,
       mockSearchPanel,
       mockSavedObjectsClient,
-      mockUiSettingsClient
+      mockUiSettingsClient,
+      logger
     );
     expect(result).toMatchInlineSnapshot(`
       Object {

x-pack/plugins/reporting/server/export_types/csv_from_savedobject/lib/get_csv_job.ts

@@ -8,6 +8,7 @@
 import { IUiSettingsClient, SavedObjectsClientContract } from 'kibana/server';
 import { EsQueryConfig } from 'src/plugins/data/server';
 import { esQuery, Filter, Query } from '../../../../../../../src/plugins/data/server';
+import { LevelLogger } from '../../../lib';
 import { TimeRangeParams } from '../../common';
 import { GenerateCsvParams } from '../../csv/generate_csv';
 import {
@@ -44,7 +45,8 @@ export const getGenerateCsvParams = async (
   jobParams: JobParamsPanelCsv,
   panel: SearchPanel,
   savedObjectsClient: SavedObjectsClientContract,
-  uiConfig: IUiSettingsClient
+  uiConfig: IUiSettingsClient,
+  logger: LevelLogger
 ): Promise<GenerateCsvParams> => {
   let timerange: TimeRangeParams | null;
   if (jobParams.post?.timerange) {
@@ -75,6 +77,14 @@ export const getGenerateCsvParams = async (
     fields: indexPatternFields,
   } = indexPatternSavedObject;
 
+  if (!indexPatternFields || indexPatternFields.length === 0) {
+    logger.error(
+      new Error(
+        `No fields are selected in the saved search! Please select fields as columns in the saved search and try again.`
+      )
+    );
+  }
+
   let payloadQuery: QueryFilter | undefined;
   let payloadSort: any[] = [];
   let docValueFields: DocValueFields[] | undefined;

x-pack/test/functional/apps/discover/reporting.ts

@@ -13,7 +13,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
   const es = getService('es');
   const esArchiver = getService('esArchiver');
   const browser = getService('browser');
-  const PageObjects = getPageObjects(['reporting', 'common', 'discover']);
+  const PageObjects = getPageObjects(['reporting', 'common', 'discover', 'timePicker']);
   const filterBar = getService('filterBar');
 
   describe('Discover', () => {
@@ -31,7 +31,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       });
     });
 
-    describe('Generate CSV button', () => {
+    describe('Generate CSV: new search', () => {
       beforeEach(() => PageObjects.common.navigateToApp('discover'));
 
       it('is not available if new', async () => {
@@ -69,14 +69,83 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
         await PageObjects.reporting.setTimepickerInDataRange();
         await PageObjects.discover.saveSearch('my search - with data - expectReportCanBeCreated');
         await PageObjects.reporting.openCsvReportingPanel();
-        expect(await PageObjects.reporting.canReportBeCreated()).to.be(true);
+        await PageObjects.reporting.clickGenerateReportButton();
+
+        const url = await PageObjects.reporting.getReportURL(60000);
+        const res = await PageObjects.reporting.getResponse(url);
+
+        expect(res.status).to.equal(200);
+        expect(res.get('content-type')).to.equal('text/csv; charset=utf-8');
+        expectSnapshot(res.text).toMatch();
       });
 
       it('generates a report with no data', async () => {
         await PageObjects.reporting.setTimepickerInNoDataRange();
         await PageObjects.discover.saveSearch('my search - no data - expectReportCanBeCreated');
         await PageObjects.reporting.openCsvReportingPanel();
-        expect(await PageObjects.reporting.canReportBeCreated()).to.be(true);
+        await PageObjects.reporting.clickGenerateReportButton();
+
+        const url = await PageObjects.reporting.getReportURL(60000);
+        const res = await PageObjects.reporting.getResponse(url);
+
+        expect(res.status).to.equal(200);
+        expect(res.get('content-type')).to.equal('text/csv; charset=utf-8');
+        expectSnapshot(res.text).toMatchInline(`
+          "
+          "
+        `);
+      });
+    });
+
+    describe('Generate CSV: archived search', () => {
+      before(async () => {
+        await esArchiver.load('reporting/ecommerce');
+        await esArchiver.load('reporting/ecommerce_kibana');
+      });
+
+      after(async () => {
+        await esArchiver.unload('reporting/ecommerce');
+        await esArchiver.unload('reporting/ecommerce_kibana');
+      });
+
+      beforeEach(() => PageObjects.common.navigateToApp('discover'));
+
+      it('generates a report with data', async () => {
+        await PageObjects.discover.loadSavedSearch('Ecommerce Data');
+        const fromTime = 'Apr 27, 2019 @ 23:56:51.374';
+        const toTime = 'Aug 23, 2019 @ 16:18:51.821';
+        await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime);
+
+        await PageObjects.reporting.openCsvReportingPanel();
+        await PageObjects.reporting.clickGenerateReportButton();
+
+        const url = await PageObjects.reporting.getReportURL(60000);
+        const res = await PageObjects.reporting.getResponse(url);
+
+        expect(res.status).to.equal(200);
+        expect(res.get('content-type')).to.equal('text/csv; charset=utf-8');
+        expectSnapshot(res.text).toMatch();
+      });
+
+      it('generates a report with filtered data', async () => {
+        await PageObjects.discover.loadSavedSearch('Ecommerce Data');
+        const fromTime = 'Apr 27, 2019 @ 23:56:51.374';
+        const toTime = 'Aug 23, 2019 @ 16:18:51.821';
+        await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime);
+
+        // filter and re-save
+        await filterBar.addFilter('currency', 'is', 'EUR');
+        await PageObjects.discover.saveSearch(`Ecommerce Data: EUR Filtered`);
+
+        await PageObjects.reporting.openCsvReportingPanel();
+        await PageObjects.reporting.clickGenerateReportButton();
+
+        const url = await PageObjects.reporting.getReportURL(60000);
+        const res = await PageObjects.reporting.getResponse(url);
+
+        expect(res.status).to.equal(200);
+        expect(res.get('content-type')).to.equal('text/csv; charset=utf-8');
+        expectSnapshot(res.text).toMatch();
       });
     });
   });

x-pack/test/functional/page_objects/reporting_page.ts

@@ -140,8 +140,8 @@ export function ReportingPageProvider({ getService, getPageObjects }: FtrProvide
 
     async setTimepickerInDataRange() {
       log.debug('Reporting:setTimepickerInDataRange');
-      const fromTime = 'Sep 19, 2015 @ 06:31:44.000';
-      const toTime = 'Sep 19, 2015 @ 18:01:44.000';
+      const fromTime = 'Apr 27, 2019 @ 23:56:51.374';
+      const toTime = 'Aug 23, 2019 @ 16:18:51.821';
       await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime);
     }