Migrate ui/registry/feature_catalogue to New Platform plugin #48818
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # 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 | ||
|
There was a problem hiding this comment. then probably we should rename either? There was a problem hiding this comment. 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. |
||
| UI capabilities for feature controls. | ||
joshdover marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "id": "feature_catalogue", | ||
| "version": "kibana", | ||
| "server": false, | ||
| "ui": true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| export { FeatureCatalogueSetup, FeatureCatalogueStart } from './plugin'; | ||
| export { FeatureCatalogueEntry, FeatureCatalogueCategory } from './services'; | ||
| import { FeatureCataloguePlugin } from './plugin'; | ||
|
|
||
| export const plugin = () => new FeatureCataloguePlugin(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { featureCatalogueRegistryMock } from './services/feature_catalogue_registry.mock'; | ||
|
|
||
| export const registryMock = featureCatalogueRegistryMock.create(); | ||
| jest.doMock('./services', () => ({ | ||
| FeatureCatalogueRegistry: jest.fn(() => registryMock), | ||
| })); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { registryMock } from './plugin.test.mocks'; | ||
| import { FeatureCataloguePlugin } from './plugin'; | ||
|
|
||
| describe('FeatureCataloguePlugin', () => { | ||
| beforeEach(() => { | ||
| registryMock.setup.mockClear(); | ||
| registryMock.start.mockClear(); | ||
| }); | ||
|
|
||
| describe('setup', () => { | ||
| test('wires up and returns registry', async () => { | ||
|
There was a problem hiding this comment. optional: not sure those are really useful tests if TS enforces the contract There was a problem hiding this comment. I can go either way here, but I prefer some coverage here over nothing. |
||
| const setup = await new FeatureCataloguePlugin().setup(); | ||
| expect(registryMock.setup).toHaveBeenCalledWith(); | ||
| expect(setup.register).toBeDefined(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('start', () => { | ||
| test('wires up and returns registry', async () => { | ||
| const service = new FeatureCataloguePlugin(); | ||
| await service.setup(); | ||
| const core = { application: { capabilities: { catalogue: {} } } } as any; | ||
| const start = await service.start(core); | ||
| expect(registryMock.start).toHaveBeenCalledWith({ | ||
| capabilities: core.application.capabilities, | ||
| }); | ||
| expect(start.get).toBeDefined(); | ||
| }); | ||
| }); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { CoreStart, Plugin } from 'src/core/public'; | ||
| import { | ||
| FeatureCatalogueRegistry, | ||
| FeatureCatalogueRegistrySetup, | ||
| FeatureCatalogueRegistryStart, | ||
| } from './services'; | ||
|
|
||
| export class FeatureCataloguePlugin | ||
| implements Plugin<FeatureCatalogueSetup, FeatureCatalogueStart> { | ||
| private readonly featuresCatalogueRegistry = new FeatureCatalogueRegistry(); | ||
|
|
||
| public async setup() { | ||
| return { | ||
| ...this.featuresCatalogueRegistry.setup(), | ||
| }; | ||
| } | ||
|
|
||
| public async start(core: CoreStart) { | ||
| return { | ||
| ...this.featuresCatalogueRegistry.start({ | ||
| capabilities: core.application.capabilities, | ||
| }), | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| /** @public */ | ||
| export type FeatureCatalogueSetup = FeatureCatalogueRegistrySetup; | ||
|
|
||
| /** @public */ | ||
| export type FeatureCatalogueStart = FeatureCatalogueRegistryStart; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { | ||
| FeatureCatalogueRegistrySetup, | ||
| FeatureCatalogueRegistryStart, | ||
| FeatureCatalogueRegistry, | ||
| } from './feature_catalogue_registry'; | ||
|
|
||
| const createSetupMock = (): jest.Mocked<FeatureCatalogueRegistrySetup> => { | ||
| const setup = { | ||
| register: jest.fn(), | ||
| }; | ||
| return setup; | ||
| }; | ||
|
|
||
| const createStartMock = (): jest.Mocked<FeatureCatalogueRegistryStart> => { | ||
| const start = { | ||
| get: jest.fn(), | ||
| }; | ||
| return start; | ||
| }; | ||
|
|
||
| const createMock = (): jest.Mocked<PublicMethodsOf<FeatureCatalogueRegistry>> => { | ||
| const service = { | ||
| setup: jest.fn(), | ||
| start: jest.fn(), | ||
| }; | ||
| service.setup.mockImplementation(createSetupMock); | ||
| service.start.mockImplementation(createStartMock); | ||
| return service; | ||
| }; | ||
|
|
||
| export const featureCatalogueRegistryMock = { | ||
| createSetup: createSetupMock, | ||
| createStart: createStartMock, | ||
| create: createMock, | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@flash1293 Any issues with doing this here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not all, that's fine 👍