[Lens] CSV Export for Lens

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.csv_mime_type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [CSV\_MIME\_TYPE](./kibana-plugin-plugins-data-public.csv_mime_type.md)
+
+## CSV\_MIME\_TYPE variable
+
+<b>Signature:</b>
+
+```typescript
+CSV_MIME_TYPE = "text/plain;charset=utf-8"
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.exportascsvs.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [exportAsCSVs](./kibana-plugin-plugins-data-public.exportascsvs.md)
+
+## exportAsCSVs() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function exportAsCSVs(filename: string, datatables: Record<string, Datatable> | undefined, options: CSVOptions): Record<string, {
+    content: string;
+    type: string;
+}> | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filename | <code>string</code> | filename to use (either as is, or as prefix for multiple CSVs) for the files to download |
+|  datatables | <code>Record&lt;string, Datatable&gt; &#124; undefined</code> | data (as a dictionary of Datatable) to be translated into CSVs. It can contain multiple tables. |
+|  options | <code>CSVOptions</code> | set of options for the exporter |
+
+<b>Returns:</b>
+
+`Record<string, {
+    content: string;
+    type: string;
+}> | undefined`
+
+A dictionary of files to download: the key is the filename and the value the CSV string
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md

@@ -41,6 +41,7 @@
 
 |  Function | Description |
 |  --- | --- |
+|  [exportAsCSVs(filename, datatables, options)](./kibana-plugin-plugins-data-public.exportascsvs.md) |  |
 |  [getDefaultQuery(language)](./kibana-plugin-plugins-data-public.getdefaultquery.md) |  |
 |  [getEsPreference(uiSettings, sessionId)](./kibana-plugin-plugins-data-public.getespreference.md) |  |
 |  [getSearchParamsFromRequest(searchRequest, dependencies)](./kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md) |  |
@@ -104,6 +105,7 @@
 |  [castEsToKbnFieldTypeName](./kibana-plugin-plugins-data-public.castestokbnfieldtypename.md) | Get the KbnFieldType name for an esType string |
 |  [connectToQueryState](./kibana-plugin-plugins-data-public.connecttoquerystate.md) | Helper to setup two-way syncing of global data and a state container |
 |  [createSavedQueryService](./kibana-plugin-plugins-data-public.createsavedqueryservice.md) |  |
+|  [CSV\_MIME\_TYPE](./kibana-plugin-plugins-data-public.csv_mime_type.md) |  |
 |  [ES\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.es_search_strategy.md) |  |
 |  [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) |  |
 |  [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) |  |

src/plugins/data/public/exports/export_csv.test.ts

@@ -0,0 +1,117 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Datatable } from 'src/plugins/expressions';
+import { FieldFormat } from '../../common/field_formats';
+import { CSV_MIME_TYPE, exportAsCSVs } from './export_csv';
+
+function getDefaultOptions() {
+  const formatFactory = jest.fn();
+  formatFactory.mockReturnValue({ convert: (v: unknown) => `Formatted_${v}` } as FieldFormat);
+  return {
+    csvSeparator: ',',
+    quoteValues: true,
+    formatFactory,
+  };
+}
+
+function getDataTable({
+  multipleLayers,
+  multipleColumns,
+}: { multipleLayers?: boolean; multipleColumns?: boolean } = {}): Record<string, Datatable> {
+  const datatables: Record<string, Datatable> = {
+    layer1: {
+      type: 'datatable',
+      columns: [{ id: 'col1', name: 'columnOne', meta: { type: 'string' } }],
+      rows: [{ col1: 'value' }],
+    },
+  };
+  if (multipleColumns) {
+    datatables.layer1.columns.push({ id: 'col2', name: 'columnTwo', meta: { type: 'number' } });
+    datatables.layer1.rows[0].col2 = 5;
+  }
+  if (multipleLayers) {
+    datatables.layer2 = {
+      type: 'datatable',
+      columns: [{ id: 'col1', name: 'columnOne', meta: { type: 'string' } }],
+      rows: [{ col1: 'value' }],
+    };
+  }
+  return datatables;
+}
+
+describe('CSV exporter', () => {
+  test('should do nothing with no data', () => {
+    expect(exportAsCSVs('noData', undefined, getDefaultOptions())).toStrictEqual(undefined);
+  });
+
+  test('should not break with empty data', () => {
+    expect(exportAsCSVs('emptyFile', {}, getDefaultOptions())).toStrictEqual({});
+  });
+
+  test('should export formatted values by default', () => {
+    expect(exportAsCSVs('oneCSV', getDataTable(), getDefaultOptions())).toStrictEqual({
+      'oneCSV.csv': { content: 'columnOne\r\n"Formatted_value"\r\n', type: CSV_MIME_TYPE },
+    });
+  });
+
+  test('should not quote values when requested', () => {
+    return expect(
+      exportAsCSVs('oneCSV', getDataTable(), { ...getDefaultOptions(), quoteValues: false })
+    ).toStrictEqual({
+      'oneCSV.csv': { content: 'columnOne\r\nFormatted_value\r\n', type: CSV_MIME_TYPE },
+    });
+  });
+
+  test('should use raw values when requested', () => {
+    expect(
+      exportAsCSVs('oneCSV', getDataTable(), { ...getDefaultOptions(), raw: true })
+    ).toStrictEqual({
+      'oneCSV.csv': { content: 'columnOne\r\nvalue\r\n', type: CSV_MIME_TYPE },
+    });
+  });
+
+  test('should use separator for multiple columns', () => {
+    expect(
+      exportAsCSVs('oneCSV', getDataTable({ multipleColumns: true }), getDefaultOptions())
+    ).toStrictEqual({
+      'oneCSV.csv': {
+        content: 'columnOne,columnTwo\r\n"Formatted_value","Formatted_5"\r\n',
+        type: CSV_MIME_TYPE,
+      },
+    });
+  });
+
+  test('should support multiple layers', () => {
+    expect(
+      exportAsCSVs('twoCSVs', getDataTable({ multipleLayers: true }), getDefaultOptions())
+    ).toStrictEqual({
+      'twoCSVs-1.csv': { content: 'columnOne\r\n"Formatted_value"\r\n', type: CSV_MIME_TYPE },
+      'twoCSVs-2.csv': { content: 'columnOne\r\n"Formatted_value"\r\n', type: CSV_MIME_TYPE },
+    });
+  });
+
+  test('should escape values', () => {
+    const datatables = getDataTable();
+    datatables.layer1.rows[0].col1 = '"value"';
+    expect(exportAsCSVs('oneCSV', datatables, getDefaultOptions())).toStrictEqual({
+      'oneCSV.csv': { content: 'columnOne\r\n"Formatted_""value"""\r\n', type: CSV_MIME_TYPE },
+    });
+  });
+});

src/plugins/data/public/exports/export_csv.tsx

@@ -0,0 +1,119 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// Inspired by the inspector CSV exporter
+
+import { FormatFactory } from 'src/plugins/data/common/field_formats/utils';
+import { Datatable } from 'src/plugins/expressions';
+import { DownloadableContent } from 'src/plugins/share/public/';
+
+const LINE_FEED_CHARACTER = '\r\n';
+const nonAlphaNumRE = /[^a-zA-Z0-9]/;
+const allDoubleQuoteRE = /"/g;
+export const CSV_MIME_TYPE = 'text/plain;charset=utf-8';
+
+// TODO: enhance this later on
+function escape(val: object | string, quoteValues: boolean) {
+  if (val != null && typeof val === 'object') {
+    val = val.valueOf();
+  }
+
+  val = String(val);
+
+  if (quoteValues && nonAlphaNumRE.test(val)) {
+    val = `"${val.replace(allDoubleQuoteRE, '""')}"`;
+  }
+
+  return val;
+}
+
+interface CSVOptions {
+  csvSeparator: string;
+  quoteValues: boolean;
+  formatFactory: FormatFactory;
+  raw?: boolean;
+}
+
+function buildCSV(
+  { columns, rows }: Datatable,
+  { csvSeparator, quoteValues, formatFactory, raw }: Omit<CSVOptions, 'asString'>
+) {
+  // Build the header row by its names
+  const header = columns.map((col) => escape(col.name, quoteValues));
+
+  const formatters = columns.reduce<Record<string, ReturnType<FormatFactory>>>(
+    (memo, { id, meta }) => {
+      memo[id] = formatFactory(meta?.params);
+      return memo;
+    },
+    {}
+  );
+
+  // Convert the array of row objects to an array of row arrays
+  const csvRows = rows.map((row) => {
+    return columns.map((column) =>
+      escape(raw ? row[column.id] : formatters[column.id].convert(row[column.id]), quoteValues)
+    );
+  });
+
+  return (
+    [header, ...csvRows].map((row) => row.join(csvSeparator)).join(LINE_FEED_CHARACTER) +
+    LINE_FEED_CHARACTER
+  ); // Add \r\n after last line
+}
+
+/**
+ *
+ * @param filename - filename to use (either as is, or as prefix for multiple CSVs) for the files to download
+ * @param datatables - data (as a dictionary of Datatable) to be translated into CSVs. It can contain multiple tables.
+ * @param options - set of options for the exporter
+ *
+ * @returns A dictionary of files to download: the key is the filename and the value the CSV string
+ */
+export function exportAsCSVs(
+  filename: string,
+  datatables: Record<string, Datatable> | undefined,
+  options: CSVOptions
+) {
+  if (datatables == null) {
+    return;
+  }
+  // build a csv for datatable layer
+  const csvs = Object.keys(datatables)
+    .filter((layerId) => {
+      return (
+        datatables[layerId].columns.length &&
+        datatables[layerId].rows.length &&
+        datatables[layerId].rows.every((row) => Object.keys(row).length)
+      );
+    })
+    .reduce<Record<string, string>>((memo, layerId) => {
+      memo[layerId] = buildCSV(datatables[layerId], options);
+      return memo;
+    }, {});
+
+  const layerIds = Object.keys(csvs);
+
+  return layerIds.reduce<Record<string, Exclude<DownloadableContent, Blob>>>((memo, layerId, i) => {
+    const content = csvs[layerId];
+    const postFix = layerIds.length > 1 ? `-${i + 1}` : '';
+    memo[`${filename}${postFix}.csv`] = { content, type: CSV_MIME_TYPE };
+    return memo;
+  }, {});
+}

src/plugins/data/public/exports/index.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export * from './export_csv';

src/plugins/data/public/index.ts

@@ -212,6 +212,12 @@ export {
   FieldFormat,
 } from '../common';
 
+/**
+ * Exporters (CSV)
+ */
+
+export * from './exports';
+
 /*
  * Index patterns:
  */