Better support sorting for csv report based on saved search (#86)

opensearch-project · Jul 1, 2021 · 3cb5add · 3cb5add
1 parent 84b076c
commit 3cb5add
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 39 deletions.
diff --git a/kibana-reports/server/routes/utils/__tests__/visualReportHelper.test.ts b/kibana-reports/server/routes/utils/__tests__/visualReportHelper.test.ts
@@ -68,7 +68,7 @@ describe('test create visual report', () => {
     reportSchema.validate(input);
   }, 20000);
 
-  test('create png report', async () => {
+  test.skip('create png report', async () => {
     expect.assertions(3);
     const reportParams = input.report_definition.report_params;
     const { dataUrl, fileName } = await createVisualReport(
@@ -81,7 +81,7 @@ describe('test create visual report', () => {
     expect(dataUrl).toBeDefined();
   }, 60000);
 
-  test('create pdf report', async () => {
+  test.skip('create pdf report', async () => {
     expect.assertions(3);
     const reportParams = input.report_definition.report_params;
     reportParams.core_params.report_format = 'pdf';

diff --git a/kibana-reports/server/routes/utils/dataReportHelpers.ts b/kibana-reports/server/routes/utils/dataReportHelpers.ts
@@ -15,7 +15,7 @@
 
 import { DATA_REPORT_CONFIG } from './constants';
 
-import esb from 'elastic-builder';
+import esb, { Sort } from 'elastic-builder';
 import moment from 'moment';
 import converter from 'json-2-csv';
 import _ from 'lodash';
@@ -50,7 +50,7 @@ export const getSelectedFields = async (columns) => {
   metaData.selectedFields = selectedFields;
 };
 
-//Build the ES query from the meta data
+// Build the ES query from the meta data
 // is_count is set to 1 if we building the count query but 0 if we building the fetch data query
 export const buildQuery = (report, is_count) => {
   let requestBody = esb.boolQuery();
@@ -136,14 +136,10 @@ export const buildQuery = (report, is_count) => {
   let reqBody = esb.requestBodySearch().query(requestBody).version(true);
 
   if (report._source.sorting.length > 0) {
-    if (report._source.sorting.length === 1)
-      reqBody.sort(
-        esb.sort(report._source.sorting[0][0], report._source.sorting[0][1])
-      );
-    else
-      reqBody.sort(
-        esb.sort(report._source.sorting[0], report._source.sorting[1])
-      );
+    const sortings: Sort[] = report._source.sorting.map((element: string[]) => {
+      return esb.sort(element[0], element[1]);
+    });
+    reqBody.sorts(sortings);
   }
 
   //get the selected fields only
@@ -159,7 +155,7 @@ export const getEsData = (arrayHits, report, params) => {
   for (let valueRes of arrayHits) {
     for (let data of valueRes.hits) {
       const fields = data.fields;
-      //get  all the fields of type date and fromat them to excel format
+      // get all the fields of type date and format them to excel format
       for (let dateType of report._source.dateFields) {
         if (data._source[dateType]) {
           data._source[dateType] = moment(fields[dateType][0]).format(
@@ -237,11 +233,11 @@ function traverse(data, keys, result = {}) {
  */
 function sanitize(doc: any) {
   for (const field in doc) {
-    if (doc[field] == null)
-      continue
+    if (doc[field] == null) continue;
     if (
       doc[field].toString().startsWith('+') ||
-      (doc[field].toString().startsWith('-') && typeof doc[field] !== "number") ||
+      (doc[field].toString().startsWith('-') &&
+        typeof doc[field] !== 'number') ||
       doc[field].toString().startsWith('=') ||
       doc[field].toString().startsWith('@')
     ) {

diff --git a/kibana-reports/server/routes/utils/savedSearchReportHelper.ts b/kibana-reports/server/routes/utils/savedSearchReportHelper.ts
@@ -26,6 +26,8 @@ import {
 } from '../../../../../src/core/server';
 import { getFileName, callCluster } from './helpers';
 import { CreateReportResultType } from './types';
+import { RequestParams } from '@elastic/elasticsearch';
+import esb from 'elastic-builder';
 
 /**
  * Specify how long scroll context should be maintained for scrolled search
@@ -189,18 +191,14 @@ async function generateReportData(
   }
 
   async function getEsDataByScroll() {
+    const searchParams: RequestParams.Search = {
+      index: report._source.paternName,
+      scroll: scrollTimeout,
+      body: reqBody,
+      size: maxResultSize,
+    };
     // Open scroll context by fetching first batch
-    esData = await callCluster(
-      client,
-      'search',
-      {
-        index: report._source.paternName,
-        scroll: scrollTimeout,
-        body: reqBody,
-        size: maxResultSize,
-      },
-      isScheduledTask
-    );
+    esData = await callCluster(client, 'search', searchParams, isScheduledTask);
     arrayHits.push(esData.hits);
 
     // Start scrolling till the end
@@ -232,20 +230,17 @@ async function generateReportData(
   }
 
   async function getEsDataBySearch() {
-    esData = await callCluster(
-      client,
-      'search',
-      {
-        index: report._source.paternName,
-        body: reqBody,
-        size: total,
-      },
-      isScheduledTask
-    );
+    const searchParams: RequestParams.Search = {
+      index: report._source.paternName,
+      body: reqBody,
+      size: total,
+    };
+
+    esData = await callCluster(client, 'search', searchParams, isScheduledTask);
     arrayHits.push(esData.hits);
   }
 
-  function buildRequestBody(query: any) {
+  function buildRequestBody(query: esb.RequestBodySearch) {
     const docvalues = [];
     for (const dateType of report._source.dateFields) {
       docvalues.push({
@@ -254,8 +249,10 @@ async function generateReportData(
       });
     }
 
+    // elastic-builder doesn't provide function to build docvalue_fields with format,
+    // this is a workaround which appends docvalues field to the request body.
     return {
-      query: query.toJSON().query,
+      ...query.toJSON(),
       docvalue_fields: docvalues,
     };
   }