[uiActions] make trigger action registry async by nreese · Pull Request #205512 · elastic/kibana

nreese · 2025-01-03T15:45:11Z

Closes #191642, part of #205512

PR makes the following changes to uiActions API.

Deprecates registerAction and addTriggerAction and replaces them with registerActionAsync and addTriggerActionAsync
Makes all registry consumption methods async, such as getAction, getTriggerActions and getFrequentlyChangingActionsForTrigger

PR updates presentation_panel plugin to use registerActionAsync. With actions behind async import, page load bundle size has been reduced by 21.1KB.

Also, async exports are contained in a single file panel_module. This results in dashboard only loading one presentationPanel.chunk.

nreese · 2025-01-03T17:01:54Z

/ci

nreese · 2025-01-03T17:19:00Z

/ci

…-fix'

nreese · 2025-01-03T17:53:16Z

/ci

nreese · 2025-01-03T20:36:37Z

/ci

…-fix'

nreese · 2025-01-03T22:23:48Z

/ci

nreese · 2025-01-03T22:33:11Z

/ci

…-fix'

nreese · 2025-01-04T16:45:36Z

/ci

…-fix'

nreese · 2025-01-04T17:13:59Z

/ci

nreese · 2025-01-08T21:23:30Z

@elasticmachine merge upstream

nreese · 2025-01-08T23:06:55Z

@elasticmachine merge upstream

davismcphee

Checked quickly in Discover and no issues, Data Discovery changes LGTM 👍

dej611 · 2025-01-10T10:15:58Z

+    const results = await Promise.allSettled([
      startServicesPromise,
      componentPromise,
-      modulePromise,
+      import('./panel_module'),
    ]);
-    const Panel = panelModule.PresentationPanelInternal;
-    return { Panel, unwrappedComponent };
+
+    for (const result of results) {
+      if (result.status === 'rejected') {
+        throw new Error(result.reason);
+      }
+    }


nit: all this code looks very similar to the default behaviour of Promise.all? Why checking it manually?

Promise.all does not return values when any promise rejects. Since PresentationPanelErrorInternal is returned from one of the promises (and PresentationPanelErrorInternal is used to diplay errors), I am using Promise. allSettled so PresentationPanelErrorInternal is returned if componentPromise rejects.

I do see a logic error now where the method throws when a promise rejects so no values are returned. I will rework this so that it does not throw on rejected, and instead returns an error status along with any available results

resolved with 7ac06f4

nreese · 2025-01-10T14:31:48Z

@elasticmachine merge upstream

eokoneyo

Shared UX changes LGTM, thanks for the contribution

ThomThomson

This is such a straightforward set of changes for such an impactful reduction in bundle size! Excellent idea and execution here.

Looked through the code and everything LGTM!

Also ran this locally and verified that the presentationPanel plugin had only one async chunk, and that it was loaded when expected (i.e. when a Dashboard with at least one panel is on screen).

