hey, Kibana experts
I'm experiencing an issue where external plugins are not able to run within Kibana Docker images. I have followed the necessary steps to set up an empty plugin using an open GraphQL API, the latest version of the GraphQL library, and Apollo Client. The plugin works as expected when running Kibana in my development environment using "yarn kbn bootstrap," "yarn start" on Kibana, and "yarn dev" for the plugin.
However, when I build the external plugin using "yarn build" and try to install it on a Kibana Docker image, the plugin fails to render, and I encounter errors in the console. To reproduce the issue, you can refer to the following repository: GitHub - brenoandrade-wdrv/kibana-8.8.0-graphql-issue at 8.8.0
Refer to the screenshots:
opened 03:47PM - 08 Jun 23 UTC
bug
needs-team
**Kibana version:**
8.8.0
**Elasticsearch version:**
8.8.0
**Server OS v… ersion:**
docker.elastic.co/kibana/kibana:8.8.0
**Browser version:**
Google Chrome - Version 114.0.5735.90 (Official Build) (64-bit)
**Original install method (e.g. download page, yum, from source, etc.):**
- From source to develop the Plugin
- From docker images to build the Plugin
**Describe the bug:**
I'm experiencing an issue where external plugins are not able to run within Kibana Docker images. I have followed the necessary steps to set up an empty plugin using an open GraphQL API, the latest version of the GraphQL library, and Apollo Client. The plugin works as expected when running Kibana in my development environment using "yarn kbn bootstrap," "yarn start" on Kibana, and "yarn dev" for the plugin.
However, when I build the external plugin using "yarn build" and try to install it on a Kibana Docker image, the plugin fails to render, and I encounter errors in the console.
**Steps to reproduce:**
1. Generate a new plugin using this doc: https://www.elastic.co/guide/en/kibana/current/plugin-tooling.html (turn on the UI and the server)
2. Go to the plugin directory and install the latest graphQL/apollo-client library
3. Implement a simple query to approach these libraries (using an open graphQL API as I've done on: https://github.com/brenoandrade-wdrv/graphql-plugin-example)
4. Go to the Kibana directory and "yarn kbn bootstrap / yarn start" pointing out your config/kibana.dev.yaml to your Elastic Search test server
5. Go to the plugin directory and "yarn dev" to get the plugin UP in the development environment
6. Test your plugin - You'll see that it works properly.
7. Go to the plugin directory and "yarn build"
8. Pick up your ".zip" plugin and manage a Docker build in order to install the plugin using a production environment as I've done on: https://github.com/brenoandrade-wdrv/kibana-8.8.0-graphql-issue/tree/8.8.0
9. Launching the Kibana from this docker build I'll see that the plugin is not going to be rendered such as the screenshot I sent below.
The same approach works successfully on Kibana version 8.6.2, as demonstrated in this repository: https://github.com/brenoandrade-wdrv/kibana-8.8.0-graphql-issue/tree/8.6.2
**Expected behavior:**
The external plugins must build correctly and works properly under Kibana docker images.
**Screenshots (if relevant):**
**Errors in browser console (if relevant):**
core.entry.js:1 TypeError: Cannot read properties of undefined (reading 'call')
at o (kbn-ui-shared-deps-npm.dll.js:1:388)
at Object.<anonymous> (wind.chunk.1.js:1:114734)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:62027)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:284050)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:14866)
at o (wind.plugin.js:1:361)
at Module.<anonymous> (wind.chunk.1.js:1:399478)
**Provide logs and/or server output (if relevant):**
No logs under Kibana's image
**Any additional context:**
Upon investigating, I noticed the following commit in the Kibana repository, which might be the cause of the issue:
https://github.com/elastic/kibana/commit/afb09ccf8a61d610e8e3d8beb2c80f413f1b33c5#diff-02f96629c94b9164218c1786e6b260cb8a8a812afd4d65da58bda429b3776b89
I am unsure whether this commit is related to the problem, but it appears suspicious.
I kindly request assistance in resolving this issue to enable the proper functioning of external plugins (using third-party libraries) within Kibana production envs.
core.entry.js:1 TypeError: Cannot read properties of undefined (reading 'call')
The same approach works successfully on Kibana version 8.6.2, as demonstrated in this repository: GitHub - brenoandrade-wdrv/kibana-8.8.0-graphql-issue at 8.6.2
Upon investigating, I noticed the following commit in the Kibana repository, which might be the cause of the issue:
committed 01:00AM - 23 Dec 22 UTC
## Dearest Reviewers 👋
I've been working on this branch with @mistic and @ty… lersmalley and
we're really confident in these changes. Additionally, this changes code
in nearly every package in the repo so we don't plan to wait for reviews
to get in before merging this. If you'd like to have a concern
addressed, please feel free to leave a review, but assuming that nobody
raises a blocker in the next 24 hours we plan to merge this EOD pacific
tomorrow, 12/22.
We'll be paying close attention to any issues this causes after merging
and work on getting those fixed ASAP. 🚀
---
The operations team is not confident that we'll have the time to achieve
what we originally set out to accomplish by moving to Bazel with the
time and resources we have available. We have also bought ourselves some
headroom with improvements to babel-register, optimizer caching, and
typescript project structure.
In order to make sure we deliver packages as quickly as possible (many
teams really want them), with a usable and familiar developer
experience, this PR removes Bazel for building packages in favor of
using the same JIT transpilation we use for plugins.
Additionally, packages now use `kbn_references` (again, just copying the
dx from plugins to packages).
Because of the complex relationships between packages/plugins and in
order to prepare ourselves for automatic dependency detection tools we
plan to use in the future, this PR also introduces a "TS Project Linter"
which will validate that every tsconfig.json file meets a few
requirements:
1. the chain of base config files extended by each config includes
`tsconfig.base.json` and not `tsconfig.json`
1. the `include` config is used, and not `files`
2. the `exclude` config includes `target/**/*`
3. the `outDir` compiler option is specified as `target/types`
1. none of these compiler options are specified: `declaration`,
`declarationMap`, `emitDeclarationOnly`, `skipLibCheck`, `target`,
`paths`
4. all references to other packages/plugins use their pkg id, ie:
```js
// valid
{
"kbn_references": ["@kbn/core"]
}
// not valid
{
"kbn_references": [{ "path": "../../../src/core/tsconfig.json" }]
}
```
5. only packages/plugins which are imported somewhere in the ts code are
listed in `kbn_references`
This linter is not only validating all of the tsconfig.json files, but
it also will fix these config files to deal with just about any
violation that can be produced. Just run `node scripts/ts_project_linter
--fix` locally to apply these fixes, or let CI take care of
automatically fixing things and pushing the changes to your PR.
> **Example:** [`64e93e5`
(#146212)](https://github.com/elastic/kibana/pull/146212/commits/64e93e580679dd55f4fdf19bd01402bc478a1a75)
When I merged main into my PR it included a change which removed the
`@kbn/core-injected-metadata-browser` package. After resolving the
conflicts I missed a few tsconfig files which included references to the
now removed package. The TS Project Linter identified that these
references were removed from the code and pushed a change to the PR to
remove them from the tsconfig.json files.
## No bazel? Does that mean no packages??
Nope! We're still doing packages but we're pretty sure now that we won't
be using Bazel to accomplish the 'distributed caching' and 'change-based
tasks' portions of the packages project.
This PR actually makes packages much easier to work with and will be
followed up with the bundling benefits described by the original
packages RFC. Then we'll work on documentation and advocacy for using
packages for any and all new code.
We're pretty confident that implementing distributed caching and
change-based tasks will be necessary in the future, but because of
recent improvements in the repo we think we can live without them for
**at least** a year.
## Wait, there are still BUILD.bazel files in the repo
Yes, there are still three webpack bundles which are built by Bazel: the
`@kbn/ui-shared-deps-npm` DLL, `@kbn/ui-shared-deps-src` externals, and
the `@kbn/monaco` workers. These three webpack bundles are still created
during bootstrap and remotely cached using bazel. The next phase of this
project is to figure out how to get the package bundling features
described in the RFC with the current optimizer, and we expect these
bundles to go away then. Until then any package that is used in those
three bundles still needs to have a BUILD.bazel file so that they can be
referenced by the remaining webpack builds.
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
I am unsure whether this commit is related to the problem, but it appears suspicious.
I kindly request assistance in resolving this issue to enable the proper functioning of external plugins (using third-party libraries) within Kibana production envs.
Much appreciated
The issue is related to the NODE_ENV environment stuff.
From this change:
committed 01:00AM - 23 Dec 22 UTC
## Dearest Reviewers 👋
I've been working on this branch with @mistic and @ty… lersmalley and
we're really confident in these changes. Additionally, this changes code
in nearly every package in the repo so we don't plan to wait for reviews
to get in before merging this. If you'd like to have a concern
addressed, please feel free to leave a review, but assuming that nobody
raises a blocker in the next 24 hours we plan to merge this EOD pacific
tomorrow, 12/22.
We'll be paying close attention to any issues this causes after merging
and work on getting those fixed ASAP. 🚀
---
The operations team is not confident that we'll have the time to achieve
what we originally set out to accomplish by moving to Bazel with the
time and resources we have available. We have also bought ourselves some
headroom with improvements to babel-register, optimizer caching, and
typescript project structure.
In order to make sure we deliver packages as quickly as possible (many
teams really want them), with a usable and familiar developer
experience, this PR removes Bazel for building packages in favor of
using the same JIT transpilation we use for plugins.
Additionally, packages now use `kbn_references` (again, just copying the
dx from plugins to packages).
Because of the complex relationships between packages/plugins and in
order to prepare ourselves for automatic dependency detection tools we
plan to use in the future, this PR also introduces a "TS Project Linter"
which will validate that every tsconfig.json file meets a few
requirements:
1. the chain of base config files extended by each config includes
`tsconfig.base.json` and not `tsconfig.json`
1. the `include` config is used, and not `files`
2. the `exclude` config includes `target/**/*`
3. the `outDir` compiler option is specified as `target/types`
1. none of these compiler options are specified: `declaration`,
`declarationMap`, `emitDeclarationOnly`, `skipLibCheck`, `target`,
`paths`
4. all references to other packages/plugins use their pkg id, ie:
```js
// valid
{
"kbn_references": ["@kbn/core"]
}
// not valid
{
"kbn_references": [{ "path": "../../../src/core/tsconfig.json" }]
}
```
5. only packages/plugins which are imported somewhere in the ts code are
listed in `kbn_references`
This linter is not only validating all of the tsconfig.json files, but
it also will fix these config files to deal with just about any
violation that can be produced. Just run `node scripts/ts_project_linter
--fix` locally to apply these fixes, or let CI take care of
automatically fixing things and pushing the changes to your PR.
> **Example:** [`64e93e5`
(#146212)](https://github.com/elastic/kibana/pull/146212/commits/64e93e580679dd55f4fdf19bd01402bc478a1a75)
When I merged main into my PR it included a change which removed the
`@kbn/core-injected-metadata-browser` package. After resolving the
conflicts I missed a few tsconfig files which included references to the
now removed package. The TS Project Linter identified that these
references were removed from the code and pushed a change to the PR to
remove them from the tsconfig.json files.
## No bazel? Does that mean no packages??
Nope! We're still doing packages but we're pretty sure now that we won't
be using Bazel to accomplish the 'distributed caching' and 'change-based
tasks' portions of the packages project.
This PR actually makes packages much easier to work with and will be
followed up with the bundling benefits described by the original
packages RFC. Then we'll work on documentation and advocacy for using
packages for any and all new code.
We're pretty confident that implementing distributed caching and
change-based tasks will be necessary in the future, but because of
recent improvements in the repo we think we can live without them for
**at least** a year.
## Wait, there are still BUILD.bazel files in the repo
Yes, there are still three webpack bundles which are built by Bazel: the
`@kbn/ui-shared-deps-npm` DLL, `@kbn/ui-shared-deps-src` externals, and
the `@kbn/monaco` workers. These three webpack bundles are still created
during bootstrap and remotely cached using bazel. The next phase of this
project is to figure out how to get the package bundling features
described in the RFC with the current optimizer, and we expect these
bundles to go away then. Until then any package that is used in those
three bundles still needs to have a BUILD.bazel file so that they can be
referenced by the remaining webpack builds.
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
They've kept the packages: 'kbn-ui-shared-deps-npm' and 'kbn-ui-shared-deps-src ' using bazel and they've managed the webpack modules by applying the NODE_ENV environment variable .
Not sure how to manage this, I've tried to manage on Dockerfiles before installing the plugin and it hasn't worked.
By reverting the webpack.config.js under those Kibana packages and building the plugin I've got the plugin working again:
How should external plugins approach this environment in order to ship Kibana?
opened 03:47PM - 08 Jun 23 UTC
bug
Team:Core
Team:Operations
**Kibana version:**
8.8.0
**Elasticsearch version:**
8.8.0
**Server OS v… ersion:**
docker.elastic.co/kibana/kibana:8.8.0
**Browser version:**
Google Chrome - Version 114.0.5735.90 (Official Build) (64-bit)
**Original install method (e.g. download page, yum, from source, etc.):**
- From source to develop the Plugin
- From docker images to build the Plugin
**Describe the bug:**
I'm experiencing an issue where external plugins are not able to run within Kibana Docker images. I have followed the necessary steps to set up an empty plugin using an open GraphQL API, the latest version of the GraphQL library, and Apollo Client. The plugin works as expected when running Kibana in my development environment using "yarn kbn bootstrap," "yarn start" on Kibana, and "yarn dev" for the plugin.
However, when I build the external plugin using "yarn build" and try to install it on a Kibana Docker image, the plugin fails to render, and I encounter errors in the console.
**Steps to reproduce:**
1. Generate a new plugin using this doc: https://www.elastic.co/guide/en/kibana/current/plugin-tooling.html (turn on the UI and the server)
2. Go to the plugin directory and install the latest graphQL/apollo-client library
3. Implement a simple query to approach these libraries (using an open graphQL API as I've done on: https://github.com/brenoandrade-wdrv/graphql-plugin-example)
4. Go to the Kibana directory and "yarn kbn bootstrap / yarn start" pointing out your config/kibana.dev.yaml to your Elastic Search test server
5. Go to the plugin directory and "yarn dev" to get the plugin UP in the development environment
6. Test your plugin - You'll see that it works properly.
7. Go to the plugin directory and "yarn build"
8. Pick up your ".zip" plugin and manage a Docker build in order to install the plugin using a production environment as I've done on: https://github.com/brenoandrade-wdrv/kibana-8.8.0-graphql-issue/tree/8.8.0
9. Launching the Kibana from this docker build I'll see that the plugin is not going to be rendered such as the screenshot I sent below.
The same approach works successfully on Kibana version 8.6.2, as demonstrated in this repository: https://github.com/brenoandrade-wdrv/kibana-8.8.0-graphql-issue/tree/8.6.2
**Expected behavior:**
The external plugins must build correctly and works properly under Kibana docker images.
**Screenshots (if relevant):**
**Errors in browser console (if relevant):**
core.entry.js:1 TypeError: Cannot read properties of undefined (reading 'call')
at o (kbn-ui-shared-deps-npm.dll.js:1:388)
at Object.<anonymous> (wind.chunk.1.js:1:114734)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:62027)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:284050)
at o (wind.plugin.js:1:361)
at Object.<anonymous> (wind.chunk.1.js:1:14866)
at o (wind.plugin.js:1:361)
at Module.<anonymous> (wind.chunk.1.js:1:399478)
**Provide logs and/or server output (if relevant):**
No logs under Kibana's image
**Any additional context:**
Upon investigating, I noticed the following commit in the Kibana repository, which might be the cause of the issue:
https://github.com/elastic/kibana/commit/afb09ccf8a61d610e8e3d8beb2c80f413f1b33c5#diff-02f96629c94b9164218c1786e6b260cb8a8a812afd4d65da58bda429b3776b89
I am unsure whether this commit is related to the problem, but it appears suspicious.
I kindly request assistance in resolving this issue to enable the proper functioning of external plugins (using third-party libraries) within Kibana production envs.
The fix will be available on Kibana 8.9.0
system
July 12, 2023, 8:09pm
4
This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.
