OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #12946

tvu20 · 2023-06-27T14:31:50Z

…d object

Fixes https://issues.redhat.com/browse/OCPBUGS-13808

Components in Console Dynamic Plugin SDK use new K8sGroupVersionKind object. Reference string still supported for backwards compatibility.

openshift-ci-robot · 2023-06-27T14:31:57Z

@tvu20: This pull request references Jira Issue OCPBUGS-13808, which is invalid:

expected the bug to target the "4.14.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

…d object

Fixes https://issues.redhat.com/browse/OCPBUGS-13808

Components in Console Dynamic Plugin SDK use new K8sGroupVersionKind object. Reference string still supported for backwards compatibility.

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.

tvu20 · 2023-06-27T14:47:29Z

/jira refresh

openshift-ci-robot · 2023-06-27T14:47:36Z

@tvu20: This pull request references Jira Issue OCPBUGS-13808, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.14.0) matches configured target version for branch (4.14.0)
bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh

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.

tvu20 · 2023-06-27T18:49:18Z

/retest

tvu20 · 2023-06-28T13:35:13Z

/retest

jhadvig · 2023-07-12T09:01:27Z

The code looks good 👍
Could you please also update the api docs for ListPageCreate component?

tvu20 · 2023-07-12T15:36:14Z

/retest

tvu20 · 2023-07-12T16:34:55Z

/retest

…d object Fixes https://issues.redhat.com/browse/OCPBUGS-13808 Components in Console Dynamic Plugin SDK use new `K8sGroupVersionKind` object. Reference string still supported for backwards compatibility.

tvu20 · 2023-07-12T20:43:22Z

/retest

jhadvig

Nice job @tvu20 👍
/lgtm
/approve

openshift-ci · 2023-07-13T08:36:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, tvu20

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~~ [jhadvig]

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 · 2023-07-14T11:23:24Z

/retest-required

Remaining retests: 0 against base HEAD 07f4183 and 2 for PR HEAD b8778ca in total

openshift-ci-robot · 2023-07-14T12:53:10Z

@tvu20: Jira Issue OCPBUGS-13808: All pull requests linked via external trackers have merged:

openshift/console#12946

Jira Issue OCPBUGS-13808 has been moved to the MODIFIED state.

In response to this:

…d object

Fixes https://issues.redhat.com/browse/OCPBUGS-13808

Components in Console Dynamic Plugin SDK use new K8sGroupVersionKind object. Reference string still supported for backwards compatibility.

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.

spadgett

Sorry to comment on a merged PR, but there is an issue with the implementation.

spadgett · 2023-07-19T11:57:34Z

frontend/public/components/factory/ListPage/ListPageCreate.tsx

+  const kind = typeof groupVersionKind !== 'string' ? groupVersionKind.kind : groupVersionKind;
+
+  const [k8sModel] = useK8sModel(kind);


This is incorrect, we need to be passing the API group and version as well to useK8sModel. We need to disambiguate between the same kind in different groups as well as different API versions.

It looks like useK8sModel already takes a groupVersionKind, so maybe we don't need to change the code here.

https://github.com/openshift/console/blob/master/frontend/packages/console-dynamic-plugin-sdk/src/utils/k8s/hooks/useK8sModel.ts#L25

If so, it can still be useK8sModel(groupVersionKind) as before

spadgett · 2023-07-19T11:58:02Z

frontend/packages/console-dynamic-plugin-sdk/docs/api.md

