Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[shared-ux][packages] 1. Create Services Package #127544

Conversation

clintandrewhall
Copy link
Contributor

Summary

This is a subset of the work in #127419 for ease of review and commit history.

This PR refactors the Shared UX services to be stateless and free of dependency, and moves them from the shared_ux plugin to a package.

Why?

With only a few components, we've run into issues with circular dependencies. Our plugin is consuming code and types from other plugins, and once we do, those plugins can't use our plugin or its components. To mitigate this, we need to keep Shared UX as stateless and dependency free as possible.

Talking with ops, it became clear our assets don't actually need a plugin lifecycle to operate. This PR is one step in decoupling our components, services and utilities to packages.

TODO

  • Complete .mdx documentation.
  • File an issue to track TS unknown types, pending dependent teams moving their types to packages.
    • @elastic/kibana-app-services - DataView from src/plugins/data_views

@clintandrewhall clintandrewhall added review loe:medium Medium Level of Effort release_note:skip Skip the PR/issue when compiling release notes impact:critical This issue should be addressed immediately due to a critical level of impact on the product. v8.2.0 Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) labels Mar 11, 2022
@clintandrewhall clintandrewhall requested a review from a team March 11, 2022 20:36
@clintandrewhall clintandrewhall force-pushed the shared_ux/packages/services branch 2 times, most recently from 51edf7c to 07a7820 Compare March 11, 2022 20:50
@clintandrewhall
Copy link
Contributor Author

Replaced by: #127546

@kibana-ci
Copy link
Collaborator

kibana-ci commented Mar 11, 2022

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] Jest Tests #2 / is rendered
  • [job] [logs] Jest Tests #2 / is rendered
  • [job] [logs] Default CI Group #15 / machine learning data frame analytics outlier detection saved search creation with lucene query navigates through the wizard and sets all needed fields

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
sharedUX 49 56 +7

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
@kbn/shared-ux-services - 27 +27

Async chunks

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

id before after diff
sharedUX 100.7KB 100.7KB +7.0B

Page load bundle

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

id before after diff
sharedUX 4.8KB 5.0KB +218.0B
Unknown metric groups

API count

id before after diff
@kbn/shared-ux-services - 47 +47

History

  • 💔 Build #29746 failed 6f2c624b445ea2d9be43c1c69a0527299bedec7b

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:critical This issue should be addressed immediately due to a critical level of impact on the product. loe:medium Medium Level of Effort release_note:skip Skip the PR/issue when compiling release notes review Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants