fix: Recreate non cached object in a user namespace by tolusha · Pull Request #2001 · eclipse-che/che-operator

tolusha · 2025-06-03T09:29:43Z

What does this PR do?

Recreate non cached object in a user namespace

Screenshot/screencast of this PR

N/A

What issues does this PR fix or reference?

https://issues.redhat.com/browse/CRW-8900

How to test this PR?

Prepare a patch file if needed:

cat > /tmp/cr-patch.yaml <<EOF
apiVersion: org.eclipse.che/v2
kind: CheCluster
spec: {}
EOF

Deploy the operator:

OpenShift

./build/scripts/olm/test-catalog-from-sources.sh --cr-patch-yaml /tmp/cr-patch.yaml

on Minikube

./build/scripts/minikube-tests/test-operator-from-sources.sh --cr-patch-yaml /tmp/cr-patch.yaml

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

openshift-ci · 2025-06-03T09:29:55Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tolusha

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

Details

Needs approval from an approver in each of these files:

OWNERS

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

Copilot

Pull Request Overview

This PR enhances the WorkspacesConfigReconciler to use a non-cached client for removing and recreating objects that already exist without the expected cache labels, and it centralizes generic sync logic into a new pkg/common/utils/sync.go while removing the old pkg/deploy/sync/sync.go.

Introduces nonCachedClient in WorkspacesConfigReconciler and its instantiation in main.go
Updates doCreateObject to delete existing non-cached objects and recreate them
Adds a shared pkg/common/utils/sync.go and removes the legacy syncer

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
pkg/deploy/sync/sync.go	Removed (replaced by common utils)
pkg/common/utils/sync.go	Added new generic sync utility
main.go	Passes `nonCachingClient` to the reconciler
controllers/usernamespace/workspaces_config_controller.go	Enhanced `doCreateObject` logic to delete/recreate on conflict
*Multiple `_test.go` files**	Updated calls to `NewWorkspacesConfigReconciler` to include the new client parameter and bumped copyrights

Comments suppressed due to low confidence (1)

pkg/common/utils/sync.go:47

[nitpick] The parameter name 'context' shadows the imported package 'context'. Rename this parameter (and similar occurrences) to 'ctx' for clarity and to avoid shadowing.

