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

Sustainable Kibana Architecture: Move modules owned by @elastic/observability-ui #202834

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

gsoldevila
Copy link
Contributor

@gsoldevila gsoldevila commented Dec 3, 2024

Summary

This PR aims at relocating some of the Kibana modules (plugins and packages) into a new folder structure, according to the Sustainable Kibana Architecture initiative.

Important

  • We kindly ask you to:
    • Manually fix the errors in the error section below (if there are any).
    • Search for the packages[\/\\] and plugins[\/\\] patterns in the source code (Babel and Eslint config files), and update them appropriately.
    • Manually review .buildkite/scripts/pipelines/pull_request/pipeline.ts to ensure that any CI pipeline customizations continue to be correctly applied after the changed path names
    • Review all of the updated files, specially the .ts and .js files listed in the sections below, as some of them contain relative paths that have been updated.
    • Think of potential impact of the move, including tooling and configuration files that can be pointing to the relocated modules. E.g.:
      • customised eslint rules
      • docs pointing to source code

Note

  • This PR has been auto-generated.
  • Any manual contributions will be lost if the 'relocate' script is re-run.
  • Try to obtain the missing reviews / approvals before applying manual fixes, and/or keep your changes in a .patch / git stash.
  • Please use #sustainable_kibana_architecture Slack channel for feedback.

Are you trying to rebase this PR to solve merge conflicts? Please follow the steps describe here.

1 plugin(s) are going to be relocated:

Id Target folder
@kbn/observability-shared-plugin x-pack/solutions/observability/plugins/observability_shared

3 packages(s) are going to be relocated:

Id Target folder
@kbn/observability-utils-browser x-pack/solutions/observability/packages/utils_browser
@kbn/observability-utils-common x-pack/solutions/observability/packages/utils_common
@kbn/observability-utils-server x-pack/solutions/observability/packages/utils_server
Updated references
./docs/developer/plugin-list.asciidoc
./package.json
./packages/kbn-repo-packages/package-map.json
./packages/kbn-ts-projects/config-paths.json
./src/dev/storybook/aliases.ts
./tsconfig.base.json
./tsconfig.base.type_check.json
./tsconfig.refs.json
./x-pack/.i18nrc.json
./x-pack/solutions/observability/packages/utils_browser/jest.config.js
./x-pack/solutions/observability/packages/utils_common/jest.config.js
./x-pack/solutions/observability/packages/utils_server/jest.config.js
./x-pack/solutions/observability/plugins/observability_shared/jest.config.js
./x-pack/test/tsconfig.type_check.json
./yarn.lock
.github/CODEOWNERS
Updated relative paths
x-pack/solutions/observability/packages/utils_browser/jest.config.js:10
x-pack/solutions/observability/packages/utils_browser/tsconfig.json:2
x-pack/solutions/observability/packages/utils_common/jest.config.js:10
x-pack/solutions/observability/packages/utils_common/tsconfig.json:2
x-pack/solutions/observability/packages/utils_server/jest.config.js:10
x-pack/solutions/observability/packages/utils_server/tsconfig.json:2
x-pack/solutions/observability/plugins/observability_shared/jest.config.js:10
x-pack/solutions/observability/plugins/observability_shared/tsconfig.json:12
x-pack/solutions/observability/plugins/observability_shared/tsconfig.json:2
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:102
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:105
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:108
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:111
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:114
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:14
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:21
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:24
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:27
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:30
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:33
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:36
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:39
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:42
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:45
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:48
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:51
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:54
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:57
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:60
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:63
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:66
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:69
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:72
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:75
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:78
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:81
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:84
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:87
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:90
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:93
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:96
x-pack/solutions/observability/plugins/observability_shared/tsconfig.type_check.json:99

Copy link
Contributor

github-actions bot commented Dec 3, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@gsoldevila gsoldevila added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Unified observability labels Dec 4, 2024
@gsoldevila gsoldevila marked this pull request as ready for review December 4, 2024 08:31
@gsoldevila gsoldevila requested review from a team as code owners December 4, 2024 08:31
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@elasticmachine
Copy link
Contributor

Pinging @elastic/unified-observability (Team:Unified observability)

@shahzad31
Copy link
Contributor

x-pack/solutions/observability/packages/observability/observability_utils/observability_utils_browser

i find it weird that word observability is used 4 times in this dir structure

@weltenwort
Copy link
Member

💭 this might cause conflicts with open PRs that change observability_shared, such as #201263, which tries to clean up dependencies

@gsoldevila gsoldevila force-pushed the kbn-team-1309-move-kibana-observability-ui branch from e0fd1ac to 21a0527 Compare December 10, 2024 14:35
@botelastic botelastic bot added the ci:project-deploy-observability Create an Observability project label Dec 10, 2024
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@crespocarlos crespocarlos self-requested a review December 16, 2024 15:46
@gsoldevila gsoldevila force-pushed the kbn-team-1309-move-kibana-observability-ui branch from 0ab8693 to fe143a1 Compare December 17, 2024 15:46
Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Core changes LGTM

@rudolf rudolf added the plugin groups Relocate all plugins and packages under their respective platform/solution groups label Dec 18, 2024
@dokmic dokmic force-pushed the kbn-team-1309-move-kibana-observability-ui branch from f7ef92d to f70c6b7 Compare December 18, 2024 19:43
@gsoldevila gsoldevila force-pushed the kbn-team-1309-move-kibana-observability-ui branch from f70c6b7 to e8fac5a Compare December 23, 2024 13:21
@gsoldevila
Copy link
Contributor Author

i find it weird that word observability is used 4 times in this dir structure

I simplified the target folder structure (see updated PR description).

@gsoldevila gsoldevila force-pushed the kbn-team-1309-move-kibana-observability-ui branch from e40e88f to 0eb283c Compare December 23, 2024 16:33
@gsoldevila gsoldevila added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed backport:skip This commit does not require backporting labels Dec 23, 2024
@elasticmachine
Copy link
Contributor

elasticmachine commented Dec 24, 2024

💚 Build Succeeded

Metrics [docs]

Page load bundle

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

id before after diff
observabilityShared 93.9KB 93.9KB -1.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
observabilityShared 14 13 -1

Total ESLint disabled count

id before after diff
observabilityShared 15 14 -1

History

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) ci:project-deploy-observability Create an Observability project plugin groups Relocate all plugins and packages under their respective platform/solution groups release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Team:Unified observability
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants