Add new catalog extensions and catalog service provider #7023

rohitkrai03 · 2020-10-28T20:02:30Z

Fixes:

Analysis / Root cause: We needed a way to extend dev catalog using plugin extensions.

Solution Description:
This PR -

Adds new type definitions from catalog extensions.
Create new extension providers for all the catalog items.
Add a new catalog service provider component that fetches all the catalog items and provides an API to search and query items.
Adds new catalog page and controller components to test the service provider.

Unit test coverage report: Coming soon.

Test setup:
Right now the PR doesn't change anything from UI perspective. It just adds new extensions, providers and APIs to access catalog items. There is a test component and route added which can be used to test the PR changes. To test in the UI try the below URLs -

Browser conformance:

Chrome
Firefox
Safari
Edge

rohitkrai03 · 2020-10-28T20:03:50Z

/assign @christianvogt

rohitkrai03 · 2020-11-05T13:14:01Z

/retest

rohitkrai03 · 2020-11-06T10:42:19Z

/retest

frontend/packages/dev-console/src/components/catalog/providers/index.ts

frontend/packages/console-plugin-sdk/src/typings/base.ts

frontend/packages/console-plugin-sdk/src/typings/dev-catalog.ts

christianvogt · 2020-11-06T20:12:09Z

frontend/packages/dev-console/src/components/catalog/hooks/useCatalogExtensions.ts

+  const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);
+  const itemProviderExtensions = useResolvedExtensions<CatalogItemProvider>(isCatalogItemProvider);


Would be good to have support for resolving a specific set of extensions so that we can filter by type first.

You mean have ability in useResolvedExtensions to resolve specific types of extensions?

We don't need to do this now but I was just suggesting something like this to prevent resolving of references we don't yet intend on using:

Suggested change

const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);

const itemProviderExtensions = useResolvedExtensions<CatalogItemProvider>(isCatalogItemProvider);

const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);

const itemProviderExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemProvider);

const resolvedItemTypeExtensions = useResolvedExtensions(itemTypeExtensions.filter(e => e.properties.type === catalogType);

const resolvedItemProviderExtensions = useResolvedExtensions(itemProviderExtensions.filter(e => e.properties.type === catalogType);

frontend/packages/dev-console/src/components/catalog/service/CatalogExtensionHookResolver.tsx

frontend/packages/dev-console/src/components/catalog/service/CatalogItemsLoader.tsx

frontend/packages/operator-lifecycle-manager/src/utils/useClusterServiceVersions.tsx

frontend/packages/dev-console/src/components/catalog/utils/utils.ts

frontend/packages/console-plugin-sdk/src/typings/dev-catalog.ts

…roviders

frontend/packages/console-dynamic-plugin-sdk/src/coderefs/coderef-utils.ts

frontend/packages/console-plugin-sdk/src/typings/base.ts

frontend/packages/console-plugin-sdk/src/typings/dev-catalog.ts

christianvogt · 2020-11-10T16:12:51Z

frontend/packages/dev-console/src/components/catalog/catalog-plugin.ts

+      catalogDescription:
+        'Browse for container images that support a particular language or framework. Cluster administrators can customize the content made available in the catalog.',
+      typeDescription:
+        'Builder images are container images that build source code for a  particular language or framework.',


UX had the type string as bold. Do we need to bold it? Which means supporting react components here instead of strings. I'm happier to keep it as a string.

I would like to keep it a string. We can talk to UX about this. If needed we can make it a markdown instead which will still be string type.

christianvogt · 2020-11-10T16:30:42Z

frontend/packages/dev-console/src/components/catalog/hooks/useCatalogExtensions.ts

+  const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);
+  const itemProviderExtensions = useResolvedExtensions<CatalogItemProvider>(isCatalogItemProvider);


We don't need to do this now but I was just suggesting something like this to prevent resolving of references we don't yet intend on using:

Suggested change

const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);

const itemProviderExtensions = useResolvedExtensions<CatalogItemProvider>(isCatalogItemProvider);

const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);

const itemProviderExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemProvider);