@@ -691,7 +691,7 @@ const exampleList: React.FC<MyProps> = () => {

 | Parameter Name | Description |
 | -------------- | ----------- |
-| `groupVersionKind` | the resource group/version/kind to represent |
+| `groupVersionKind` | group, version, kind of k8s resource {@link K8sGroupVersionKind} is preferred alternatively can pass reference for group, version, kind which is deprecated i.e `group~version~kind` {@link K8sResourceKindReference}. |


We should document how to handle core resource like pod without a group as well

Hi Sam, I'm not sure what handle core resource like pod without a group is referring to. Can you give me an example of how to document this?

spadgett · 2023-07-19T15:09:57Z

frontend/public/components/factory/ListPage/ListPageCreate.tsx

@@ -111,8 +113,8 @@ const ListPageCreate: React.FC<ListPageCreateProps> = ({
      : `/k8s/cluster/${k8sModel.plural}/~new`;
    if (k8sModel.crd) {
      to = usedNamespace
-        ? `/k8s/ns/${usedNamespace || 'default'}/${groupVersionKind}/~new`
-        : `/k8s/cluster/${groupVersionKind}/~new`;
+        ? `/k8s/ns/${usedNamespace || 'default'}/${kind}/~new`


We want to make sure we're using the "reference" string here which is ~ delimited for resources in an API group.

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jun 27, 2023

openshift-ci bot requested review from spadgett and TheRealJon June 27, 2023 14:33

openshift-ci bot added component/core Related to console core functionality component/sdk Related to console-plugin-sdk labels Jun 27, 2023

openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jun 27, 2023

openshift-ci bot requested a review from yapei June 27, 2023 14:47

tvu20 force-pushed the OCPBUGS-13808 branch from 5651c8f to 7b82de5 Compare July 12, 2023 14:48

OCPBUGS-13808: Console SDK components should be using GroupVersionKin…

b8778ca

…d object Fixes https://issues.redhat.com/browse/OCPBUGS-13808 Components in Console Dynamic Plugin SDK use new `K8sGroupVersionKind` object. Reference string still supported for backwards compatibility.

tvu20 force-pushed the OCPBUGS-13808 branch from 7b82de5 to b8778ca Compare July 12, 2023 18:15

jhadvig approved these changes Jul 13, 2023

View reviewed changes

openshift-ci bot assigned jhadvig Jul 13, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 13, 2023

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 13, 2023

openshift-merge-robot merged commit 200b9ec into openshift:master Jul 14, 2023
5 of 6 checks passed

spadgett reviewed Jul 19, 2023

View reviewed changes

openshift-ci-robot mentioned this pull request Jul 20, 2023

OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #13029

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #12946

OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #12946

tvu20 commented Jun 27, 2023

openshift-ci-robot commented Jun 27, 2023

tvu20 commented Jun 27, 2023

openshift-ci-robot commented Jun 27, 2023

tvu20 commented Jun 27, 2023

tvu20 commented Jun 28, 2023

jhadvig commented Jul 12, 2023

tvu20 commented Jul 12, 2023

tvu20 commented Jul 12, 2023

tvu20 commented Jul 12, 2023

jhadvig left a comment

openshift-ci bot commented Jul 13, 2023

openshift-ci-robot commented Jul 14, 2023

openshift-ci-robot commented Jul 14, 2023

spadgett left a comment

spadgett Jul 19, 2023

spadgett Jul 19, 2023

spadgett Jul 19, 2023

tvu20 Jul 19, 2023

spadgett Jul 19, 2023

		const kind = typeof groupVersionKind !== 'string' ? groupVersionKind.kind : groupVersionKind;

		const [k8sModel] = useK8sModel(kind);

OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #12946

OCPBUGS-13808: Console SDK components should be using GroupVersionKin… #12946

Conversation

tvu20 commented Jun 27, 2023

openshift-ci-robot commented Jun 27, 2023

tvu20 commented Jun 27, 2023

openshift-ci-robot commented Jun 27, 2023

tvu20 commented Jun 27, 2023

tvu20 commented Jun 28, 2023

jhadvig commented Jul 12, 2023

tvu20 commented Jul 12, 2023

tvu20 commented Jul 12, 2023

tvu20 commented Jul 12, 2023

jhadvig left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Jul 13, 2023

openshift-ci-robot commented Jul 14, 2023

openshift-ci-robot commented Jul 14, 2023

spadgett left a comment

Choose a reason for hiding this comment

spadgett Jul 19, 2023

Choose a reason for hiding this comment

spadgett Jul 19, 2023

Choose a reason for hiding this comment

spadgett Jul 19, 2023

Choose a reason for hiding this comment

tvu20 Jul 19, 2023

Choose a reason for hiding this comment

spadgett Jul 19, 2023

Choose a reason for hiding this comment