func (s ObjSyncer) Get(context context.Context, key client.ObjectKey, objectMeta client.Object) (bool, error) {

pkg/common/utils/sync.go

main.go

controllers/usernamespace/pvc2sync_test.go

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

Copilot

Pull Request Overview

This PR fixes an issue with recreating non-cached objects in a user namespace by revising the sync functionality and updating the WorkspacesConfigReconciler.

Migrates sync logic from pkg/deploy/sync/sync.go into pkg/common/sync and updates corresponding tests.
Updates WorkspacesConfigReconciler and related controller and test files to accept a non-cached client, facilitating deletion and recreation of objects when necessary.
Updates main.go and various usernamespace controller tests to reflect the new API for handling cached versus non-cached client operations.

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
pkg/deploy/sync/sync.go	Removed legacy sync implementation.
pkg/common/sync/sync.go and pkg/common/sync/sync_test.go	Introduced new generic sync interfaces and helper functions/tests.
main.go	Updated instantiation of WorkspacesConfigReconciler with a non-cached client.
controllers/usernamespace/workspaces_config_controller.go	Modified controller logic to delete/recreate objects using non-cached client if needed.
controllers/usernamespace/*_test.go	Updated tests to pass non-cached client parameter and adapt to new API.

Comments suppressed due to low confidence (1)

main.go:293

[nitpick] Consider unifying the parameter naming between 'nonCachingClient' used here and the function parameter 'nonCachedClient' in NewWorkspacesConfigReconciler for consistency across the codebase.

workspacesConfigReconciler := usernamespace.NewWorkspacesConfigReconciler(mgr.GetClient(), nonCachingClient, mgr.GetScheme(), namespacechace)

tolusha · 2025-06-03T12:19:17Z

/retest

devspacesbuild · 2025-06-03T14:27:21Z

Build 3.22 :: operator_3.x/463: Console, Changes, Git Data

devspacesbuild · 2025-06-03T14:30:54Z

Build 3.22 :: sync-to-downstream_3.x/9351: Console, Changes, Git Data

devspacesbuild · 2025-06-03T14:34:52Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9498: Console, Changes, Git Data

devspacesbuild · 2025-06-03T15:42:28Z

Build 3.22 :: push-latest-container-to-quay_3.x/5191: Console, Changes, Git Data

devspacesbuild · 2025-06-03T15:44:43Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9498:

devspaces-operator : 3.x :: Build 67809959 : quay.io/devspaces/devspaces-rhel9-operator:3.22-5
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/5191 triggered

devspacesbuild · 2025-06-03T15:44:47Z

Build 3.22 :: operator_3.x/463:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/9351 triggered

devspacesbuild · 2025-06-03T15:44:51Z

Build 3.22 :: update-digests_3.x/9330: Console, Changes, Git Data

devspacesbuild · 2025-06-03T15:46:39Z

Build 3.22 :: operator-bundle_3.x/4919: Console, Changes, Git Data

devspacesbuild · 2025-06-03T15:50:30Z

Build 3.22 :: sync-to-downstream_3.x/9352: Console, Changes, Git Data

devspacesbuild · 2025-06-03T15:51:09Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9499: Console, Changes, Git Data

devspacesbuild · 2025-06-03T16:34:42Z

Build 3.22 :: push-latest-container-to-quay_3.x/5192: Console, Changes, Git Data

devspacesbuild · 2025-06-03T16:46:02Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9499:

devspaces-operator-bundle : 3.x :: Build 67811284 : quay.io/devspaces/devspaces-operator-bundle:3.22-21
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/5192 triggered;
Bundle CSV related images:
- quay.io/devspaces-tech-preview/idea-rhel9:
- quay.io/devspaces-tech-preview/jetbrains-ide-rhel9:
- quay.io/devspaces/code-rhel9:3.22-5
- quay.io/devspaces/configbump-rhel9:3.22-3
- quay.io/devspaces/dashboard-rhel9:3.22-7
- quay.io/devspaces/devspaces-rhel9-operator:3.22-5
- quay.io/devspaces/pluginregistry-rhel9:3.22-3
- quay.io/devspaces/server-rhel9:3.22-6
- quay.io/devspaces/traefik-rhel9:3.22-1
- quay.io/devspaces/udi-rhel9:3.22-3
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.14.0-202504220036.p0.gb8b8259.assembly.stream.el8
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.14.0-202504220036.p0.ga4a2f27.assembly.stream.el8
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072.1697626218

devspacesbuild · 2025-06-03T16:46:05Z

Build 3.22 :: copyIIBsToQuay/3007: Console, Changes, Git Data

devspacesbuild · 2025-06-03T16:46:06Z

Build 3.22 :: sync-to-downstream_3.x/9352:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.x/9499 triggered; /job/DS_CI/job/dsc_3.x triggered;

devspacesbuild · 2025-06-03T16:46:07Z

Build 3.22 :: operator-bundle_3.x/4919:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/9352 triggered

devspacesbuild · 2025-06-03T16:49:06Z

Build 3.22 :: update-digests_3.x/9330:

Detected new images: rebuild operator-bundle
* devspaces-operator; /DS_CI/operator-bundle_3.x/4919 triggered

devspacesbuild · 2025-06-03T16:49:18Z

Build 3.22 :: dsc_3.x/2065: Console, Changes, Git Data

devspacesbuild · 2025-06-03T16:58:12Z

Build 3.22 :: dsc_3.x/2065:

3.22.0-CI

devspacesbuild · 2025-06-03T18:48:09Z

Build 3.22 :: operator-bundle_3.x/4920: Console, Changes, Git Data

devspacesbuild · 2025-06-03T18:55:37Z

Build 3.22 :: sync-to-downstream_3.x/9354: Console, Changes, Git Data

devspacesbuild · 2025-06-03T18:59:52Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9501: Console, Changes, Git Data

devspacesbuild · 2025-06-03T19:05:24Z

Build 3.22 :: push-latest-container-to-quay_3.x/5194: Console, Changes, Git Data

devspacesbuild · 2025-06-03T19:08:51Z

Build 3.22 :: copyIIBsToQuay/3008: Console, Changes, Git Data

devspacesbuild · 2025-06-03T19:09:37Z

Build 3.22 :: get-sources-rhpkg-container-build_3.x/9501:

devspaces-operator-bundle : 3.x :: Build 67812875 : quay.io/devspaces/devspaces-operator-bundle:3.22-22
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/5194 triggered;
Bundle CSV related images:
- quay.io/devspaces-tech-preview/idea-rhel9:
- quay.io/devspaces-tech-preview/jetbrains-ide-rhel9:
- quay.io/devspaces/code-rhel9:3.22-5
- quay.io/devspaces/configbump-rhel9:3.22-3
- quay.io/devspaces/dashboard-rhel9:3.22-7
- quay.io/devspaces/devspaces-rhel9-operator:3.22-5
- quay.io/devspaces/pluginregistry-rhel9:3.22-3
- quay.io/devspaces/server-rhel9:3.22-7
- quay.io/devspaces/traefik-rhel9:3.22-1
- quay.io/devspaces/udi-rhel9:3.22-3
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.14.0-202504220036.p0.gb8b8259.assembly.stream.el8
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.14.0-202504220036.p0.ga4a2f27.assembly.stream.el8
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072.1697626218

devspacesbuild · 2025-06-03T19:09:40Z

Build 3.22 :: sync-to-downstream_3.x/9354:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.x/9501 triggered; /job/DS_CI/job/dsc_3.x triggered;

devspacesbuild · 2025-06-03T19:09:42Z

Build 3.22 :: operator-bundle_3.x/4920:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/9354 triggered

devspacesbuild · 2025-06-03T19:10:47Z

Build 3.22 :: dsc_3.x/2066: Console, Changes, Git Data

devspacesbuild · 2025-06-03T19:19:47Z

Build 3.22 :: dsc_3.x/2066:

3.22.0-CI

fix: Recreate non cached object in a user namespace

c86e99f

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha requested review from SDawley, ibuziuk and mkuznyetsov as code owners June 3, 2025 09:29

tolusha requested review from Copilot and removed request for SDawley, ibuziuk and mkuznyetsov June 3, 2025 09:29

Copilot AI reviewed Jun 3, 2025

View reviewed changes

pkg/common/utils/sync.go Show resolved Hide resolved

main.go Show resolved Hide resolved

controllers/usernamespace/pvc2sync_test.go Outdated Show resolved Hide resolved

fixup

1eed549

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha requested a review from Copilot June 3, 2025 10:13

Copilot AI reviewed Jun 3, 2025

View reviewed changes

tolusha merged commit 5183198 into main Jun 3, 2025
22 checks passed

tolusha deleted the CRW-8900 branch June 3, 2025 14:26

Conversation

tolusha commented Jun 3, 2025

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

OpenShift

on Minikube

PR Checklist

Reviewers

Uh oh!

openshift-ci bot commented Jun 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

tolusha commented Jun 3, 2025

Uh oh!

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025

Uh oh!

devspacesbuild commented Jun 3, 2025