Replace EuiCodeEditor with CodeEditor in app-services code (#114316)

* code editor scripted fields * filter_editor * embeddable example * clean * update tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Oct 13, 2021 · 2afb43b · 2afb43b
1 parent 708f06f
commit 2afb43b
Show file tree

Hide file tree

Showing 12 changed files with 85 additions and 75 deletions.
diff --git a/examples/dashboard_embeddable_examples/kibana.json b/examples/dashboard_embeddable_examples/kibana.json
@@ -16,6 +16,5 @@
     "githubTeam": "kibana-presentation"
   },
   "description": "Example app that shows how to embed a dashboard in an application",
-  "optionalPlugins": [],
-  "requiredBundles": ["esUiShared"]
+  "optionalPlugins": []
 }
diff --git a/examples/dashboard_embeddable_examples/public/app.tsx b/examples/dashboard_embeddable_examples/public/app.tsx
@@ -18,9 +18,10 @@ import {
   EuiSideNav,
 } from '@elastic/eui';
 import 'brace/mode/json';
-import { AppMountParameters } from '../../../src/core/public';
+import { AppMountParameters, IUiSettingsClient } from '../../../src/core/public';
 import { DashboardEmbeddableByValue } from './by_value/embeddable';
 import { DashboardStart } from '../../../src/plugins/dashboard/public';
