[Embeddable Rebuild] [Controls] Refactor control editing + creation #187606
There are no files selected for viewing
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
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
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,236 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
| import { BehaviorSubject } from 'rxjs'; | ||
|
|
||
| import { createStubDataView } from '@kbn/data-views-plugin/common/data_view.stub'; | ||
| import { stubFieldSpecMap } from '@kbn/data-views-plugin/common/field.stub'; | ||
| import { dataViewPluginMocks } from '@kbn/data-views-plugin/public/mocks'; | ||
| import { TimeRange } from '@kbn/es-query'; | ||
| import { I18nProvider } from '@kbn/i18n-react'; | ||
| import { act, fireEvent, render, RenderResult, waitFor } from '@testing-library/react'; | ||
|
|
||
| import { registerControlFactory } from '../control_factory_registry'; | ||
| import { ControlGroupApi } from '../control_group/types'; | ||
| import { DataControlEditor } from './data_control_editor'; | ||
| import { | ||
| getMockedOptionsListControlFactory, | ||
| getMockedRangeSliderControlFactory, | ||
| getMockedSearchControlFactory, | ||
| } from './mocks/data_control_mocks'; | ||
| import { DEFAULT_CONTROL_GROW, DEFAULT_CONTROL_WIDTH } from '@kbn/controls-plugin/common'; | ||
| import { DataControlEditorState } from './open_data_control_editor'; | ||
|
|
||
| const mockDataViews = dataViewPluginMocks.createStartContract(); | ||
| const mockDataView = createStubDataView({ | ||
| spec: { | ||
| id: 'logstash-*', | ||
| fields: { | ||
| ...stubFieldSpecMap, | ||
| 'machine.os.raw': { | ||
| name: 'machine.os.raw', | ||
| customLabel: 'OS', | ||
| type: 'string', | ||
| esTypes: ['keyword'], | ||
| aggregatable: true, | ||
| searchable: true, | ||
| }, | ||
| }, | ||
| title: 'logstash-*', | ||
| timeFieldName: '@timestamp', | ||
| }, | ||
| }); | ||
| mockDataViews.get = jest.fn().mockResolvedValue(mockDataView); | ||
|
|
||
| const dashboardApi = { | ||
| timeRange$: new BehaviorSubject<TimeRange | undefined>(undefined), | ||
| lastUsedDataViewId$: new BehaviorSubject<string>(mockDataView.id!), | ||
| }; | ||
| const controlGroupApi = { | ||
| parentApi: dashboardApi, | ||
| grow: new BehaviorSubject(DEFAULT_CONTROL_GROW), | ||
| width: new BehaviorSubject(DEFAULT_CONTROL_WIDTH), | ||
| } as unknown as ControlGroupApi; | ||
|
|
||
| describe('Data control editor', () => { | ||
| const mountComponent = async ({ | ||
| initialState, | ||
| }: { | ||
| initialState?: Partial<DataControlEditorState>; | ||
| }) => { | ||
| mockDataViews.get = jest.fn().mockResolvedValue(mockDataView); | ||
|
|
||
| const controlEditor = render( | ||
| <I18nProvider> | ||
| <DataControlEditor | ||
| onCancel={() => {}} | ||
| onSave={() => {}} | ||
| parentApi={controlGroupApi} | ||
| initialState={{ | ||
| dataViewId: dashboardApi.lastUsedDataViewId$.getValue(), | ||
| ...initialState, | ||
| }} | ||
| services={{ dataViews: mockDataViews }} | ||
| /> | ||
| </I18nProvider> | ||
| ); | ||
|
|
||
| await waitFor(() => { | ||
| expect(mockDataViews.get).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| return controlEditor; | ||
| }; | ||
|
|
||
| const selectField = async (controlEditor: RenderResult, fieldName: string) => { | ||
| expect(controlEditor.queryByTestId(`field-picker-select-${fieldName}`)).toBeInTheDocument(); | ||
| await act(async () => { | ||
| fireEvent.click(controlEditor.getByTestId(`field-picker-select-${fieldName}`)); | ||
| }); | ||
| }; | ||
|
|
||
| const getPressedAttribute = (controlEditor: RenderResult, testId: string) => { | ||
| return controlEditor.getByTestId(testId).getAttribute('aria-pressed'); | ||
| }; | ||
|
|
||
| beforeAll(() => { | ||
| /** Register all of my mocked data controls */ | ||
| registerControlFactory('search', async () => { | ||
Heenawter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return getMockedSearchControlFactory({ parentApi: controlGroupApi }); | ||
| }); | ||
| registerControlFactory('optionsList', async () => { | ||
| return getMockedOptionsListControlFactory({ parentApi: controlGroupApi }); | ||
| }); | ||
| registerControlFactory('rangeSlider', async () => { | ||
| return getMockedRangeSliderControlFactory({ parentApi: controlGroupApi }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('creating a new control', () => { | ||
| test('field list does not include fields that are not compatible with any control types', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
| const nonAggOption = controlEditor.queryByTestId('field-picker-select-machine.os'); | ||
| expect(nonAggOption).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('cannot save before selecting a field', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
|
|
||
| const saveButton = controlEditor.getByTestId('control-editor-save'); | ||
| expect(saveButton).toBeDisabled(); | ||
| await selectField(controlEditor, 'machine.os.raw'); | ||
| expect(saveButton).toBeEnabled(); | ||
| }); | ||
|
|
||
| test('selecting a keyword field - can only create an options list control', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
| await selectField(controlEditor, 'machine.os.raw'); | ||
|
|
||
| expect(controlEditor.getByTestId('create__optionsList')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__rangeSlider')).not.toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__search')).not.toBeEnabled(); | ||
| }); | ||
|
|
||
| test('selecting an IP field - can only create an options list control', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
| await selectField(controlEditor, 'clientip'); | ||
|
|
||
| expect(controlEditor.getByTestId('create__optionsList')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__rangeSlider')).not.toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__search')).not.toBeEnabled(); | ||
| }); | ||
|
|
||
| describe('selecting a number field', () => { | ||
| let controlEditor: RenderResult; | ||
|
|
||
| beforeEach(async () => { | ||
| controlEditor = await mountComponent({}); | ||
| await selectField(controlEditor, 'bytes'); | ||
| }); | ||
|
|
||
| test('can create an options list or range slider control', () => { | ||
| expect(controlEditor.getByTestId('create__optionsList')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__rangeSlider')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__search')).not.toBeEnabled(); | ||
| }); | ||
|
|
||
| test('defaults to options list creation', () => { | ||
| expect(getPressedAttribute(controlEditor, 'create__optionsList')).toBe('true'); | ||
| expect(getPressedAttribute(controlEditor, 'create__rangeSlider')).toBe('false'); | ||
| }); | ||
| }); | ||
|
|
||
| test('renders custom settings when provided', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
| await selectField(controlEditor, 'machine.os.raw'); | ||
| expect(controlEditor.queryByTestId('optionsListCustomSettings')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| test('selects the default width and grow', async () => { | ||
| const controlEditor = await mountComponent({}); | ||
|
|
||
| expect(getPressedAttribute(controlEditor, 'control-editor-width-small')).toBe('false'); | ||
| expect(getPressedAttribute(controlEditor, 'control-editor-width-medium')).toBe('true'); | ||
| expect(getPressedAttribute(controlEditor, 'control-editor-width-large')).toBe('false'); | ||
| expect( | ||
| controlEditor.getByTestId('control-editor-grow-switch').getAttribute('aria-checked') | ||
| ).toBe(`${DEFAULT_CONTROL_GROW}`); | ||
| }); | ||
|
|
||
| describe('editing existing control', () => { | ||
| describe('control title', () => { | ||
| test('auto-fills input with the default title', async () => { | ||
| const controlEditor = await mountComponent({ | ||
| initialState: { | ||
| controlType: 'optionsList', | ||
| controlId: 'testId', | ||
| fieldName: 'machine.os.raw', | ||
| defaultPanelTitle: 'OS', | ||
| }, | ||
| }); | ||
| const titleInput = await controlEditor.findByTestId('control-editor-title-input'); | ||
| expect(titleInput.getAttribute('value')).toBe('OS'); | ||
| expect(titleInput.getAttribute('placeholder')).toBe('OS'); | ||
| }); | ||
|
|
||
| test('auto-fills input with the custom title', async () => { | ||
| const controlEditor = await mountComponent({ | ||
| initialState: { | ||
| controlType: 'optionsList', | ||
| controlId: 'testId', | ||
| fieldName: 'machine.os.raw', | ||
| title: 'Custom title', | ||
| }, | ||
| }); | ||
| const titleInput = await controlEditor.findByTestId('control-editor-title-input'); | ||
| expect(titleInput.getAttribute('value')).toBe('Custom title'); | ||
| expect(titleInput.getAttribute('placeholder')).toBe('machine.os.raw'); | ||
| }); | ||
| }); | ||
|
|
||
| test('selects the provided control type', async () => { | ||
| const controlEditor = await mountComponent({ | ||
| initialState: { | ||
| controlType: 'rangeSlider', | ||
| controlId: 'testId', | ||
| fieldName: 'bytes', | ||
| }, | ||
| }); | ||
|
|
||
| expect(controlEditor.getByTestId('create__optionsList')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__rangeSlider')).toBeEnabled(); | ||
| expect(controlEditor.getByTestId('create__search')).not.toBeEnabled(); | ||
|
|
||
| expect(getPressedAttribute(controlEditor, 'create__optionsList')).toBe('false'); | ||
| expect(getPressedAttribute(controlEditor, 'create__rangeSlider')).toBe('true'); | ||
| expect(getPressedAttribute(controlEditor, 'create__search')).toBe('false'); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fixes a style error where the truncation was happening before the
max-widthapplied, so labels were getting cut off too early on the "small" control size. I also verified that the truncation now happens at the same point that it does for the old controls, so there should be no visual changes from the user's perspective once the React controls are officially swapped in Dashboard.