ThomThomson · 2025-01-10T18:51:55Z


  useEffect(() => {
-    let cancelled = false;
+    let canceled = false;


Canadian vs American spelling here 😈 CC @Heenawter for backup

Sorry about that, reverted here acba4f1

walterra

ML related changes LGTM. This is a nice enhancement, we're looking forward to make use of it.

nreese · 2025-01-13T15:29:19Z

@elasticmachine merge upstream

elasticmachine · 2025-01-13T16:52:51Z

💚 Build Succeeded

Buildkite Build
Commit: f60f201

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`presentationPanel`	104	117	+13

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
`presentationPanel`	11	9	-2
`uiActions`	110	117	+7
total			+5

Async chunks

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

id	before	after	diff
`dataVisualizer`	598.5KB	598.5KB	+13.0B
`discover`	843.2KB	843.3KB	+16.0B
`lens`	1.6MB	1.6MB	+30.0B
`maps`	3.1MB	3.1MB	+40.0B
`presentationPanel`	15.6KB	35.9KB	+20.3KB
total			+20.4KB

Page load bundle

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

id	before	after	diff
`dashboard`	49.0KB	49.2KB	+163.0B
`presentationPanel`	44.9KB	23.9KB	-21.0KB
`presentationUtil`	32.4KB	32.4KB	+11.0B
`uiActions`	21.5KB	22.0KB	+564.0B
total			-20.3KB

Unknown metric groups

API count

id	before	after	diff
`presentationPanel`	11	9	-2
`uiActions`	156	163	+7
total			+5

ESLint disabled line counts

id	before	after	diff
`dashboard`	10	11	+1
`presentationPanel`	6	7	+1
total			+2

References to deprecated APIs

id	before	after	diff
`aiops`	4	9	+5
`cases`	31	32	+1
`controls`	13	16	+3
`dashboard`	21	30	+9
`dashboardEnhanced`	9	11	+2
`data`	29	32	+3
`discover`	8	10	+2
`discoverEnhanced`	0	2	+2
`esql`	0	1	+1
`imageEmbeddable`	1	2	+1
`inputControlVis`	10	11	+1
`lens`	85	92	+7
`links`	3	4	+1
`maps`	30	33	+3
`ml`	35	53	+18
`reporting`	4	5	+1
`securitySolution`	355	362	+7
`slo`	3	7	+4
`synthetics`	20	22	+2
`uiActionsEnhanced`	11	12	+1
`unifiedSearch`	13	15	+2
`visualizations`	55	57	+2
total			+78

Total ESLint disabled count

id	before	after	diff
`dashboard`	10	11	+1
`presentationPanel`	6	7	+1
total			+2

History

💛 Build #266214 was flaky acba4f1
💚 Build #266085 succeeded 7ac06f4
💚 Build #265426 succeeded afc3c66
💔 Build #265392 failed 8e38822
💔 Build #265387 failed 488d0f9
💛 Build #265344 was flaky 98c19e0

kibanamachine · 2025-01-13T16:57:51Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12752165266

kibanamachine · 2025-01-13T17:02:53Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 205512

Questions ?

Please refer to the Backport tool documentation

nreese · 2025-01-13T17:21:12Z

💚 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

Closes elastic#191642, part of elastic#205512 PR makes the following changes to uiActions API. * Deprecates `registerAction` and `addTriggerAction` and replaces them with `registerActionAsync` and `addTriggerActionAsync` * Makes all registry consumption methods async, such as `getAction`, `getTriggerActions` and `getFrequentlyChangingActionsForTrigger` PR updates presentation_panel plugin to use `registerActionAsync`. With actions behind async import, page load bundle size has been reduced by 21.1KB. <img width="500" alt="Screenshot 2025-01-08 at 2 14 23 PM" src="https://github.com/user-attachments/assets/34a2cae9-dc5e-429b-bbdb-ffd9dfe1cce3" /> Also, async exports are [contained in a single file `panel_module`](elastic#206117). This results in dashboard only loading one `presentationPanel.chunk`. <img width="500" alt="Screenshot 2025-01-08 at 2 15 02 PM" src="https://github.com/user-attachments/assets/e083b852-b50d-4fa7-8ebd-e2f56f85e998" /> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 1bd8c97) # Conflicts: # src/platform/plugins/private/presentation_panel/public/panel_component/presentation_panel.tsx

# Backport This will backport the following commits from `main` to `8.x`: - [[uiActions] make trigger action registry async (#205512)](#205512)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

Closes elastic#191642, part of elastic#205512 PR makes the following changes to uiActions API. * Deprecates `registerAction` and `addTriggerAction` and replaces them with `registerActionAsync` and `addTriggerActionAsync` * Makes all registry consumption methods async, such as `getAction`, `getTriggerActions` and `getFrequentlyChangingActionsForTrigger` PR updates presentation_panel plugin to use `registerActionAsync`. With actions behind async import, page load bundle size has been reduced by 21.1KB. <img width="500" alt="Screenshot 2025-01-08 at 2 14 23 PM" src="https://github.com/user-attachments/assets/34a2cae9-dc5e-429b-bbdb-ffd9dfe1cce3" /> Also, async exports are [contained in a single file `panel_module`](elastic#206117). This results in dashboard only loading one `presentationPanel.chunk`. <img width="500" alt="Screenshot 2025-01-08 at 2 15 02 PM" src="https://github.com/user-attachments/assets/e083b852-b50d-4fa7-8ebd-e2f56f85e998" /> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

#205512 added 'async' registry methods. This PR completes this work and removes 'sync' registry methods and all remaining usages of 'sync ' methods. async registries * avoid async imports during plugin setup/start * prevent race condition where plugins register items async. Another plugin's start contact could start before async setup is complete. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

nreese added 3 commits January 3, 2025 08:44

[uiActions] make trigger action registry async

d125a86

tslint for dashboards plugin

9db2492

tslint discover

58459d7

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

aaeafa7

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

67f03fb

…-fix'

nreese added 2 commits January 3, 2025 12:41

use async registry for panel actions

15e543e

presentation_container_example tslint

ba3a8b4

kibanamachine and others added 5 commits January 3, 2025 20:45

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

9d77458

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

fa3bddf

…-fix'

use getTriggerCompatibleActions

7f55e04

PresentationPanelErrorInternal

e2e3fc2

fix test

d30c785

nreese added 5 commits January 3, 2025 15:24

revert change to tsconfig.js

2488716

revert change to index file

d2d47d9

revert changes to PresentationPanel

20c36fa

clean up

ad14ab3

tsconfig

38c646f

kibanamachine and others added 3 commits January 3, 2025 22:41

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

fb68162

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

182dc84

…-fix'

dashboard tslint

5c5f026

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

6776f96

…-fix'

fix dynamic_action_manager.test.ts

6f1bd4d

ThomThomson self-requested a review January 8, 2025 21:18

Merge branch 'main' into async_actions

8e38822

Merge branch 'main' into async_actions

afc3c66

davismcphee approved these changes Jan 10, 2025

View reviewed changes

dej611 approved these changes Jan 10, 2025

View reviewed changes

elasticmachine and others added 2 commits January 10, 2025 14:31

Merge branch 'main' into async_actions

1e0e79f

do not throw error when loading panel components

7ac06f4

eokoneyo approved these changes Jan 10, 2025

View reviewed changes

ThomThomson approved these changes Jan 10, 2025

View reviewed changes

revert spelling change

acba4f1

walterra approved these changes Jan 13, 2025

View reviewed changes

Merge branch 'main' into async_actions

f60f201

nreese merged commit 1bd8c97 into elastic:main Jan 13, 2025

nreese mentioned this pull request Jan 13, 2025

[8.x] [uiActions] make trigger action registry async (#205512) #206480

Merged

ThomThomson mentioned this pull request Jan 24, 2025

[Dashboard] reduce chunk loading to 1 or 2 chunks per plugin #206117

Closed

nickpeihl mentioned this pull request Jun 17, 2025

[Share] Convert Share registry to async registry #224139

Closed

11 tasks

nreese mentioned this pull request Mar 13, 2026

remove sync register uiAction methods #254590

Merged

Conversation

nreese commented Jan 3, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 3, 2025

Uh oh!

nreese commented Jan 4, 2025

Uh oh!

nreese commented Jan 4, 2025

Uh oh!

nreese commented Jan 8, 2025

Uh oh!

nreese commented Jan 8, 2025

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

dej611 Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

nreese Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nreese Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

nreese Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

nreese commented Jan 10, 2025

Uh oh!

eokoneyo left a comment

Choose a reason for hiding this comment

Uh oh!

ThomThomson left a comment

Choose a reason for hiding this comment

Uh oh!

ThomThomson Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

nreese Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

walterra left a comment

Choose a reason for hiding this comment

Uh oh!

nreese commented Jan 13, 2025

Uh oh!

elasticmachine commented Jan 13, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

Uh oh!

kibanamachine commented Jan 13, 2025

Uh oh!

kibanamachine commented Jan 13, 2025

💔 All backports failed

Manual backport

Questions ?

nreese commented Jan 3, 2025 •

edited by kibanamachine

Loading

nreese Jan 10, 2025 •

edited

Loading