async-import plugins in the server side by afharo · Pull Request #170856 · elastic/kibana

afharo · 2023-11-08T12:51:26Z

Summary

When Kibana starts, it has to import the file ${plugin}/server/index for all the plugins in order to read the config variable that it's exported from that file.

Since the index file for each plugin loads the ./plugin file, it's indirectly loading all the files of the plugin in one go. This essentially makes Kibana load all the server-side code from all the plugins, even when the plugins might be disabled. While it wasn't a big deal in the Classic offering (most plugins are enabled), on Serverless we are disabling a lot of plugins (and also adding a good amount of Serverless-specific plugins that shouldn't load on Classic).

This PR changes all the ${plugin}/server/index files to follow a pattern like:

import type { PluginConfigDescriptor, PluginInitializerContext } from '@kbn/core/server';

import { configSchema } from './config';

export const config: PluginConfigDescriptor<TypeOf<typeof configSchema>> = {
  schema: configSchema,
};

export const plugin = async (context: PluginInitializerContext) => {
  const { MyPlugin } = await import('./plugin'); // <-- The import has been moved here
  return new MyPlugin(context);
};

Checklist

Documentation was added for features that require explanation or tutorials
Change the plugin generator's template.

Risk Matrix

Risk	Probability	Severity	Mitigation/Notes
Kibana might show logs in a different order.	Low	Low	One of the FTRs failed because Kibana is now able to report `unavailable` status before it is actually serving any HTTP traffic. Commit `0404c34` fixed the FTR, but that means we might expect things to slightly change the order in which they occur when Kibana is starting. This should only affect automations that depend on specific log entries because Kibana won't report `available` until all plugins are correctly setup.

For maintainers

This was checked for breaking API changes and was labeled appropriately

…fix'

afharo · 2023-11-13T11:46:37Z

@afharo it would be nice if we could have an ES Lint rule to enforce this pattern

@opauloh, that's a great idea! I've created #171080 to tackle it since it looks to me like an effort on its own 😇

ymao1

Response Ops changes LGTM. Code review only

sabarasaba

deployment management changes lgtm!

stratoula

Thanx for your work here Alejandro! Visualizations team numerous plugins changes LGTM 😄

cnasikas

ResponseOps changes LGTM!

kc13greiner

Kb Security changes LGTM!

e40pud

DE changes LGTM!

robbavey

Logstash changes LGTM

logeekal

Desk tested security solution and timelines. Both working well. LGTM 🚀

michaelolo24

Looks great, thanks @afharo !

PhilippeOberti

LGTM for Protections Experience team :)

kibana-ci · 2023-11-14T21:06:44Z

💛 Build succeeded, but was flaky

Failed CI Steps

Jest Tests #19

Metrics [docs]

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
`mapsEms`	68	60	-8

Unknown metric groups

API count

id	before	after	diff
`mapsEms`	68	60	-8

History

💔 Build #175809 failed fca5b21
💔 Build #175749 failed cce6d38
💚 Build #175134 succeeded a7038ae
💚 Build #174933 succeeded 0404c34

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

cc @afharo

…1275) ## Summary Fixes type error coming from merge-race: #170852 - adds a new plugin #170856 - changes how plugins should look

afharo and others added 12 commits November 8, 2023 13:43

async-import plugins in the server side

9b0e13a

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

583d1fd

…fix'

Revert browser-side types

ff31906

Fix unit tests

faaa57a

Fix mocks

56c9f76

Fix x-pack/examples

277d105

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

74a2dad

…fix'

Fix jest tests

4331b38

Revert changes in /public/

862e41e

Fix another jest test

2790387

Merge branch 'main' into plugins-async-import

77b109f

HTTP Status FTRs should wait for Kibana to accept requests

0404c34

afharo marked this pull request as ready for review November 10, 2023 15:14

afharo requested review from a team as code owners November 10, 2023 15:14

afharo requested a review from a team November 10, 2023 15:14

afharo requested review from a team as code owners November 10, 2023 15:14

afharo requested a review from a team November 10, 2023 15:14

