Migrate ui/registry/feature_catalogue to New Platform plugin #48818

joshdover · 2019-10-21T19:45:04Z

Summary

This PR adds a new feature_catalogue plugin which provides an interface for registering and reading a catalogue items.

For the time being, the Home app will register all items out of the legacy registry with the new plugin, and then read these items out of the new plugin.

Dev Docs

The ui/registries/feature_catalogue module has been deprecated for removal in 8.0

Plugins wishing to migrate may remove their usage of ui/registries/feature_catalogue and rely on either:

// For legacy plugins
import { npSetup } from 'ui/new_platform';
npSetup.plugins.feature_catalogue.register(/* same details here */);

// For new plugins: first add 'feature_catalogue` to the list of `optionalPlugins` 
// in your kibana.json file. Then access the plugin directly in `setup`:

class MyPlugin {
  setup(core, plugins) {
    if (plugins.feature_catalogue) {
      plugins.feature_catalogue.register(/* same details here. */);
    }
  }
}

Note that the old module supported providing a Angular DI function to receive Angular dependencies. This is no longer supported as we migrate away from Angular.

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

elasticmachine · 2019-10-21T19:45:06Z

Pinging @elastic/kibana-platform (Team:Platform)

src/plugins/feature_catalogue/public/services/feature_catalogue_registry.ts

elasticmachine · 2019-10-21T20:54:57Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: b56a005e72ca33300901a84cac30561cd7b0382f

mshustov · 2019-10-22T17:10:46Z

src/plugins/feature_catalogue/public/services/feature_catalogue_registry.ts