const resolvedItemTypeExtensions = useResolvedExtensions(itemTypeExtensions.filter(e => e.properties.type === catalogType);

const resolvedItemProviderExtensions = useResolvedExtensions(itemProviderExtensions.filter(e => e.properties.type === catalogType);

frontend/packages/dev-console/src/components/catalog/providers/useHelmCharts.tsx

frontend/packages/dev-console/src/components/catalog/service/CatalogItemsLoader.tsx

frontend/packages/dev-console/src/components/catalog/service/CatalogServiceProvider.tsx

christianvogt · 2020-11-10T17:15:49Z

frontend/packages/dev-console/src/components/catalog/service/CatalogServiceProvider.tsx

+  itemsMap: { [key: string]: CatalogItem[] };
+  loaded: boolean;
+  loadError: any;
+  searchCatalog: (query: string) => CatalogItem[];


Unsure if this is the best API for searching the catalog vs a simple util or something else. This feature isn't used yet in this PR. We can re-visit this when we get to implementing the search capabilities.

christianvogt · 2020-11-10T17:16:16Z

/lgtm
/approve

openshift-ci-robot · 2020-11-10T17:16:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christianvogt, rohitkrai03

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~frontend/packages/console-dynamic-plugin-sdk/OWNERS~~ [christianvogt,rohitkrai03]
~~frontend/packages/console-plugin-sdk/OWNERS~~ [christianvogt,rohitkrai03]
~~frontend/packages/dev-console/OWNERS~~ [christianvogt,rohitkrai03]
~~frontend/packages/operator-lifecycle-manager/OWNERS~~ [christianvogt,rohitkrai03]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

rohitkrai03 · 2020-11-10T18:42:33Z

/retest

openshift-bot · 2020-11-10T18:46:05Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-11-10T23:32:02Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-11-10T23:45:04Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-merge-robot · 2020-11-11T04:06:51Z

@rohitkrai03: The following test failed, say /retest to rerun all failed tests:

Test name	Commit	Details	Rerun command
ci/prow/e2e-gcp-console	`1cf8944`	link	`/test e2e-gcp-console`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-bot · 2020-11-11T04:43:33Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-ci-robot added component/dev-console Related to dev-console component/olm Related to OLM labels Oct 28, 2020

openshift-ci-robot requested review from nemesis09 and spadgett October 28, 2020 20:02

openshift-ci-robot added component/sdk Related to console-plugin-sdk approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 28, 2020

openshift-ci-robot assigned christianvogt Oct 28, 2020

rohitkrai03 force-pushed the catalog-extensibility branch 4 times, most recently from 2458118 to 7e405f3 Compare November 4, 2020 18:47

rohitkrai03 force-pushed the catalog-extensibility branch from 7e405f3 to fd39f1a Compare November 5, 2020 19:23

christianvogt reviewed Nov 6, 2020

View reviewed changes

rohitkrai03 force-pushed the catalog-extensibility branch 7 times, most recently from 245361f to d812809 Compare November 9, 2020 20:36

rohitkrai03 added 2 commits November 10, 2020 03:15

Add new catalog extensions and convert exisiting items to extension p…

d2ea282

…roviders

Add catalog service provider that fetches items using extensions

974575b

christianvogt reviewed Nov 10, 2020

View reviewed changes

Update extensions and catalog provider implementation

1cf8944

rohitkrai03 force-pushed the catalog-extensibility branch from d812809 to 1cf8944 Compare November 10, 2020 17:03

christianvogt reviewed Nov 10, 2020

View reviewed changes

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 10, 2020

openshift-merge-robot merged commit 18e98ac into openshift:master Nov 11, 2020

spadgett added this to the v4.7 milestone Nov 16, 2020

rohitkrai03 deleted the catalog-extensibility branch July 24, 2021 06:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new catalog extensions and catalog service provider #7023

Add new catalog extensions and catalog service provider #7023

rohitkrai03 commented Oct 28, 2020

rohitkrai03 commented Oct 28, 2020

rohitkrai03 commented Nov 5, 2020

rohitkrai03 commented Nov 6, 2020

christianvogt Nov 6, 2020

rohitkrai03 Nov 9, 2020 •

edited

christianvogt Nov 10, 2020

christianvogt Nov 10, 2020

rohitkrai03 Nov 10, 2020

christianvogt Nov 10, 2020

christianvogt Nov 10, 2020

christianvogt commented Nov 10, 2020

openshift-ci-robot commented Nov 10, 2020

rohitkrai03 commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-merge-robot commented Nov 11, 2020

openshift-bot commented Nov 11, 2020

		const itemTypeExtensions = useResolvedExtensions<CatalogItemType>(isCatalogItemType);
		const itemProviderExtensions = useResolvedExtensions<CatalogItemProvider>(isCatalogItemProvider);

Add new catalog extensions and catalog service provider #7023

Add new catalog extensions and catalog service provider #7023

Conversation

rohitkrai03 commented Oct 28, 2020

rohitkrai03 commented Oct 28, 2020

rohitkrai03 commented Nov 5, 2020

rohitkrai03 commented Nov 6, 2020

christianvogt Nov 6, 2020

Choose a reason for hiding this comment

rohitkrai03 Nov 9, 2020 • edited

Choose a reason for hiding this comment

christianvogt Nov 10, 2020

Choose a reason for hiding this comment

christianvogt Nov 10, 2020

Choose a reason for hiding this comment

rohitkrai03 Nov 10, 2020

Choose a reason for hiding this comment

christianvogt Nov 10, 2020

Choose a reason for hiding this comment

christianvogt Nov 10, 2020

Choose a reason for hiding this comment

christianvogt commented Nov 10, 2020

openshift-ci-robot commented Nov 10, 2020

rohitkrai03 commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-bot commented Nov 10, 2020

openshift-merge-robot commented Nov 11, 2020

openshift-bot commented Nov 11, 2020

rohitkrai03 Nov 9, 2020 •

edited