afharo requested review from a team as code owners November 10, 2023 15:14

ymao1 approved these changes Nov 13, 2023

View reviewed changes

sabarasaba approved these changes Nov 13, 2023

View reviewed changes

neptunian approved these changes Nov 13, 2023

View reviewed changes

kc13greiner self-requested a review November 13, 2023 14:29

stratoula approved these changes Nov 13, 2023

View reviewed changes

cnasikas approved these changes Nov 13, 2023

View reviewed changes

kc13greiner approved these changes Nov 13, 2023

View reviewed changes

e40pud approved these changes Nov 14, 2023

View reviewed changes

robbavey approved these changes Nov 14, 2023

View reviewed changes

logeekal approved these changes Nov 14, 2023

View reviewed changes

michaelolo24 approved these changes Nov 14, 2023

View reviewed changes

PhilippeOberti approved these changes Nov 14, 2023

View reviewed changes

Merge branch 'main' into plugins-async-import

cce6d38

afharo enabled auto-merge (squash) November 14, 2023 14:48

afharo added 2 commits November 14, 2023 17:16

Merge branch 'main' into plugins-async-import

fca5b21

Merge branch 'main' into plugins-async-import

1e61fce

pgayvallet removed request for dasansol92, tomsonpl and yctercero November 15, 2023 07:22

afharo merged commit fd09c26 into elastic:main Nov 15, 2023

afharo deleted the plugins-async-import branch November 15, 2023 07:55

kibanamachine added the v8.12.0 label Nov 15, 2023

delanni mentioned this pull request Nov 15, 2023

fix type error coming from race condition on plugin type changes #171275

Merged

delanni added a commit that referenced this pull request Nov 15, 2023

fix type error coming from race condition on plugin type changes (#17…

dcc478e

…1275) ## Summary Fixes type error coming from merge-race: #170852 - adds a new plugin #170856 - changes how plugins should look

afharo mentioned this pull request Nov 15, 2023

Load and initialize all plugins concurrently #171322

Closed

1 task

logeekal mentioned this pull request Nov 16, 2023

DO NOT MERGE - Timeline New UI + Modal + Unified components #171385

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

async-import plugins in the server side#170856

async-import plugins in the server side#170856
afharo merged 16 commits intoelastic:mainfrom
afharo:plugins-async-import

afharo commented Nov 8, 2023 •

edited

Loading

Uh oh!

afharo commented Nov 13, 2023

Uh oh!

ymao1 left a comment

Uh oh!

sabarasaba left a comment

Uh oh!

stratoula left a comment

Uh oh!

cnasikas left a comment

Uh oh!

kc13greiner left a comment

Uh oh!

e40pud left a comment

Uh oh!

robbavey left a comment

Uh oh!

logeekal left a comment

Uh oh!

michaelolo24 left a comment

Uh oh!

PhilippeOberti left a comment

Uh oh!

kibana-ci commented Nov 14, 2023 •

edited

Loading

API count

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

Conversation

afharo commented Nov 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Risk Matrix

For maintainers

Uh oh!

afharo commented Nov 13, 2023

Uh oh!

ymao1 left a comment

Choose a reason for hiding this comment

Uh oh!

sabarasaba left a comment

Choose a reason for hiding this comment

Uh oh!

stratoula left a comment

Choose a reason for hiding this comment

Uh oh!

cnasikas left a comment

Choose a reason for hiding this comment

Uh oh!

kc13greiner left a comment

Choose a reason for hiding this comment

Uh oh!

e40pud left a comment

Choose a reason for hiding this comment

Uh oh!

robbavey left a comment

Choose a reason for hiding this comment

Uh oh!

logeekal left a comment

Choose a reason for hiding this comment

Uh oh!

michaelolo24 left a comment

Choose a reason for hiding this comment

Uh oh!

PhilippeOberti left a comment

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented Nov 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Public APIs missing comments

API count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

afharo commented Nov 8, 2023 •

edited

Loading

kibana-ci commented Nov 14, 2023 •

edited

Loading