[Reporting] Convert CSV Export libs to Typescript

elastic · Jan 16, 2020 · 622861c · 622861c
1 parent ca91ec5
commit 622861c
Show file tree

Hide file tree

Showing 23 changed files with 201 additions and 140 deletions.
diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.ts b/x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.ts
@@ -9,9 +9,7 @@ import { ExecuteJobFactory, ESQueueWorkerExecuteFn, ServerFacade } from '../../.
 import { CSV_JOB_TYPE, PLUGIN_ID } from '../../../common/constants';
 import { cryptoFactory, LevelLogger } from '../../../server/lib';
 import { JobDocPayloadDiscoverCsv } from '../types';
-// @ts-ignore untyped module TODO
 import { createGenerateCsv } from './lib/generate_csv';
-// @ts-ignore untyped module TODO
 import { fieldFormatMapFactory } from './lib/field_format_map';
 
 export const executeJobFactory: ExecuteJobFactory<ESQueueWorkerExecuteFn<

diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/check_cells_for_formulas.test.ts b/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/check_cells_for_formulas.test.ts
@@ -3,6 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
+
 import { checkIfRowsHaveFormulas } from './check_cells_for_formulas';
 
 const formulaValues = ['=', '+', '-', '@'];

diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/escape_value.js b/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/escape_value.js
diff --git a/.../csv/server/lib/__tests__/escape_value.js → ...types/csv/server/lib/escape_value.test.ts b/.../csv/server/lib/__tests__/escape_value.js → ...types/csv/server/lib/escape_value.test.ts
@@ -5,11 +5,11 @@
  */
 
 import expect from '@kbn/expect';
