ODC-6779 - Hide sub-catalog(s) in the developer catalog or the entire dev catalog based on customization #12067

lokanandaprabhu · 2022-09-20T10:59:37Z

JIRA story:
https://issues.redhat.com/browse/ODC-6779

Description:
This story is about the customization of developer catalog and sub-catalog based on customization. If all the available sub-catalogs(types) are disabled, complete developer catalog along with the entry points to the catalog will be disabled.

Screenshots:
----When all the sub-catalogs are disabled - Add page----

----When all the sub-catalogs are disabled - Topology page----

-----Quick start when complete developer catalog is disabled-----

------ All services - when all the sub-catalogs(types) are enabled----

------ All services - when Templates and Helm charts sub-catalogs are disabled----

-----Helm Page when helm chart sub-catalog is disabled-----

---- Operator hub description when operator backed service is disabled or complete developer catalog is disabled---

---- If Event source type is disabled, create event source in action menu is hidden----

-----If user try to reach to catalog by entering URL and if that sub-catalog is disabled, then user will see Page not found--

Test cases:

How to test:

If backend API PR's - openshift/api#1256 & openshift/console-operator#676 are not merged then to add the customization use below method,

Pass options as a string to bridge with -developer-catalog-disabled-types or pass a ConsoleConfig yaml with -config option.

Example:

Specify developer catalog types to bridge with ./bin/bridge -developer-catalog-types '{ "state": "Disabled" ,"disabled": ["HelmChart", "Devfile"] }'.

This indicated HelmChart and Devfile sub-catalogs are disabled. Similarly below are the test scenarios,

If the state is Enabled and enabled list is empty, all the types will be shown.
If the state id Enabled and enabled list is non-empty, only the enabled list items will be shown.
If the state is Disabled and disabled list is empty, all the types will be hidden.
If the state id Disabled and disabled list is non-empty, only the disabled list items will be hidden.

To disable the complete developer catalog then in disabled all the available types
should be listed or make the disabled list empty for state: Disabled.

/kind feature

lokanandaprabhu · 2022-09-20T14:30:26Z

/retest

lokanandaprabhu · 2022-09-20T14:31:53Z

/assign @jerolimov
/assign @invincibleJai
/cc @debsmita1

lokanandaprabhu · 2022-09-21T04:48:38Z

/retest

frontend/packages/dev-console/src/utils/useAddActionExtensions.ts

frontend/packages/dev-console/src/actions/providers.ts

frontend/packages/dev-console/src/utils/useAddActionExtensions.ts

jerolimov

This was just a high level review but we should not update the extensions if it's not needed.

PTAL on my comments below:

frontend/packages/console-dynamic-plugin-sdk/src/extensions/actions.ts

frontend/packages/console-dynamic-plugin-sdk/src/extensions/catalog.ts

frontend/packages/dev-console/src/actions/add-resources.tsx

frontend/packages/dev-console/src/utils/useAddActionExtensions.ts

jerolimov · 2022-09-25T22:44:55Z

frontend/packages/helm-plugin/src/components/list-page/HelmTabbedPage.tsx

    helmRelease: {
-      label: t('helm-plugin~Helm Release'),
+      label: isHelmVisible ? t('helm-plugin~Helm Release') : null,
      onSelection: () => `/catalog/ns/${namespace}?catalogType=HelmChart`,
    },


If the flag is false and we don't want to add an Action, we should not add it completely instead of setting the label to null.

If the label is null then that action will not be added.

frontend/packages/knative-plugin/src/actions/add-event-sink.tsx

lokanandaprabhu · 2022-09-26T13:30:34Z

Hi @jerolimov / @debsmita1 ,

Updated the PR as per the PR comments.

invincibleJai · 2022-09-28T07:21:32Z

/retest

lokanandaprabhu · 2022-09-28T14:30:55Z

/retest

lokanandaprabhu · 2022-10-03T04:37:34Z

/retest

lokanandaprabhu · 2022-10-14T05:00:03Z

Updated the PR. PTAL. Thanks.

debsmita1 · 2022-10-14T07:37:08Z

