Prefer third-party plugin development in ./plugins instead of ../kibana-extra #31748

eliperelman · 2019-02-21T21:40:17Z

Summary

This change switches preferred third-party plugin development from ../kibana-extra, instead favoring the plugins directory in the Kibana root. Relatedly this also renames the @kbn/pm --skip-kibana-extra to --skip-kibana-plugins.

Removing this directory and renaming the flag appear to be breaking changes, so I tagged this one as v8.0.0. Please revise if this is inaccurate.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~This was checked for cross-browser compatibility, including a check against IE11~~
~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

Dev-Docs

Prefer third-party plugin development in `plugins` instead of `kibana-extra`

This change switches preferred third-party plugin development from ../kibana-extra, instead favoring the plugins directory in the Kibana root. By association, @kbn/pm has the --skip-kibana-extra flag renamed to --skip-kibana-plugins.

elasticmachine · 2019-02-21T21:40:20Z

Pinging @elastic/kibana-platform

trevan · 2019-02-21T22:00:02Z

I don't know the reason for this change but this feels like it could cause problems. Usually, a plugin will be in its own separate git repository and so you'll have a git repository (the plugin) inside of another git repository (kibana).

elasticmachine · 2019-02-21T22:26:12Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

epixa · 2019-02-21T22:45:39Z

@trevan The motivation for the change is that we want plugins to be able to reliably and consistently import static code from other plugins. Webpack aliases allow us to do this reliably on the client, but it's not consist since we can't use them on the server. Relative imports are a consistent way to do it, but they are only reliable if the relative location of plugins is similar between development and builds.

The root plugins directory has its contents hidden from git, so you should be able to safely check out your plugin repo into that directory.

epixa · 2019-02-22T14:41:32Z

@eliperelman Can you add a section to the PR description for Dev Docs that describes the change for plugin developers? We extract the content from that section and publish it in a blog post for plugin developers for each release.

trevan · 2019-02-22T15:35:01Z

@epixa, is it possible to symlink your plugin into the plugins directory for development? I tried that back in the 5.x days and there were some issues I had but maybe the later node/babel/webpack/etc can handle that now.

epixa · 2019-02-22T16:00:08Z

That's a great question, and I don't know the answer. @eliperelman can you check that out?

If it is possible, or if it's easy to make it possible, then we can say that the recommended workflow is to clone your plugin repo inside /plugins, but you can always symlink your plugin directory in if you prefer to work elsewhere (e.g. in kibana-extra or as a sibling to kibana).

eliperelman · 2019-02-22T17:26:17Z

I have updated the tests here to ensure that plugins symlinked into plugins work properly, and they do. 😃

trevan · 2019-02-22T17:31:23Z

@eliperelman, the issues I had dealt with importing code into the symlinked plugin. The file paths for importing didn't respect the symlink unless I had NODE_PRESERVE_SYMLINKS enabled and even then, there were weird issues.

w33ble · 2019-02-22T17:57:36Z

The motivation for the change is that we want plugins to be able to reliably and consistently import static code from other plugins.

@epixa Interesting, I thought we were trying to explicitly avoid that in the New Platform and forcing plugins to expose the parts they intended to share. Did that change, or has my understanding just been wrong?

elasticmachine · 2019-02-22T18:09:13Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

epixa · 2019-02-22T18:46:26Z

@w33ble That is definitely still the desired route in the new platform, and I expect the static code sharing to be rare. But when it does need to happen, I don't want plugin authors to hack together a solution or be in a situation where some things work in oss but not in x-pack.

eliperelman · 2019-02-26T17:41:32Z

@azasypkin I have updated the PR to programmatically create the symlink which should work on Windows in the future.

elasticmachine · 2019-02-26T18:30:18Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

packages/kbn-pm/src/utils/projects.test.ts

elasticmachine · 2019-02-26T21:15:00Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

eliperelman · 2019-02-26T21:19:25Z

retest

elasticmachine · 2019-02-26T22:05:09Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

epixa · 2019-03-05T15:12:18Z

@eliperelman Sorry for the churn here, but I've had a little bit of a change of heart and wanted to get your thoughts. I think we should update all the instructions as you did here and add the support for running in the plugins directory as planned, but we should preserve the existing support for plugins being developed in kibana-extra for a little while to give developers some time to switch over.

Anyone developing in kibana-extra wouldn't be able to reliably do relative imports and whatnot, but that's fine.