+    return {
+      get: (): readonly FeatureCatalogueEntry[] =>
+        [...this.features.values()]
+          .filter(entry => capabilities.catalogue[entry.id] !== false)


I see this is desired behaviour https://github.com/elastic/kibana/pull/48818/files#diff-a757f884a32fbf9bab5a0c977e69bb9eR54
just curious why? to allow OSS ?

It's for plugins that haven't registered features, eg. 3rd party plugins, functional test plugins, etc.

src/plugins/feature_catalogue/public/services/feature_catalogue_registry.test.ts

mshustov · 2019-10-22T17:18:51Z

src/plugins/feature_catalogue/public/plugin.test.ts

+  });
+
+  describe('setup', () => {
+    test('wires up and returns registry', async () => {


optional: not sure those are really useful tests if TS enforces the contract

I can go either way here, but I prefer some coverage here over nothing.

mshustov · 2019-10-22T17:19:28Z

src/plugins/feature_catalogue/README.md

+# Feature catalogue plugin
+
+Replaces the legacy `ui/registry/feature_catalogue` module for registering "features" that should be showed in the home
+page's feature catalogue. This should not be confused with the "feature" plugin for registering features used to derive


then probably we should rename either?

I think this will be more clear once this registry moves into a "home" plugin with the actual UI. I opted not to name this plugin "home" right now since it may not be split out until 8.x and I thought that would be confusing in the meantime.

elasticmachine · 2019-10-23T17:38:06Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 15ed90a

joshdover · 2019-10-23T22:25:24Z

@elasticmachine merge upstream

elasticmachine · 2019-10-23T23:49:15Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 7b58502859d557c71368f25a309893356a08566b

src/plugins/feature_catalogue/README.md

joshdover · 2019-10-28T16:14:34Z

@elasticmachine merge upstream

elasticmachine · 2019-10-28T16:14:36Z

merge conflict between base and head

joshdover · 2019-10-28T16:28:23Z

src/legacy/core_plugins/kibana/public/home/kibana_services.ts

+      (Private(FeatureCatalogueRegistryProvider as any) as any).inTitleOrder.map(
+        npSetup.plugins.feature_catalogue.register
+      );
+      return npStart.plugins.feature_catalogue.get();


@flash1293 Any issues with doing this here?

Not all, that's fine 👍

elasticmachine · 2019-10-28T17:49:15Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: b9173e8

…#48818)

joshdover added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:New Platform release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v8.0.0 v7.6.0 labels Oct 21, 2019

joshdover commented Oct 21, 2019

View reviewed changes

src/plugins/feature_catalogue/public/services/feature_catalogue_registry.ts Outdated Show resolved Hide resolved

mshustov approved these changes Oct 22, 2019

View reviewed changes

joshdover added 3 commits October 22, 2019 17:21

Add new feature_catalogue plugin

7ed7ddc

Bridge legacy and new platform registries

8c6686e

PR comments

f612fb9

joshdover force-pushed the np/feature-catalogue branch from b56a005 to f612fb9 Compare October 23, 2019 14:15

Add to migration guide tables

15ed90a

joshdover requested a review from a team as a code owner October 23, 2019 14:37

rudolf approved these changes Oct 24, 2019

View reviewed changes

src/plugins/feature_catalogue/README.md Show resolved Hide resolved

jasonrhodes mentioned this pull request Oct 24, 2019

[APM] New Kibana platform migration plan #32894

Closed

Merge remote-tracking branch 'upstream/master' into np/feature-catalogue

e6a27c2

joshdover force-pushed the np/feature-catalogue branch from 7b58502 to e6a27c2 Compare October 28, 2019 16:26

joshdover commented Oct 28, 2019

View reviewed changes

Update README

b9173e8

joshdover merged commit 23a9058 into elastic:master Oct 28, 2019

joshdover deleted the np/feature-catalogue branch October 28, 2019 18:08

joshdover added a commit to joshdover/kibana that referenced this pull request Oct 28, 2019

Migrate ui/registry/feature_catalogue to New Platform plugin (elastic…

bd291cc

…#48818)

joshdover mentioned this pull request Oct 28, 2019

[7.x] Migrate ui/registry/feature_catalogue to New Platform plugin (#48818) #49514

Merged

legrego mentioned this pull request Oct 31, 2019

Spaces - Client NP Migration, Phase 1 #40856

Merged

8 tasks

jfsiii mentioned this pull request Nov 8, 2019

[EPM] Use NP feature_catalogue.register #50108

Merged

streamich mentioned this pull request Nov 11, 2019

[DISCUSS] Registries #36705

Closed

TinaHeiligers mentioned this pull request Nov 16, 2019

Np kibana plugin home feature catalogue #50838

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate ui/registry/feature_catalogue to New Platform plugin #48818

Migrate ui/registry/feature_catalogue to New Platform plugin #48818

joshdover commented Oct 21, 2019 •

edited

Loading

elasticmachine commented Oct 21, 2019

elasticmachine commented Oct 21, 2019

mshustov Oct 22, 2019

joshdover Oct 22, 2019

mshustov Oct 22, 2019

joshdover Oct 23, 2019

mshustov Oct 22, 2019

joshdover Oct 23, 2019

elasticmachine commented Oct 23, 2019

joshdover commented Oct 23, 2019

elasticmachine commented Oct 23, 2019

joshdover commented Oct 28, 2019

elasticmachine commented Oct 28, 2019

joshdover Oct 28, 2019

flash1293 Oct 28, 2019

elasticmachine commented Oct 28, 2019

Migrate ui/registry/feature_catalogue to New Platform plugin #48818

Migrate ui/registry/feature_catalogue to New Platform plugin #48818

Conversation

joshdover commented Oct 21, 2019 • edited Loading

Summary

Dev Docs

Checklist

For maintainers

elasticmachine commented Oct 21, 2019

elasticmachine commented Oct 21, 2019

💚 Build Succeeded

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 23, 2019

💔 Build Failed

joshdover commented Oct 23, 2019

elasticmachine commented Oct 23, 2019

💚 Build Succeeded

joshdover commented Oct 28, 2019

elasticmachine commented Oct 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 28, 2019

💚 Build Succeeded

joshdover commented Oct 21, 2019 •

edited

Loading