forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Handle both JSON and XJSON in processor editor (elastic#200692)
Closes [elastic#175753](elastic#175753) ## Summary When a user creates a pipeline with a processor that has an JSON editor field [Foreach, Grok, Inference, Redact and Script], our editor convert the input to XJSON. This can be confused to the user, who see their input modified without understanding the reason. For that, this PR creates a new editor that handles both XJSON and JSON format and does not changes the content that the user introduced while editing. Once the pipeline is saved, it will always retrieve the parsed data. I've created a whole new editor instead of modifying `XJsonEditor` because the original one is still in use in the `Custom processor`. This is because I've created [a list](https://github.com/SoniaSanzV/kibana/blob/d7d5ecafa7dbae96fe52c2e37394520b6353bd92/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/utils.ts#L151-L157) of the processor fields that needs to be serialized in `convertProcessorInternalToProcessor`. Since we don't know the name of the custom processor, we can't apply this workflow. I'm not super happy with the idea of adding manually the names of the processors to a list. I would like to have something more agnostic but I haven't come up with a solution that allows me to do that without breaking other fields. So, any suggestions are super welcome! ### How to test Create one of the following processors: Foreach, Grok, Inference, Redact or Script. In the JSON field, add a JSON with both with and without escaped strings. While you are editing the processor before saving the pipeline, you should see the processor as you typed it. In the `Show Request` flyout, you should see the properly parsed JSON. The pipeline should save with the correct parsed values and, once saved, if you click update, you only will get parsed values. ### Demo https://github.com/user-attachments/assets/1f9681df-2fb4-4ed5-ac30-03f2937abfe9
- Loading branch information
1 parent
0340851
commit b406115
Showing
19 changed files
with
675 additions
and
63 deletions.
There are no files selected for viewing
117 changes: 117 additions & 0 deletions
117
...elines/public/application/components/pipeline_editor/__jest__/processors/foreach.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
import { act } from 'react-dom/test-utils'; | ||
import { setup, SetupResult, getProcessorValue, setupEnvironment } from './processor.helpers'; | ||
|
||
const FOREACH_TYPE = 'foreach'; | ||
|
||
describe('Processor: Foreach', () => { | ||
let onUpdate: jest.Mock; | ||
let testBed: SetupResult; | ||
const { httpSetup } = setupEnvironment(); | ||
|
||
beforeAll(() => { | ||
jest.useFakeTimers({ legacyFakeTimers: true }); | ||
// disable all react-beautiful-dnd development warnings | ||
(window as any)['__@hello-pangea/dnd-disable-dev-warnings'] = true; | ||
}); | ||
|
||
afterAll(() => { | ||
jest.useRealTimers(); | ||
// enable all react-beautiful-dnd development warnings | ||
(window as any)['__@hello-pangea/dnd-disable-dev-warnings'] = false; | ||
}); | ||
|
||
beforeEach(async () => { | ||
onUpdate = jest.fn(); | ||
|
||
await act(async () => { | ||
testBed = await setup(httpSetup, { | ||
value: { | ||
processors: [], | ||
}, | ||
onFlyoutOpen: jest.fn(), | ||
onUpdate, | ||
}); | ||
}); | ||
|
||
const { component, actions } = testBed; | ||
|
||
component.update(); | ||
|
||
// Open flyout to add new processor | ||
actions.addProcessor(); | ||
// Add type (the other fields are not visible until a type is selected) | ||
await actions.addProcessorType(FOREACH_TYPE); | ||
}); | ||
|
||
test('prevents form submission if required fields are not provided', async () => { | ||
const { | ||
actions: { saveNewProcessor }, | ||
form, | ||
} = testBed; | ||
|
||
// Click submit button with only the type defined | ||
await saveNewProcessor(); | ||
|
||
// Expect form error as "field" is a required parameter | ||
expect(form.getErrorsMessages()).toEqual(['A field value is required.']); | ||
}); | ||
|
||
test('saves with default parameter values', async () => { | ||
const { | ||
actions: { saveNewProcessor }, | ||
form, | ||
} = testBed; | ||
|
||
// Add "field" value | ||
form.setInputValue('fieldNameField.input', 'test_foreach_processor'); | ||
|
||
// Save the field | ||
await saveNewProcessor(); | ||
|
||
const processors = getProcessorValue(onUpdate, FOREACH_TYPE); | ||
|
||
expect(processors[0][FOREACH_TYPE]).toEqual({ | ||
field: 'test_foreach_processor', | ||
}); | ||
}); | ||
|
||
test('accepts processor definitions that contains escaped characters', async () => { | ||
const { | ||
actions: { saveNewProcessor }, | ||
form, | ||
find, | ||
component, | ||
} = testBed; | ||
|
||
// Add "field" value | ||
form.setInputValue('fieldNameField.input', 'test_foreach_processor'); | ||
|
||
await act(async () => { | ||
find('processorField').simulate('change', { | ||
jsonContent: '{"def_1":"""aaa"bbb""", "def_2":"aaa(bbb"}', | ||
}); | ||
|
||
// advance timers to allow the form to validate | ||
jest.advanceTimersByTime(0); | ||
}); | ||
component.update(); | ||
|
||
// Save the field | ||
await saveNewProcessor(); | ||
|
||
const processors = getProcessorValue(onUpdate, FOREACH_TYPE); | ||
|
||
expect(processors[0][FOREACH_TYPE]).toEqual({ | ||
field: 'test_foreach_processor', | ||
// eslint-disable-next-line prettier/prettier | ||
processor: { def_1: 'aaa\"bbb', def_2: 'aaa(bbb' }, | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
...ines/public/application/components/pipeline_editor/__jest__/processors/inference.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
import { act } from 'react-dom/test-utils'; | ||
import { setup, SetupResult, getProcessorValue, setupEnvironment } from './processor.helpers'; | ||
|
||
const INFERENCE_TYPE = 'inference'; | ||
|
||
describe('Processor: Script', () => { | ||
let onUpdate: jest.Mock; | ||
let testBed: SetupResult; | ||
const { httpSetup } = setupEnvironment(); | ||
|
||
beforeAll(() => { | ||
jest.useFakeTimers({ legacyFakeTimers: true }); | ||
// disable all react-beautiful-dnd development warnings | ||
(window as any)['__@hello-pangea/dnd-disable-dev-warnings'] = true; | ||
}); | ||
|
||
afterAll(() => { | ||
jest.useRealTimers(); | ||
// enable all react-beautiful-dnd development warnings | ||
(window as any)['__@hello-pangea/dnd-disable-dev-warnings'] = false; | ||
}); | ||
|
||
beforeEach(async () => { | ||
onUpdate = jest.fn(); | ||
|
||
await act(async () => { | ||
testBed = await setup(httpSetup, { | ||
value: { | ||
processors: [], | ||
}, | ||
onFlyoutOpen: jest.fn(), | ||
onUpdate, | ||
}); | ||
}); | ||
|
||
const { component, actions } = testBed; | ||
|
||
component.update(); | ||
|
||
// Open flyout to add new processor | ||
actions.addProcessor(); | ||
// Add type (the other fields are not visible until a type is selected) | ||
await actions.addProcessorType(INFERENCE_TYPE); | ||
}); | ||
|
||
test('prevents form submission if required fields are not provided', async () => { | ||
const { | ||
actions: { saveNewProcessor }, | ||
form, | ||
} = testBed; | ||
|
||
// Click submit button with only the type defined | ||
await saveNewProcessor(); | ||
|
||
// Expect form error as "field" is a required parameter | ||
expect(form.getErrorsMessages()).toEqual([ | ||
'A deployment, an inference, or a model ID value is required.', | ||
]); | ||
}); | ||
|
||
test('accepts inference config and field maps that contains escaped characters', async () => { | ||
const { | ||
actions: { saveNewProcessor }, | ||
find, | ||
form, | ||
component, | ||
} = testBed; | ||
|
||
form.setInputValue('inferenceModelId.input', 'test_inference_processor'); | ||
|
||
await act(async () => { | ||
find('inferenceConfig').simulate('change', { | ||
jsonContent: '{"inf_conf_1":"""aaa"bbb""", "inf_conf_2": "aaa(bbb"}', | ||
}); | ||
|
||
// advance timers to allow the form to validate | ||
jest.advanceTimersByTime(0); | ||
}); | ||
component.update(); | ||
|
||
await act(async () => { | ||
find('fieldMap').simulate('change', { | ||
jsonContent: '{"field_map_1":"""aaa"bbb""", "field_map_2": "aaa(bbb"}', | ||
}); | ||
|
||
// advance timers to allow the form to validate | ||
jest.advanceTimersByTime(0); | ||
}); | ||
component.update(); | ||
|
||
// Save the field | ||
await saveNewProcessor(); | ||
|
||
const processors = getProcessorValue(onUpdate, INFERENCE_TYPE); | ||
|
||
expect(processors[0][INFERENCE_TYPE]).toEqual({ | ||
model_id: 'test_inference_processor', | ||
// eslint-disable-next-line prettier/prettier | ||
inference_config: { inf_conf_1: 'aaa\"bbb', inf_conf_2: 'aaa(bbb' }, | ||
// eslint-disable-next-line prettier/prettier | ||
field_map: { field_map_1: 'aaa\"bbb', field_map_2: 'aaa(bbb' }, | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.