fix 'Download CSV' returns no data when panel has custom time range o…

…utside timerange of global time picker (elastic#163887) Closes elastic#163614 PR resolves issue by only adding global time filter to CSV export body when saved search embeddable does not have time range. --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 53e803e)
kibanamachine · Aug 17, 2023 · 9b33694 · 9b33694
1 parent 8981eb9
commit 9b33694
Show file tree

Hide file tree

Showing 10 changed files with 249 additions and 35 deletions.
diff --git a/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx b/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx
@@ -644,4 +644,8 @@ export class SavedSearchEmbeddable
 
     if (this.abortController) this.abortController.abort();
   }
+
+  public hasTimeRange() {
+    return this.getTimeRange() !== undefined;
+  }
 }
diff --git a/src/plugins/discover/public/embeddable/types.ts b/src/plugins/discover/public/embeddable/types.ts
@@ -37,6 +37,7 @@ export interface SearchOutput extends EmbeddableOutput {
 
 export interface ISearchEmbeddable extends IEmbeddable<SearchInput, SearchOutput> {
   getSavedSearch(): SavedSearch;
+  hasTimeRange(): boolean;
 }
 
 export interface SearchEmbeddable extends Embeddable<SearchInput, SearchOutput> {

diff --git a/src/plugins/discover/public/utils/get_sharing_data.test.ts b/src/plugins/discover/public/utils/get_sharing_data.test.ts
@@ -76,7 +76,7 @@ describe('getSharingData', () => {
     index.timeFieldName = 'cool-timefield';
     const searchSourceMock = createSearchSourceMock({ index });
     const { getSearchSource } = await getSharingData(searchSourceMock, {}, services);
-    expect(getSearchSource()).toMatchInlineSnapshot(`
+    expect(getSearchSource({})).toMatchInlineSnapshot(`
       Object {
         "fields": Array [
           Object {
@@ -121,7 +121,7 @@ describe('getSharingData', () => {
       },
       services
     );
-    expect(getSearchSource()).toMatchInlineSnapshot(`
+    expect(getSearchSource({})).toMatchInlineSnapshot(`
       Object {
         "index": "the-data-view-id",
         "sort": Array [
@@ -151,7 +151,7 @@ describe('getSharingData', () => {
       },
       services
     );
-    expect(getSearchSource().fields).toStrictEqual([
+    expect(getSearchSource({}).fields).toStrictEqual([
       { field: 'cool-timefield', include_unmapped: 'true' },
       { field: 'cool-field-1', include_unmapped: 'true' },
       { field: 'cool-field-2', include_unmapped: 'true' },

diff --git a/src/plugins/discover/public/utils/get_sharing_data.ts b/src/plugins/discover/public/utils/get_sharing_data.ts
@@ -69,28 +69,35 @@ export async function getSharingData(
   const absoluteTimeFilter = data.query.timefilter.timefilter.createFilter(index);
   const relativeTimeFilter = data.query.timefilter.timefilter.createRelativeFilter(index);
   return {
-    getSearchSource: (absoluteTime?: boolean): SerializedSearchSourceFields => {
+    getSearchSource: ({
+      addGlobalTimeFilter,
+      absoluteTime,
+    }: {
+      addGlobalTimeFilter?: boolean;
+      absoluteTime?: boolean;
+    }): SerializedSearchSourceFields => {
       const timeFilter = absoluteTime ? absoluteTimeFilter : relativeTimeFilter;
+      if (addGlobalTimeFilter && timeFilter) {
+        // remove timeFilter from existing filter
+        if (Array.isArray(existingFilter)) {
+          existingFilter = existingFilter.filter(
+            (current) => !isEqualFilters(current, absoluteTimeFilter)
+          );
+        } else if (isEqualFilters(existingFilter, absoluteTimeFilter)) {
+          existingFilter = undefined;
+        }
 
-      // remove timeFilter from existing filter
-      if (Array.isArray(existingFilter)) {
-        existingFilter = existingFilter.filter(
-          (current) => !isEqualFilters(current, absoluteTimeFilter)
-        );
-      } else if (isEqualFilters(existingFilter, absoluteTimeFilter)) {
-        existingFilter = undefined;
+        if (existingFilter) {
+          existingFilter = Array.isArray(existingFilter)
+            ? [timeFilter, ...existingFilter]
+            : ([timeFilter, existingFilter] as Filter[]);
+        } else {
+          existingFilter = timeFilter;
+        }
       }
 
-      if (existingFilter && timeFilter) {
-        searchSource.setField(
-          'filter',
-          Array.isArray(existingFilter)
-            ? [timeFilter, ...existingFilter]
-            : ([timeFilter, existingFilter] as Filter[])
-        );
-      } else {
-        const filter = timeFilter || existingFilter;
-        searchSource.setField('filter', filter);
+      if (existingFilter) {
+        searchSource.setField('filter', existingFilter);
       }
 
       /*

diff --git 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
@@ -92,6 +92,7 @@ describe('GetCsvReportPanelAction', () => {
             from: 'now-7d',
           },
         }),
+        hasTimeRange: () => true,
       },
     } as unknown as ActionContext;
   });

diff --git a/x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.tsx b/x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.tsx
@@ -68,7 +68,7 @@ export class ReportingCsvPanelAction implements ActionDefinition<ActionContext>
     });
   }
 
-  public async getSearchSource(savedSearch: SavedSearch, _embeddable: ISearchEmbeddable) {
+  public async getSharingData(savedSearch: SavedSearch) {
     const [{ uiSettings }, { data }] = await Rx.firstValueFrom(this.startServices$);
     const { getSharingData } = await loadSharingDataHelpers();
     return await getSharingData(savedSearch.searchSource, savedSearch, { uiSettings, data });
@@ -126,10 +126,13 @@ export class ReportingCsvPanelAction implements ActionDefinition<ActionContext>
     }
 
     const savedSearch = embeddable.getSavedSearch();
-    const { columns, getSearchSource } = await this.getSearchSource(savedSearch, embeddable);
+    const { columns, getSearchSource } = await this.getSharingData(savedSearch);
 
     const immediateJobParams = this.apiClient.getDecoratedJobParams({
-      searchSource: getSearchSource(true),
+      searchSource: getSearchSource({
+        addGlobalTimeFilter: !embeddable.hasTimeRange(),
+        absoluteTime: true,
+      }),
       columns,
       title: savedSearch.title || '',
       objectType: 'downloadCsv', // FIXME: added for typescript, but immediate download job does not need objectType

diff --git a/x-pack/plugins/reporting/public/share_context_menu/register_csv_reporting.tsx b/x-pack/plugins/reporting/public/share_context_menu/register_csv_reporting.tsx
@@ -28,9 +28,13 @@ export const reportingCsvShareProvider = ({
       return [];
     }
 
-    const getSearchSource = sharingData.getSearchSource as (
-      absoluteTime?: boolean
-    ) => SearchSourceFields;
+    const getSearchSource = sharingData.getSearchSource as ({
+      addGlobalTimeFilter,
+      absoluteTime,
+    }: {
+      addGlobalTimeFilter?: boolean;
+      absoluteTime?: boolean;
+    }) => SearchSourceFields;
 
     const jobParams = {
       title: sharingData.title as string,
@@ -39,10 +43,12 @@ export const reportingCsvShareProvider = ({
     };
 
     const getJobParams = (forShareUrl?: boolean) => {
-      const absoluteTime = !forShareUrl;
       return {
         ...jobParams,
-        searchSource: getSearchSource(absoluteTime),
+        searchSource: getSearchSource({
+          addGlobalTimeFilter: true,
+          absoluteTime: !forShareUrl,
+        }),
       };
     };
-Original file line number
+Diff line change
@@ Expand Up / @@ -92,6 +92,7 @@ describe('GetCsvReportPanelAction', () => { @@
                 from: 'now-7d',
               },
             }),
+            hasTimeRange: () => true,
           },
         } as unknown as ActionContext;
       });
@@ Expand Down @@