What do you think?

eliperelman · 2019-03-05T15:40:32Z

Sure thing, I’ll see what I can do.

eliperelman · 2019-03-05T18:23:10Z

@epixa I have revised, please let me know if you believe this is the correct direction based on your comments. Thanks!

elasticmachine · 2019-03-05T18:53:18Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-03-05T22:16:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

epixa

This looks good overall, but when you make changes to kbn-pm, you also must build a new distribution of it and commit that. It's the only package that requires this. See https://github.com/elastic/kibana/tree/master/packages/kbn-pm#development

epixa

LGTM on green

elasticmachine · 2019-03-06T22:31:52Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

eliperelman · 2019-03-06T22:42:00Z

retest

elasticmachine · 2019-03-06T23:33:47Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-03-07T19:01:33Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-03-07T21:43:59Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…na-extra (elastic#31748) * Prefer third-party plugin development in plugins instead of kibana-extra * Fix failing recursive directory creation and removal * Add new built version of kbn-pm

…na-extra (#31748) (#32724) * Prefer third-party plugin development in plugins instead of kibana-extra * Fix failing recursive directory creation and removal * Add new built version of kbn-pm

martijnrondeel · 2019-06-27T09:28:21Z

Should starting Kibana from inside a plugin in the plugins directory be working? I'm getting the following error:

yarn start
yarn run v1.16.0
$ plugin-helpers start
Task "start" failed:

Error: spawnSync node ENOENT
    at Object.spawnSync (internal/child_process.js:990:20)
    at spawnSync (child_process.js:601:24)
    at execFileSync (child_process.js:629:13)
    at module.exports (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/tasks/start/start_action.js:43:3)
    at run (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/run.js:30:10)
    at Command.<anonymous> (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/commander_action.js:27:13)
    at Command.listener (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:315:8)
    at Command.emit (events.js:189:13)
    at Command.parseArgs (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:654:12)
    at Command.parse (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:474:21)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Also adding "kibanaRoot": "../../" to .kibana-plugin-helpers.json (which I found solved this issue in past releases) yields the following (outdated) error message:

yarn start
yarn run v1.16.0
$ plugin-helpers start
Task "start" failed:

Error: The `kibanaRoot` config option has been removed from `@kbn/plugin-helpers`. During development your plugin must be located in `../kibana-extra/{pluginName}` relative to the Kibana directory to work with this package.

    at module.exports (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/config_file.js:54:11)
    at module.exports (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/plugin_config.js:28:18)
    at run (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/run.js:29:18)
    at Command.<anonymous> (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/lib/commander_action.js:27:13)
    at Command.listener (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:315:8)
    at Command.emit (events.js:189:13)
    at Command.parseArgs (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:654:12)
    at Command.parse (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/node_modules/commander/index.js:474:21)
    at Object.<anonymous> (/home/martijn/Repos/kibana/packages/kbn-plugin-helpers/cli.js:93:9)
    at Module._compile (internal/modules/cjs/loader.js:689:30)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Running yarn start from the Kibana directory does work, but I rather have my plugin dir open in the IDE instead of Kibana and this worked in the past.

eliperelman added review Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:New Platform v8.0.0 labels Feb 21, 2019

eliperelman self-assigned this Feb 21, 2019

eliperelman requested a review from epixa February 21, 2019 21:40

eliperelman requested a review from a team as a code owner February 21, 2019 21:40

epixa added Feature:Plugins release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. labels Feb 22, 2019

epixa added the v7.2.0 label Feb 24, 2019

mshustov reviewed Feb 26, 2019

View reviewed changes

packages/kbn-pm/src/utils/projects.test.ts Outdated Show resolved Hide resolved

epixa removed the review label Mar 5, 2019

eliperelman force-pushed the move-from-extra-to-plugins branch 2 times, most recently from 8969b14 to 3acd6e1 Compare March 5, 2019 18:20

eliperelman added the review label Mar 5, 2019

eliperelman changed the title ~~Remove third-party plugin development from kibana-extra in favor of plugins/~~ Prefer third-party plugin development in ./plugins instead of ../kibana-extra Mar 6, 2019

epixa reviewed Mar 6, 2019

View reviewed changes

epixa approved these changes Mar 6, 2019

View reviewed changes

eliperelman force-pushed the move-from-extra-to-plugins branch from a8c5755 to ca8b094 Compare March 7, 2019 15:59

eliperelman added 3 commits March 7, 2019 14:56

Prefer third-party plugin development in plugins instead of kibana-extra

e34eff5

Fix failing recursive directory creation and removal

c31584d

Add new built version of kbn-pm

bff5527

eliperelman force-pushed the move-from-extra-to-plugins branch from ca8b094 to bff5527 Compare March 7, 2019 20:56

eliperelman merged commit 78cbe42 into elastic:master Mar 7, 2019

eliperelman mentioned this pull request Mar 7, 2019

[7.x] Prefer third-party plugin development in ./plugins instead of ../kibana-extra (#31748) #32724

Merged

peterschretlen mentioned this pull request Jul 17, 2019

Plugin generator gives incorrect plugin.kibanaRoot on yarn start #40272

Closed

mistic mentioned this pull request Aug 5, 2019

chore(NA): correctly set kibanaRoot on kibana plugin helpers for new generated plugins #42616

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prefer third-party plugin development in ./plugins instead of ../kibana-extra #31748

Prefer third-party plugin development in ./plugins instead of ../kibana-extra #31748

eliperelman commented Feb 21, 2019 •

edited

Loading

elasticmachine commented Feb 21, 2019

trevan commented Feb 21, 2019

elasticmachine commented Feb 21, 2019

epixa commented Feb 21, 2019

epixa commented Feb 22, 2019

trevan commented Feb 22, 2019

epixa commented Feb 22, 2019

eliperelman commented Feb 22, 2019

trevan commented Feb 22, 2019

w33ble commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

epixa commented Feb 22, 2019

eliperelman commented Feb 26, 2019

elasticmachine commented Feb 26, 2019

elasticmachine commented Feb 26, 2019

eliperelman commented Feb 26, 2019

elasticmachine commented Feb 26, 2019

epixa commented Mar 5, 2019

eliperelman commented Mar 5, 2019

eliperelman commented Mar 5, 2019

elasticmachine commented Mar 5, 2019

elasticmachine commented Mar 5, 2019

epixa left a comment

epixa left a comment

elasticmachine commented Mar 6, 2019

eliperelman commented Mar 6, 2019

elasticmachine commented Mar 6, 2019

elasticmachine commented Mar 7, 2019

elasticmachine commented Mar 7, 2019

martijnrondeel commented Jun 27, 2019

Prefer third-party plugin development in ./plugins instead of ../kibana-extra #31748

Prefer third-party plugin development in ./plugins instead of ../kibana-extra #31748

Conversation

eliperelman commented Feb 21, 2019 • edited Loading

Summary

Checklist

For maintainers

Dev-Docs

Prefer third-party plugin development in plugins instead of kibana-extra

elasticmachine commented Feb 21, 2019

trevan commented Feb 21, 2019

elasticmachine commented Feb 21, 2019

💚 Build Succeeded

epixa commented Feb 21, 2019

epixa commented Feb 22, 2019

trevan commented Feb 22, 2019

epixa commented Feb 22, 2019

eliperelman commented Feb 22, 2019

trevan commented Feb 22, 2019

w33ble commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

💚 Build Succeeded

epixa commented Feb 22, 2019

eliperelman commented Feb 26, 2019

elasticmachine commented Feb 26, 2019

💔 Build Failed

elasticmachine commented Feb 26, 2019

💔 Build Failed

eliperelman commented Feb 26, 2019

elasticmachine commented Feb 26, 2019

💚 Build Succeeded

epixa commented Mar 5, 2019

eliperelman commented Mar 5, 2019

eliperelman commented Mar 5, 2019

elasticmachine commented Mar 5, 2019

💔 Build Failed

elasticmachine commented Mar 5, 2019

💚 Build Succeeded

epixa left a comment

Choose a reason for hiding this comment

epixa left a comment

Choose a reason for hiding this comment

elasticmachine commented Mar 6, 2019

💔 Build Failed

eliperelman commented Mar 6, 2019

elasticmachine commented Mar 6, 2019

💔 Build Failed

elasticmachine commented Mar 7, 2019

💔 Build Failed

elasticmachine commented Mar 7, 2019

💚 Build Succeeded

martijnrondeel commented Jun 27, 2019

eliperelman commented Feb 21, 2019 •

edited

Loading

Prefer third-party plugin development in `plugins` instead of `kibana-extra`