[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin #192017

Heenawter · 2024-09-03T16:51:52Z

Part of #192005
Closes #176533

Summary

This PR represents the first major cleanup task for the control group embeddable refactor. The tasks included in this PR can be loosely summarized as follows:

This PR removes the old, non-React version of controls
- Note that the new controls are still included under the react_controls folder - I will address this in a follow up PR.
This PR removes all types associated with the old embeddable system; i.e. any *input* or *output* types.
- As part of cleaning up these types, some of the types included in the public/react_controls folder had to be moved to common to make them available to server-side code.
- This resulted in an... unfortunate number of import changes 🫠 Hence the rather large file change count. I took this opportunity to organize the imports, too - so a significant chunk of these files are simply import changes.
This PR removes the controls Storybook and all related mocks
- Since the controls storybooks have been broken for awhile, and since we had plans to remove them but never got around to it, I just decided to delete them as part of this PR and close [Controls] Remove storybooks #176533 rather than spending time to fix the types for non-operational stories

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

…ld_final-controls-cleanup_2024-09-03

… github.com:heenawter/kibana into embeddableRebuild_final-controls-cleanup_2024-09-03

…ld_final-controls-cleanup_2024-09-03

Heenawter · 2024-09-12T15:32:12Z

src/plugins/controls/public/actions/delete_control_action.test.tsx

This file was refactored to support the new types and then moved from src/plugins/controls/public/control_group/actions to src/plugins/controls/public/actions - because of this, GitHub is reporting it as an entirely new file 🤷 This is not actually a new test

Heenawter · 2024-09-12T15:32:58Z

src/plugins/controls/public/actions/index.ts

@@ -7,6 +7,6 @@
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

-export const ACTION_EDIT_CONTROL = 'editLegacyEmbeddableControl';
+export const ACTION_EDIT_CONTROL = 'editDataControl';


editLegacyEmbeddableControl isn't necessary anymore, as the legacy edit action has been deleted and replaced with the React control edit action

Heenawter · 2024-09-12T15:33:20Z

src/plugins/controls/public/types.ts

 }

 export interface ControlsPluginStart {
  getControlFactory: ControlsServiceType['getControlFactory'];
-  getControlTypes: ControlsServiceType['getControlTypes'];
+  getAllControlTypes: ControlsServiceType['getAllControlTypes'];


I decided to keep the setup and start contracts more-or-less the same, despite the fact that no one is using them - if we want to remove the ability for outside plugins to register controls, we can delete this in a follow up PR.

Heenawter · 2024-09-12T15:33:45Z

src/plugins/controls/server/control_group/control_group_persistence.ts

This file was moved from common to server, but some of the code was also changed to make the types happy - it is worth taking a closer look at this file 🙇

Heenawter · 2024-09-12T15:34:08Z

src/plugins/controls/server/control_group/control_group_migrations.ts

This file was moved from common to server, but some of the code was also changed to make the types happy - it is worth taking a closer look at this file 🙇

Heenawter · 2024-09-12T15:35:54Z

src/plugins/controls/public/index.ts

+export type {
+  ControlGroupRuntimeState,
+  ControlGroupSerializedState,
+  ControlPanelState,
+  ControlPanelsState,
+  DefaultDataControlState,
+} from '../common';
+export type { OptionsListControlState } from '../common/options_list';


I've had to export some stuff from common to keep the imports consistent for external uses - I kept these minimal though (i.e. only included the types that are used externally), since any internal controls code should just import from common when necessary.

Heenawter · 2024-09-12T15:36:28Z

src/plugins/controls/public/react_controls/control_group/components/control_group.scss

This file used to contain a bunch of other styles specific to control panels - that logic was moved to control_panel.scss as part of the initial refactor, so this file now contains the bare minimum control group styling.

Heenawter · 2024-09-12T15:36:47Z

src/plugins/controls/public/react_controls/control_group/components/control_panel.scss

I decided to move a bunch of styles from the old control_group.scss to this file - that is why you are seeing a bunch of changes 🙇 I added some comments to try to clarify which styles are doing what, since this SASS file is a bit... unruly.

Heenawter · 2024-09-12T15:37:12Z

src/plugins/controls/public/react_controls/control_group/components/control_panel.test.tsx

@@ -50,7 +52,7 @@ describe('render', () => {
      await waitFor(() => {
        const controlFrame = controlPanel.getByTestId('control-frame');
        expect(controlFrame.getAttribute('class')).toContain('controlFrameWrapper--medium');
-        expect(controlFrame.getAttribute('class')).toContain('controlFrameWrapper--grow');
+        expect(controlFrame.getAttribute('class')).toContain('euiFlexItem-grow');


We were never actually using the controlFrameWrapper--grow class so I removed it - a euiFlexItem-grow class check accomplishes the same thing, though.

Heenawter · 2024-09-12T15:37:37Z

src/plugins/controls/public/services/data/data_service.ts

This service had a bunch of stuff for the old timeslider control + the range slider control that are no longer being used 🤷 So I removed it all. I plan on doing a full audit of the services as part of #192005 to ensure everything is being used, but it was easier to remove this now because it was tied to old ControlInput types.

elasticmachine · 2024-09-12T16:30:51Z

Pinging @elastic/kibana-presentation (Team:Presentation)

nreese

kibana-presentation changes LGTM
code review only

src/plugins/controls/public/actions/delete_control_action.test.tsx

src/plugins/controls/public/actions/edit_control_action.test.tsx

src/plugins/controls/public/services/embeddable/embeddable.stub.ts

andreadelrio

Style changes LGTM. Very nice *.scss clean up @Heenawter !

davismcphee

Code-only review, Data Discovery change LGTM 👍

…4-09-03

kibana-ci · 2024-09-16T21:00:21Z

💛 Build succeeded, but was flaky

Failed CI Steps

Jest Tests #14

Test Failures

[job] [logs] Jest Tests #14 / Timeline rendering should trim kqlQueryExpression

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`controls`	445	362	-83

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`controls`	254	134	-120

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`controls`	597.0KB	459.4KB	-137.6KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`controls`	30	14	-16

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`controls`	46.1KB	12.9KB	-33.2KB

Unknown metric groups

API count

id	before	after	diff
`controls`	259	138	-121

async chunk count

id	before	after	diff
`controls`	19	11	-8

ESLint disabled line counts

id	before	after	diff
`controls`	7	5	-2

References to deprecated APIs

id	before	after	diff
`controls`	23	17	-6

Total ESLint disabled count

id	before	after	diff
`controls`	7	5	-2

History

💔 Build #234511 failed 2084639
💔 Build #234436 failed 62c217c
💚 Build #233829 succeeded 3917c17
💛 Build #233770 was flaky 6c714c8
💔 Build #233626 failed dbc461e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Heenawter

michaelolo24

Investigations changes, LGTM, sorry for the delay!

…ols` plugin (elastic#192017) Part of elastic#192005 Closes elastic#176533 ## Summary This PR represents the first major cleanup task for the control group embeddable refactor. The tasks included in this PR can be loosely summarized as follows: 1. This PR removes the old, non-React version of controls - Note that the new controls are still included under the `react_controls` folder - I will address this in a follow up PR. 2. This PR removes **all** types associated with the old embeddable system; i.e. any `*input*` or `*output*` types. - As part of cleaning up these types, some of the types included in the `public/react_controls` folder had to be moved to `common` to make them available to server-side code. - This resulted in an... unfortunate number of import changes 🫠 Hence the rather large file change count. I took this opportunity to organize the imports, too - so a significant chunk of these files are simply import changes. 3. This PR removes the controls Storybook and all related mocks - Since the controls storybooks have been broken for awhile, and since we had plans to remove them but never got around to it, I just decided to delete them as part of this PR and close elastic#176533 rather than spending time to fix the types for non-operational stories ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 5082eef)

kibanamachine · 2024-09-17T14:17:50Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…`controls` plugin (#192017) (#193174) # Backport This will backport the following commits from `main` to `8.x`: - [[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin (#192017)](#192017)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>

…ols` plugin (elastic#192017) Part of elastic#192005 Closes elastic#176533 ## Summary This PR represents the first major cleanup task for the control group embeddable refactor. The tasks included in this PR can be loosely summarized as follows: 1. This PR removes the old, non-React version of controls - Note that the new controls are still included under the `react_controls` folder - I will address this in a follow up PR. 2. This PR removes **all** types associated with the old embeddable system; i.e. any `*input*` or `*output*` types. - As part of cleaning up these types, some of the types included in the `public/react_controls` folder had to be moved to `common` to make them available to server-side code. - This resulted in an... unfortunate number of import changes 🫠 Hence the rather large file change count. I took this opportunity to organize the imports, too - so a significant chunk of these files are simply import changes. 3. This PR removes the controls Storybook and all related mocks - Since the controls storybooks have been broken for awhile, and since we had plans to remove them but never got around to it, I just decided to delete them as part of this PR and close elastic#176533 rather than spending time to fix the types for non-operational stories ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Heenawter self-assigned this Sep 3, 2024

This was referenced Sep 3, 2024

[Embeddables Rebuild] [Controls] Final cleanup #192005

Closed

[Dashboard] Compressed Styles for Controls #190636

Merged

Heenawter added 11 commits September 10, 2024 10:21

Delete old control files

d1fefd8

Remove legacy edit action

0f2ad3f

Fix action tests

79b7a09

Remove unused types

f318f75

Start working on server side code

2859409

Fix server side tests

7b1707c

Move options list inject/extract to server

c3d1f0e

Fix telemetry types

651fbc8

Delete story services

8c09d88

Fix plugin contract

a814f2c

Fix more types

ed106ab

Heenawter force-pushed the embeddableRebuild_final-controls-cleanup_2024-09-03 branch from cff635b to ed106ab Compare September 10, 2024 16:24

Heenawter and others added 10 commits September 10, 2024 12:53

Merge branch 'main' of github.com:elastic/kibana into embeddableRebui…

c75aeb9

…ld_final-controls-cleanup_2024-09-03

More cleanup after merge

970347d

[CI] Auto-commit changed files from 'node scripts/notice'

2f90dcc

Clean up unused translations

049851f

[CI] Auto-commit changed files from 'node scripts/notice'

27596ab

Fix registration + styles

ddfc7f3

Merge branch 'embeddableRebuild_final-controls-cleanup_2024-09-03' of…

adf1eb9

… github.com:heenawter/kibana into embeddableRebuild_final-controls-cleanup_2024-09-03

Fix types + imports

0844191

Fix more types

9ea6f56

Merge branch 'main' of github.com:elastic/kibana into embeddableRebui…

bc0710a

…ld_final-controls-cleanup_2024-09-03

Heenawter commented Sep 12, 2024

View reviewed changes

Heenawter marked this pull request as ready for review September 12, 2024 16:30

Heenawter requested review from a team as code owners September 12, 2024 16:30

Heenawter requested a review from nreese September 12, 2024 16:53

nreese approved these changes Sep 12, 2024

View reviewed changes

Remove ErrorEmbeddable tests

3917c17

jbudz approved these changes Sep 12, 2024

View reviewed changes

andreadelrio approved these changes Sep 12, 2024

View reviewed changes

davismcphee approved these changes Sep 13, 2024

View reviewed changes

Heenawter added the backport:prev-minor Backport to the previous minor version (i.e. one version back from main) label Sep 13, 2024

Heenawter added 3 commits September 16, 2024 07:52

Merge branch 'main' into embeddableRebuild_final-controls-cleanup_202…

62c217c

…4-09-03

Merge branch 'main' into embeddableRebuild_final-controls-cleanup_202…

2084639

…4-09-03

Merge branch 'main' into embeddableRebuild_final-controls-cleanup_202…

b8ed89b

…4-09-03

michaelolo24 approved these changes Sep 17, 2024

View reviewed changes

Heenawter merged commit 5082eef into elastic:main Sep 17, 2024
42 checks passed

Heenawter deleted the embeddableRebuild_final-controls-cleanup_2024-09-03 branch September 17, 2024 14:13

kibanamachine added the v9.0.0 label Sep 17, 2024

kibanamachine mentioned this pull request Sep 17, 2024

[8.x] [Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin (#192017) #193174

Merged

kibanamachine added the v8.16.0 label Sep 17, 2024

Heenawter mentioned this pull request Sep 17, 2024

[Embeddable Rebuild] [Controls] Clean up services + TODOs #193180

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin #192017

[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin #192017

Heenawter commented Sep 3, 2024 •

edited by kibanamachine

Loading

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

Heenawter Sep 12, 2024

elasticmachine commented Sep 12, 2024

nreese left a comment

andreadelrio left a comment

davismcphee left a comment

kibana-ci commented Sep 16, 2024

API count

async chunk count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

michaelolo24 left a comment

kibanamachine commented Sep 17, 2024

[Embeddable Rebuild] [Controls] Remove non-React controls from controls plugin #192017

[Embeddable Rebuild] [Controls] Remove non-React controls from controls plugin #192017

Conversation

Heenawter commented Sep 3, 2024 • edited by kibanamachine Loading

Summary

Checklist

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Sep 12, 2024

nreese left a comment

Choose a reason for hiding this comment

andreadelrio left a comment

Choose a reason for hiding this comment

davismcphee left a comment

Choose a reason for hiding this comment

kibana-ci commented Sep 16, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

michaelolo24 left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 17, 2024

💚 All backports created successfully

Questions ?

[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin #192017

[Embeddable Rebuild] [Controls] Remove non-React controls from `controls` plugin #192017

Heenawter commented Sep 3, 2024 •

edited by kibanamachine

Loading