Skip to content

[Canvas] Fix column object shape in datatable created by CSV function #98561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cqliu1 merged 4 commits into from
May 17, 2021
Merged

[Canvas] Fix column object shape in datatable created by CSV function #98561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94a6295
Fixed column object shape in CSV function
cqliu1 Apr 27, 2021
c53ed43
Fixed csv tests
cqliu1 Apr 28, 2021
0bc7fec
Fixed id
cqliu1 Apr 28, 2021
ae797b1
Merge branch 'master' into fix/csv-function
kibanamachine May 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 30 additions & 24 deletions ...s_plugin_src/functions/common/csv.test.js → ...s_plugin_src/functions/common/csv.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@
* 2.0.
*/

// @ts-expect-error untyped lib
import { functionWrapper } from '../../../test_helpers/function_wrapper';
import { getFunctionErrors } from '../../../i18n';
import { csv } from './csv';
import { Datatable } from 'src/plugins/expressions';

const errors = getFunctionErrors().csv;

describe('csv', () => {
const fn = functionWrapper(csv);
const expected = {
const expected: Datatable = {
type: 'datatable',
columns: [
{ name: 'name', type: 'string' },
{ name: 'number', type: 'string' },
{ id: 'name', name: 'name', meta: { type: 'string' } },
{ id: 'number', name: 'number', meta: { type: 'string' } },
],
rows: [
{ name: 'one', number: '1' },
Expand Down Expand Up @@ -69,43 +71,47 @@ fourty two%SPLIT%42`,
});

it('should trim column names', () => {
expect(
fn(null, {
data: `foo," bar ", baz, " buz "
1,2,3,4`,
})
).toEqual({
const expectedResult: Datatable = {
type: 'datatable',
columns: [
{ name: 'foo', type: 'string' },
{ name: 'bar', type: 'string' },
{ name: 'baz', type: 'string' },
{ name: 'buz', type: 'string' },
{ id: 'foo', name: 'foo', meta: { type: 'string' } },
{ id: 'bar', name: 'bar', meta: { type: 'string' } },
{ id: 'baz', name: 'baz', meta: { type: 'string' } },
{ id: 'buz', name: 'buz', meta: { type: 'string' } },
],
rows: [{ foo: '1', bar: '2', baz: '3', buz: '4' }],
});
});
};

it('should handle odd spaces correctly', () => {
expect(
fn(null, {
data: `foo," bar ", baz, " buz "
1," best ",3, " ok"
" good", bad, better , " worst " `,
1,2,3,4`,
})
).toEqual({
).toEqual(expectedResult);
});

it('should handle odd spaces correctly', () => {
const expectedResult: Datatable = {
type: 'datatable',
columns: [
{ name: 'foo', type: 'string' },
{ name: 'bar', type: 'string' },
{ name: 'baz', type: 'string' },
{ name: 'buz', type: 'string' },
{ id: 'foo', name: 'foo', meta: { type: 'string' } },
{ id: 'bar', name: 'bar', meta: { type: 'string' } },
{ id: 'baz', name: 'baz', meta: { type: 'string' } },
{ id: 'buz', name: 'buz', meta: { type: 'string' } },
],
rows: [
{ foo: '1', bar: ' best ', baz: '3', buz: ' ok' },
{ foo: ' good', bar: ' bad', baz: ' better ', buz: ' worst ' },
],
});
};

expect(
fn(null, {
data: `foo," bar ", baz, " buz "
1," best ",3, " ok"
" good", bad, better , " worst " `,
})
).toEqual(expectedResult);
});

it('throws when given invalid csv', () => {
Expand Down
6 changes: 5 additions & 1 deletion x-pack/plugins/canvas/canvas_plugin_src/functions/common/csv.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,11 @@ export function csv(): ExpressionFunctionDefinition<'csv', null, Arguments, Data
if (i === 0) {
// first row, assume header values
row.forEach((colName: string) =>
acc.columns.push({ name: colName.trim(), type: 'string' })
acc.columns.push({
id: colName.trim(),
name: colName.trim(),
meta: { type: 'string' },
})
);
} else {
// any other row is a data row
Expand Down