-import { createEscapeValue } from '../escape_value';
+import { createEscapeValue } from './escape_value';
 
 describe('escapeValue', function() {
   describe('quoteValues is true', function() {
-    let escapeValue;
+    let escapeValue: (val: string) => string;
     beforeEach(function() {
       escapeValue = createEscapeValue(true);
     });
@@ -44,7 +44,7 @@ describe('escapeValue', function() {
   });
 
   describe('quoteValues is false', function() {
-    let escapeValue;
+    let escapeValue: (val: string) => string;
     beforeEach(function() {
       escapeValue = createEscapeValue(false);
     });

diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/escape_value.ts b/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/escape_value.ts
@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { RawValue } from './types';
+
+const nonAlphaNumRE = /[^a-zA-Z0-9]/;
+const allDoubleQuoteRE = /"/g;
+
+export function createEscapeValue(quoteValues: boolean): (val: RawValue) => string {
+  return function escapeValue(val: RawValue) {
+    if (val && typeof val === 'string') {
+      if (quoteValues && nonAlphaNumRE.test(val)) {
+        return `"${val.replace(allDoubleQuoteRE, '""')}"`;
+      }
+    }
+
+    return val == null ? '' : val.toString();
+  };
+}
diff --git a/.../server/lib/__tests__/field_format_map.js → ...s/csv/server/lib/field_format_map.test.ts b/.../server/lib/__tests__/field_format_map.js → ...s/csv/server/lib/field_format_map.test.ts
@@ -5,13 +5,13 @@
  */
 
 import expect from '@kbn/expect';
-
-import { FieldFormatsService } from '../../../../../../../../../src/legacy/ui/field_formats/mixin/field_formats_service';
+import { FieldFormatsService } from '../../../../../../../../src/legacy/ui/field_formats/mixin/field_formats_service';
 // Reporting uses an unconventional directory structure so the linter marks this as a violation
 // eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { BytesFormat, NumberFormat } from '../../../../../../../../../src/plugins/data/server';
+import { BytesFormat, NumberFormat } from '../../../../../../../../src/plugins/data/server';
+import { fieldFormatMapFactory } from './field_format_map';
 
-import { fieldFormatMapFactory } from '../field_format_map';
+type ConfigValue = { number: { id: string; params: {} } } | string;
 
 describe('field format map', function() {
   const indexPatternSavedObject = {
@@ -26,12 +26,12 @@ describe('field format map', function() {
       fieldFormatMap: '{"field1":{"id":"bytes","params":{"pattern":"0,0.[0]b"}}}',
     },
   };
-  const configMock = {};
+  const configMock: Record<string, ConfigValue> = {};
   configMock['format:defaultTypeMap'] = {
     number: { id: 'number', params: {} },
   };
   configMock['format:number:defaultPattern'] = '0,0.[000]';
-  const getConfig = key => configMock[key];
+  const getConfig = (key: string) => configMock[key];
   const testValue = '4000';
 
   const fieldFormats = new FieldFormatsService([BytesFormat, NumberFormat], getConfig);

diff --git a/..._types/csv/server/lib/field_format_map.js → ..._types/csv/server/lib/field_format_map.ts b/..._types/csv/server/lib/field_format_map.js → ..._types/csv/server/lib/field_format_map.ts
@@ -6,17 +6,35 @@
 
 import _ from 'lodash';
 
+interface IndexPatternSavedObject {
+  attributes: {
+    fieldFormatMap: string;
+  };
+  id: string;
+  type: string;
+  version: string;
+}
+
+interface FieldFormats {
+  getConfig: number;
+  getInstance: (config: any) => any;
+  getDefaultInstance: (key: string) => any;
+}
+
 /**
  *  Create a map of FieldFormat instances for index pattern fields
  *
  *  @param {Object} indexPatternSavedObject
  *  @param {FieldFormatsService} fieldFormats
  *  @return {Map} key: field name, value: FieldFormat instance
  */
-export function fieldFormatMapFactory(indexPatternSavedObject, fieldFormats) {
+export function fieldFormatMapFactory(
+  indexPatternSavedObject: IndexPatternSavedObject,
+  fieldFormats: FieldFormats
+) {
   const formatsMap = new Map();
 
-  //Add FieldFormat instances for fields with custom formatters
+  // Add FieldFormat instances for fields with custom formatters
   if (_.has(indexPatternSavedObject, 'attributes.fieldFormatMap')) {
     const fieldFormatMap = JSON.parse(indexPatternSavedObject.attributes.fieldFormatMap);
     Object.keys(fieldFormatMap).forEach(fieldName => {
@@ -28,9 +46,9 @@ export function fieldFormatMapFactory(indexPatternSavedObject, fieldFormats) {
     });
   }
 
-  //Add default FieldFormat instances for all other fields
+  // Add default FieldFormat instances for all other fields
   const indexFields = JSON.parse(_.get(indexPatternSavedObject, 'attributes.fields', '[]'));
-  indexFields.forEach(field => {
+  indexFields.forEach((field: any) => {
     if (!formatsMap.has(field.name)) {
       formatsMap.set(field.name, fieldFormats.getDefaultInstance(field.type));
     }

diff --git a/...s/csv/server/lib/__tests__/flatten_hit.js → ..._types/csv/server/lib/flatten_hit.test.ts b/...s/csv/server/lib/__tests__/flatten_hit.js → ..._types/csv/server/lib/flatten_hit.test.ts
@@ -5,12 +5,14 @@
  */
 
 import expect from '@kbn/expect';
-import { createFlattenHit } from '../flatten_hit';
+import { createFlattenHit } from './flatten_hit';
+
+type Hit = Record<string, any>;
 
 describe('flattenHit', function() {
-  let flattenHit;
-  let hit;
-  let metaFields;
+  let flattenHit: (hit: Hit) => Record<string, string>;
+  let hit: Hit;
+  let metaFields: string[];
 
   beforeEach(function() {
     const fields = [

diff --git a/...xport_types/csv/server/lib/flatten_hit.js → ...xport_types/csv/server/lib/flatten_hit.ts b/...xport_types/csv/server/lib/flatten_hit.js → ...xport_types/csv/server/lib/flatten_hit.ts
@@ -6,9 +6,17 @@
 
 import _ from 'lodash';
 
+type Hit = Record<string, any>;
+type FlattenHitFn = (hit: Hit) => Record<string, string>;
+type FlatHits = Record<string, string[]>;
+
 // TODO this logic should be re-used with Discover
-export function createFlattenHit(fields, metaFields, conflictedTypesFields) {
-  const flattenSource = (flat, obj, keyPrefix) => {
+export function createFlattenHit(
+  fields: string[],
+  metaFields: string[],
+  conflictedTypesFields: string[]
+): FlattenHitFn {
+  const flattenSource = (flat: FlatHits, obj: object, keyPrefix = '') => {
     keyPrefix = keyPrefix ? keyPrefix + '.' : '';
     _.forOwn(obj, (val, key) => {
       key = keyPrefix + key;
@@ -31,17 +39,19 @@ export function createFlattenHit(fields, metaFields, conflictedTypesFields) {
     });
   };
 
-  const flattenMetaFields = (flat, hit) => {
+  const flattenMetaFields = (flat: Hit, hit: Hit) => {
     _.each(metaFields, meta => {
       if (meta === '_source') return;
       flat[meta] = hit[meta];
     });
   };
 
-  const flattenFields = (flat, hitFields) => {
+  const flattenFields = (flat: FlatHits, hitFields: string[]) => {
     _.forOwn(hitFields, (val, key) => {
-      if (key[0] === '_' && !_.contains(metaFields, key)) return;
-      flat[key] = _.isArray(val) && val.length === 1 ? val[0] : val;
+      if (key) {
+        if (key[0] === '_' && !_.contains(metaFields, key)) return;
+        flat[key] = _.isArray(val) && val.length === 1 ? val[0] : val;
+      }
     });
   };
 

diff --git a/...server/lib/__tests__/format_csv_values.js → .../csv/server/lib/format_csv_values.test.ts b/...server/lib/__tests__/format_csv_values.js → .../csv/server/lib/format_csv_values.test.ts
@@ -5,12 +5,12 @@
  */
 
 import expect from '@kbn/expect';
-import { createFormatCsvValues } from '../format_csv_values';
+import { createFormatCsvValues } from './format_csv_values';
 
 describe('formatCsvValues', function() {
   const separator = ',';
   const fields = ['foo', 'bar'];
-  const mockEscapeValue = val => val;
+  const mockEscapeValue = (value: any, index: number, array: any[]) => value || 'null value';
   describe('with _source as one of the fields', function() {
     const formatsMap = new Map();
     const formatCsvValues = createFormatCsvValues(
@@ -62,7 +62,7 @@ describe('formatCsvValues', function() {
 
   describe('with field formats', function() {
     const mockFieldFormat = {
-      convert: val => String(val).toUpperCase(),
+      convert: (val: string) => String(val).toUpperCase(),
     };
     const formatsMap = new Map();
     formatsMap.set('bar', mockFieldFormat);

diff --git a/...types/csv/server/lib/format_csv_values.js → ...types/csv/server/lib/format_csv_values.ts b/...types/csv/server/lib/format_csv_values.js → ...types/csv/server/lib/format_csv_values.ts
@@ -5,9 +5,15 @@
  */
 
 import { isObject, isNull, isUndefined } from 'lodash';
+import { RawValue } from './types';
 
-export function createFormatCsvValues(escapeValue, separator, fields, formatsMap) {
-  return function formatCsvValues(values) {
+export function createFormatCsvValues(
+  escapeValue: (value: RawValue, index: number, array: RawValue[]) => string,
+  separator: string,
+  fields: string[],
+  formatsMap: any
+) {
+  return function formatCsvValues(values: Record<string, RawValue>) {
     return fields
       .map(field => {
         let value;
@@ -29,7 +35,7 @@ export function createFormatCsvValues(escapeValue, separator, fields, formatsMap
         return formattedValue;
       })
       .map(value => (isObject(value) ? JSON.stringify(value) : value))
-      .map(value => value.toString())
+      .map(value => (value ? value.toString() : value))
       .map(escapeValue)
       .join(separator);
   };

diff --git a/...port_types/csv/server/lib/generate_csv.js → ...port_types/csv/server/lib/generate_csv.ts b/...port_types/csv/server/lib/generate_csv.js → ...port_types/csv/server/lib/generate_csv.ts
@@ -4,14 +4,16 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { Logger } from '../../../../types';
+import { GenerateCsvParams, SavedSearchGeneratorResult } from '../../types';
 import { createFlattenHit } from './flatten_hit';
 import { createFormatCsvValues } from './format_csv_values';
 import { createEscapeValue } from './escape_value';
 import { createHitIterator } from './hit_iterator';
 import { MaxSizeStringBuilder } from './max_size_string_builder';
 import { checkIfRowsHaveFormulas } from './check_cells_for_formulas';
 
-export function createGenerateCsv(logger) {
+export function createGenerateCsv(logger: Logger) {
   const hitIterator = createHitIterator(logger);
 
   return async function generateCsv({
@@ -23,12 +25,13 @@ export function createGenerateCsv(logger) {
     callEndpoint,
     cancellationToken,
     settings,
-  }) {
+  }: GenerateCsvParams): Promise<SavedSearchGeneratorResult> {
     const escapeValue = createEscapeValue(settings.quoteValues);
     const builder = new MaxSizeStringBuilder(settings.maxSizeBytes);
     const header = `${fields.map(escapeValue).join(settings.separator)}\n`;
     if (!builder.tryAppend(header)) {
       return {
+        size: 0,
         content: '',
         maxSizeReached: true,
       };
@@ -49,6 +52,10 @@ export function createGenerateCsv(logger) {
       while (true) {
         const { done, value: hit } = await iterator.next();
 
+        if (!hit) {
+          break;
+        }
+
         if (done) {
           break;
         }

diff --git a/.../csv/server/lib/__tests__/hit_iterator.ts → ...types/csv/server/lib/hit_iterator.test.ts b/.../csv/server/lib/__tests__/hit_iterator.ts → ...types/csv/server/lib/hit_iterator.test.ts
@@ -6,9 +6,9 @@
 
 import expect from '@kbn/expect';
 import sinon from 'sinon';
-import { CancellationToken } from '../../../../../common/cancellation_token';
-import { Logger, ScrollConfig } from '../../../../../types';
-import { createHitIterator } from '../hit_iterator';
+import { CancellationToken } from '../../../../common/cancellation_token';
+import { Logger, ScrollConfig } from '../../../../types';
+import { createHitIterator } from './hit_iterator';
 
 const mockLogger = {
   error: new Function(),

diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/hit_iterator.ts b/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/hit_iterator.ts
@@ -3,8 +3,8 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { SearchParams, SearchResponse } from 'elasticsearch';
 
+import { SearchParams, SearchResponse } from 'elasticsearch';
 import { i18n } from '@kbn/i18n';
 import { CancellationToken, ScrollConfig, Logger } from '../../../../types';
 

diff --git a/.../lib/__tests__/max_size_string_builder.js → ...erver/lib/max_size_string_builder.test.ts b/.../lib/__tests__/max_size_string_builder.js → ...erver/lib/max_size_string_builder.test.ts
@@ -5,7 +5,7 @@
  */
 
 import expect from '@kbn/expect';
-import { MaxSizeStringBuilder } from '../max_size_string_builder';
+import { MaxSizeStringBuilder } from './max_size_string_builder';
 
 describe('MaxSizeStringBuilder', function() {
   describe('tryAppend', function() {

diff --git a/...csv/server/lib/max_size_string_builder.js → ...csv/server/lib/max_size_string_builder.ts b/...csv/server/lib/max_size_string_builder.js → ...csv/server/lib/max_size_string_builder.ts
@@ -5,13 +5,17 @@
  */
 
 export class MaxSizeStringBuilder {
-  constructor(maxSizeBytes) {
+  private _buffer: Buffer;
+  private _size: number;
+  private _maxSize: number;
+
+  constructor(maxSizeBytes: number) {
     this._buffer = Buffer.alloc(maxSizeBytes);
     this._size = 0;
     this._maxSize = maxSizeBytes;
   }
 
-  tryAppend(str) {
+  tryAppend(str: string) {
     const byteLength = Buffer.byteLength(str);
     if (this._size + byteLength <= this._maxSize) {
       this._buffer.write(str, this._size);

diff --git a/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/types.d.ts b/x-pack/legacy/plugins/reporting/export_types/csv/server/lib/types.d.ts
@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export type RawValue = string | object | null | undefined;