+import { KibanaContextProvider } from '../../../src/plugins/kibana_react/public';
 
 interface PageDef {
   title: string;
@@ -58,9 +59,14 @@ interface Props {
   DashboardContainerByValueRenderer: ReturnType<
     DashboardStart['getDashboardContainerByValueRenderer']
   >;
+  uiSettings: IUiSettingsClient;
 }
 
-const DashboardEmbeddableExplorerApp = ({ basename, DashboardContainerByValueRenderer }: Props) => {
+const DashboardEmbeddableExplorerApp = ({
+  basename,
+  DashboardContainerByValueRenderer,
+  uiSettings,
+}: Props) => {
   const pages: PageDef[] = [
     {
       title: 'By value dashboard embeddable',
@@ -83,16 +89,18 @@ const DashboardEmbeddableExplorerApp = ({ basename, DashboardContainerByValueRen
   ));
 
   return (
-    <Router basename={basename}>
-      <EuiPage>
-        <EuiPageSideBar>
-          <Nav pages={pages} />
-        </EuiPageSideBar>
-        <EuiPageContent>
-          <EuiPageContentBody>{routes}</EuiPageContentBody>
-        </EuiPageContent>
-      </EuiPage>
-    </Router>
+    <KibanaContextProvider services={{ uiSettings }}>
+      <Router basename={basename}>
+        <EuiPage>
+          <EuiPageSideBar>
+            <Nav pages={pages} />
+          </EuiPageSideBar>
+          <EuiPageContent>
+            <EuiPageContentBody>{routes}</EuiPageContentBody>
+          </EuiPageContent>
+        </EuiPage>
+      </Router>
+    </KibanaContextProvider>
   );
 };
 

diff --git a/examples/dashboard_embeddable_examples/public/by_value/input_editor.tsx b/examples/dashboard_embeddable_examples/public/by_value/input_editor.tsx
@@ -8,7 +8,7 @@
 
 import React from 'react';
 import { EuiButton } from '@elastic/eui';
-import { JsonEditor } from '../../../../src/plugins/es_ui_shared/public';
+import { CodeEditor } from '../../../../src/plugins/kibana_react/public';
 
 export const InputEditor = <T,>(props: { input: T; onSubmit: (value: T) => void }) => {
   const input = JSON.stringify(props.input, null, 4);
@@ -26,12 +26,13 @@ export const InputEditor = <T,>(props: { input: T; onSubmit: (value: T) => void
   }, [input]);
   return (
     <>
-      <JsonEditor
+      <CodeEditor
+        languageId={'json'}
         value={value}
-        onUpdate={(v) => setValue(v.data.raw)}
-        euiCodeEditorProps={{
-          'data-test-subj': 'dashboardEmbeddableByValueInputEditor',
-        }}
+        width={'100%'}
+        height={'400px'}
+        onChange={(v) => setValue(v)}
+        data-test-subj={'dashboardEmbeddableByValueInputEditor'}
       />
       <EuiButton
         onClick={() => props.onSubmit(JSON.parse(value))}

diff --git a/examples/dashboard_embeddable_examples/public/plugin.tsx b/examples/dashboard_embeddable_examples/public/plugin.tsx
@@ -27,14 +27,15 @@ export class DashboardEmbeddableExamples implements Plugin<void, void, {}, Start
       title: 'Dashboard embeddable examples',
       navLinkStatus: AppNavLinkStatus.hidden,
       async mount(params: AppMountParameters) {
-        const [, depsStart] = await core.getStartServices();
+        const [coreStart, depsStart] = await core.getStartServices();
         const { renderApp } = await import('./app');
         await depsStart.embeddableExamples.createSampleData();
         return renderApp(
           {
             basename: params.appBasePath,
             DashboardContainerByValueRenderer:
               depsStart.dashboard.getDashboardContainerByValueRenderer(),
+            uiSettings: coreStart.uiSettings,
           },
           params.element
         );

diff --git a/examples/dashboard_embeddable_examples/tsconfig.json b/examples/dashboard_embeddable_examples/tsconfig.json
@@ -15,7 +15,7 @@
     { "path": "../../src/core/tsconfig.json" },
     { "path": "../../src/plugins/dashboard/tsconfig.json" },
     { "path": "../../src/plugins/embeddable/tsconfig.json" },
-    { "path": "../../src/plugins/es_ui_shared/tsconfig.json" },
+    { "path": "../../src/plugins/kibana_react/tsconfig.json" },
     { "path": "../embeddable_examples/tsconfig.json" },
     { "path": "../developer_examples/tsconfig.json" },
   ]

diff --git a/src/plugins/data/public/ui/filter_bar/filter_editor/filter_editor.test.tsx b/src/plugins/data/public/ui/filter_bar/filter_editor/filter_editor.test.tsx
@@ -10,14 +10,14 @@ import { registerTestBed, TestBed } from '@kbn/test/jest';
 import { FilterEditor, Props } from '.';
 import React from 'react';
 
-jest.mock('@elastic/eui', () => {
-  const original = jest.requireActual('@elastic/eui');
+jest.mock('../../../../../kibana_react/public', () => {
+  const original = jest.requireActual('../../../../../kibana_react/public');
 
   return {
     ...original,
-    EuiCodeEditor: (props: any) => (
+    CodeEditor: (props: any) => (
       <input
-        data-test-subj={props['data-test-subj'] || 'mockEuiCodeEditor'}
+        data-test-subj={props['data-test-subj'] || 'mockCodeEditor'}
         value={props.value}
         onChange={async (eve: any) => {
           props.onChange(eve.target.value);

diff --git a/src/plugins/data/public/ui/filter_bar/filter_editor/index.tsx b/src/plugins/data/public/ui/filter_bar/filter_editor/index.tsx
@@ -9,8 +9,6 @@
 import {
   EuiButton,
   EuiButtonEmpty,
-  // @ts-ignore
-  EuiCodeEditor,
   EuiFieldText,
   EuiFlexGroup,
   EuiFlexItem,
@@ -33,6 +31,7 @@ import {
 } from '@kbn/es-query';
 import { get } from 'lodash';
 import React, { Component } from 'react';
+import { XJsonLang } from '@kbn/monaco';
 import { GenericComboBox, GenericComboBoxProps } from './generic_combo_box';
 import {
   getFieldFromFilter,
@@ -47,6 +46,7 @@ import { PhrasesValuesInput } from './phrases_values_input';
 import { RangeValueInput } from './range_value_input';
 import { getIndexPatternFromFilter } from '../../../query';
 import { IIndexPattern, IFieldType } from '../../..';
+import { CodeEditor } from '../../../../../kibana_react/public';
 
 export interface Props {
   filter: Filter;
@@ -328,13 +328,16 @@ class FilterEditorUI extends Component<Props, State> {
           defaultMessage: 'Elasticsearch Query DSL',
         })}
       >
-        <EuiCodeEditor
+        <CodeEditor
+          languageId={XJsonLang.ID}
+          width="100%"
+          height={'250px'}
           value={this.state.queryDsl}
           onChange={this.onQueryDslChange}
-          mode="json"
-          width="100%"
-          height="250px"
           data-test-subj="customEditorInput"
+          aria-label={i18n.translate('data.filter.filterEditor.queryDslAriaLabel', {
+            defaultMessage: 'Elasticsearch Query DSL editor',
+          })}
         />
       </EuiFormRow>
     );

diff --git a/...attern_management/public/components/field_editor/__snapshots__/field_editor.test.tsx.snap b/...attern_management/public/components/field_editor/__snapshots__/field_editor.test.tsx.snap
diff --git a/src/plugins/index_pattern_management/public/components/field_editor/field_editor.test.tsx b/src/plugins/index_pattern_management/public/components/field_editor/field_editor.test.tsx
@@ -10,8 +10,6 @@ import { IndexPattern, IndexPatternField, IndexPatternsService } from 'src/plugi
 import { FieldFormatInstanceType } from 'src/plugins/field_formats/common';
 import { findTestSubject } from '@elastic/eui/lib/test';
 
-jest.mock('brace/mode/groovy', () => ({}));
-
 import { FieldEditor, FieldEdiorProps } from './field_editor';
 
 import { mockManagementPlugin } from '../../mocks';
@@ -23,7 +21,6 @@ jest.mock('@elastic/eui', () => ({
   EuiButtonEmpty: 'eui-button-empty',
   EuiCallOut: 'eui-call-out',
   EuiCode: 'eui-code',
-  EuiCodeEditor: 'eui-code-editor',
   EuiConfirmModal: 'eui-confirm-modal',
   EuiFieldNumber: 'eui-field-number',
   EuiFieldText: 'eui-field-text',
@@ -42,6 +39,15 @@ jest.mock('@elastic/eui', () => ({
   euiPaletteColorBlind: () => ['red'],
 }));
 
+jest.mock('../../../../kibana_react/public', () => {
+  const original = jest.requireActual('../../../../kibana_react/public');
+
+  return {
+    ...original,
+    CodeEditor: `code-editor`,
+  };
+});
+
 jest.mock('../../scripting_languages', () => ({
   getEnabledScriptingLanguages: () => ['painless', 'testlang'],
   getSupportedScriptingLanguages: () => ['painless'],

diff --git a/src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx b/src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx
@@ -15,7 +15,6 @@ import {
   EuiButtonEmpty,
   EuiCallOut,
   EuiCode,
-  EuiCodeEditor,
   EuiConfirmModal,
   EuiFieldNumber,
   EuiFieldText,
@@ -33,6 +32,7 @@ import {
 
 import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';
+import { PainlessLang } from '@kbn/monaco';
 import type { FieldFormatInstanceType } from 'src/plugins/field_formats/common';
 import {
   getEnabledScriptingLanguages,
@@ -46,7 +46,7 @@ import {
   ES_FIELD_TYPES,
   DataPublicPluginStart,
 } from '../../../../../plugins/data/public';
-import { context as contextType } from '../../../../kibana_react/public';
+import { context as contextType, CodeEditor } from '../../../../kibana_react/public';
 import {
   ScriptingDisabledCallOut,
   ScriptingWarningCallOut,
@@ -59,9 +59,6 @@ import { IndexPatternManagmentContextValue } from '../../types';
 import { FIELD_TYPES_BY_LANG, DEFAULT_FIELD_TYPES } from './constants';
 import { executeScript, isScriptValid } from './lib';
 
-// This loads Ace editor's "groovy" mode, used below to highlight the script.
-import 'brace/mode/groovy';
-
 const getFieldTypeFormatsList = (
   field: IndexPatternField['spec'],
   defaultFieldFormat: FieldFormatInstanceType,
@@ -594,13 +591,16 @@ export class FieldEditor extends PureComponent<FieldEdiorProps, FieldEditorState
           isInvalid={isInvalid}
           error={isInvalid ? errorMsg : null}
         >
-          <EuiCodeEditor
-            value={spec.script}
-            data-test-subj="editorFieldScript"
-            onChange={this.onScriptChange}
-            mode="groovy"
+          <CodeEditor
+            languageId={PainlessLang.ID}
             width="100%"
             height="300px"
+            value={spec.script ?? ''}
+            onChange={this.onScriptChange}
+            data-test-subj="editorFieldScript"
+            aria-label={i18n.translate('indexPatternManagement.scriptLabelAriaLabel', {
+              defaultMessage: 'Script editor',
+            })}
           />
         </EuiFormRow>
 

diff --git a/test/examples/embeddables/dashboard.ts b/test/examples/embeddables/dashboard.ts
@@ -95,10 +95,10 @@ export default function ({ getService, getPageObjects }: PluginFunctionalProvide
   const esArchiver = getService('esArchiver');
   const testSubjects = getService('testSubjects');
   const pieChart = getService('pieChart');
-  const browser = getService('browser');
   const dashboardExpect = getService('dashboardExpect');
   const elasticChart = getService('elasticChart');
   const PageObjects = getPageObjects(['common', 'visChart']);
+  const monacoEditor = getService('monacoEditor');
 
   describe('dashboard container', () => {
     before(async () => {
@@ -128,17 +128,7 @@ export default function ({ getService, getPageObjects }: PluginFunctionalProvide
   });
 
   async function updateInput(input: string) {
-    const editorWrapper = await (
-      await testSubjects.find('dashboardEmbeddableByValueInputEditor')
-    ).findByClassName('ace_editor');
-    const editorId = await editorWrapper.getAttribute('id');
-    await browser.execute(
-      (_editorId: string, _input: string) => {
-        return (window as any).ace.edit(_editorId).setValue(_input);
-      },
-      editorId,
-      input
-    );
+    await monacoEditor.setCodeEditorValue(input);
     await testSubjects.click('dashboardEmbeddableByValueInputSubmit');
   }
 }