The entire dev-catalog is disabled, but I can see Samples option when I click on topology graph
https://user-images.githubusercontent.com/22490998/195789490-c2df4321-a88d-4c1b-82c1-ac5e4a05cccc.mov

lokanandaprabhu · 2022-10-14T07:53:53Z

The entire dev-catalog is disabled, but I can see Samples option when I click on topology graph https://user-images.githubusercontent.com/22490998/195789490-c2df4321-a88d-4c1b-82c1-ac5e4a05cccc.mov

Updated the PR.

vikram-raj

Thanks @lokanandaprabhu . This feature works as expected. Just added a couple of nits. PTAL if it makes sense.

frontend/packages/dev-console/src/actions/providers.ts

jerolimov · 2022-10-14T10:19:44Z

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

@@ -47,7 +48,7 @@ const CatalogServiceProvider: React.FC<CatalogServiceProviderProps> = ({
    catalogBadgeProviderExtensions,
    extensionsResolved,
  ] = useCatalogExtensions(catalogId, catalogType);
-
+  const [disabledSubCatalogs] = useGetAllDisabledSubCatalogs();


Isn't it easier to filter the items directly in useCatalogExtensions so that it returns already just an array of enabled catalogTypeExtensions?

frontend/packages/console-shared/src/components/catalog/catalog-view/CatalogTypeSelector.tsx

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

jerolimov

This PR needs a rebase and I would like that you move the utils as mentioned below.

frontend/packages/console-shared/src/components/catalog/catalog-view/CatalogTypeSelector.tsx

...packages/kubevirt-plugin/src/components/create-vm/dev-console/dev-console-create-vm-form.tsx

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

jerolimov · 2022-10-16T01:00:27Z

Following our no-FF process propagate the PX and Docs ACK from epic ODC-5897
/label px-approved
/label docs-approved

I add also approve here so that @debsmita1 can do the final review when the files are moved (#12067 (review)) and the PR is rebased.
/approve

lokanandaprabhu · 2022-10-17T05:55:45Z

Hi @jerolimov / @debsmita1 ,

I have updated the PR based on PR comments. PTAL. Thanks.

jerolimov

Tested the latest version on a cluster bot instance and it works fine. 👍

/lgtm

openshift-ci · 2022-10-17T22:07:16Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerolimov, lokanandaprabhu

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/OWNERS~~ [jerolimov]

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

openshift-ci-robot · 2022-10-18T08:13:06Z

/retest-required

Remaining retests: 0 against base HEAD 167ca37 and 2 for PR HEAD 59b26fb in total

lokanandaprabhu · 2022-10-18T10:08:59Z

/retest

openshift-ci · 2022-10-18T13:44:24Z

@lokanandaprabhu: all tests passed!

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-ci bot requested review from christianvogt and florkbr September 20, 2022 11:01

openshift-ci bot assigned invincibleJai and jerolimov Sep 20, 2022

openshift-ci bot requested a review from debsmita1 September 20, 2022 14:32

debsmita1 suggested changes Sep 23, 2022

View reviewed changes

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 25, 2022

jerolimov suggested changes Sep 25, 2022

View reviewed changes

lokanandaprabhu force-pushed the feature/ODC6779 branch from 4e55be3 to f796783 Compare September 26, 2022 10:28

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 26, 2022

lokanandaprabhu force-pushed the feature/ODC6779 branch from f796783 to 349f008 Compare September 27, 2022 08:29

lokanandaprabhu force-pushed the feature/ODC6779 branch 3 times, most recently from 3926393 to e5ea31b Compare September 30, 2022 08:54

lokanandaprabhu force-pushed the feature/ODC6779 branch from e32b0cc to dc89179 Compare October 14, 2022 04:42

lokanandaprabhu force-pushed the feature/ODC6779 branch from dc89179 to a529ea8 Compare October 14, 2022 07:52

vikram-raj reviewed Oct 14, 2022

View reviewed changes

frontend/packages/dev-console/src/actions/providers.ts Outdated Show resolved Hide resolved

frontend/packages/dev-console/src/actions/providers.ts Outdated Show resolved Hide resolved

lokanandaprabhu force-pushed the feature/ODC6779 branch 2 times, most recently from ff83dc0 to 0fa6ab9 Compare October 14, 2022 10:28

jerolimov reviewed Oct 14, 2022

View reviewed changes

lokanandaprabhu force-pushed the feature/ODC6779 branch from 0fa6ab9 to e03cbb4 Compare October 14, 2022 12:56

jerolimov suggested changes Oct 16, 2022

View reviewed changes

openshift-ci bot added px-approved Signifies that Product Support has signed off on this PR docs-approved Signifies that Docs has signed off on this PR labels Oct 16, 2022

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 16, 2022

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 16, 2022

lokanandaprabhu added 4 commits October 17, 2022 10:16

Customization of developer catalog and sub-catalogs

9702660

Added manual e2e tests

9822801

Moved utils to catalog-utils file

4f0307d

Resolved the nit's

59b26fb

lokanandaprabhu force-pushed the feature/ODC6779 branch from e03cbb4 to 59b26fb Compare October 17, 2022 05:52

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 17, 2022

jerolimov approved these changes Oct 17, 2022

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2022

openshift-merge-robot merged commit 4966fa6 into openshift:master Oct 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ODC-6779 - Hide sub-catalog(s) in the developer catalog or the entire dev catalog based on customization #12067

ODC-6779 - Hide sub-catalog(s) in the developer catalog or the entire dev catalog based on customization #12067

lokanandaprabhu commented Sep 20, 2022 •

edited

lokanandaprabhu commented Sep 20, 2022

lokanandaprabhu commented Sep 20, 2022

lokanandaprabhu commented Sep 21, 2022

jerolimov left a comment

jerolimov Sep 25, 2022

lokanandaprabhu Sep 26, 2022

lokanandaprabhu commented Sep 26, 2022

invincibleJai commented Sep 28, 2022

lokanandaprabhu commented Sep 28, 2022

lokanandaprabhu commented Oct 3, 2022

lokanandaprabhu commented Oct 14, 2022

debsmita1 commented Oct 14, 2022

lokanandaprabhu commented Oct 14, 2022

vikram-raj left a comment

jerolimov Oct 14, 2022

jerolimov left a comment

jerolimov commented Oct 16, 2022 •

edited

lokanandaprabhu commented Oct 17, 2022

jerolimov left a comment

openshift-ci bot commented Oct 17, 2022

openshift-ci-robot commented Oct 18, 2022

lokanandaprabhu commented Oct 18, 2022

openshift-ci bot commented Oct 18, 2022

ODC-6779 - Hide sub-catalog(s) in the developer catalog or the entire dev catalog based on customization #12067

ODC-6779 - Hide sub-catalog(s) in the developer catalog or the entire dev catalog based on customization #12067

Conversation

lokanandaprabhu commented Sep 20, 2022 • edited

lokanandaprabhu commented Sep 20, 2022

lokanandaprabhu commented Sep 20, 2022

lokanandaprabhu commented Sep 21, 2022

jerolimov left a comment

Choose a reason for hiding this comment

jerolimov Sep 25, 2022

Choose a reason for hiding this comment

lokanandaprabhu Sep 26, 2022

Choose a reason for hiding this comment

lokanandaprabhu commented Sep 26, 2022

invincibleJai commented Sep 28, 2022

lokanandaprabhu commented Sep 28, 2022

lokanandaprabhu commented Oct 3, 2022

lokanandaprabhu commented Oct 14, 2022

debsmita1 commented Oct 14, 2022

lokanandaprabhu commented Oct 14, 2022

vikram-raj left a comment

Choose a reason for hiding this comment

jerolimov Oct 14, 2022

Choose a reason for hiding this comment

jerolimov left a comment

Choose a reason for hiding this comment

jerolimov commented Oct 16, 2022 • edited

lokanandaprabhu commented Oct 17, 2022

jerolimov left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Oct 17, 2022

openshift-ci-robot commented Oct 18, 2022

lokanandaprabhu commented Oct 18, 2022

openshift-ci bot commented Oct 18, 2022

lokanandaprabhu commented Sep 20, 2022 •

edited

jerolimov commented Oct 16, 2022 •

edited