load and store cluster path in sync context

On-behalf-of: @SAP [email protected]

Author: xrstf

Diff for: go.mod

@@ -70,7 +70,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/mitchellh/mapstructure v1.3.3 // indirect
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect

Diff for: go.sum

@@ -229,8 +229,8 @@ github.com/mitchellh/gox v0.4.0/go.mod h1:Sd9lOJ0+aimLBi73mGofS1ycjY8lL3uZM3JPS4
 github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0QubkSMEySY=
 github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
-github.com/mitchellh/mapstructure v1.3.3 h1:SzB1nHZ2Xi+17FP0zVQBHIZqvwRN9408fJO8h+eeNA8=
-github.com/mitchellh/mapstructure v1.3.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/mitchellh/mapstructure v1.4.1 h1:CpVNEelQCZBooIPDn+AR3NpivK/TIKU8bDxdASFVQag=
+github.com/mitchellh/mapstructure v1.4.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
 github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

Diff for: internal/controller/sync/controller.go

@@ -21,6 +21,8 @@ import (
 	"fmt"
 	"time"
 
+	kcpcore "github.com/kcp-dev/kcp/sdk/apis/core"
+	kcpdevcorev1alpha1 "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
 	"github.com/kcp-dev/logicalcluster/v3"
 	"go.uber.org/zap"
 
@@ -31,6 +33,7 @@ import (
 	syncagentv1alpha1 "github.com/kcp-dev/api-syncagent/sdk/apis/syncagent/v1alpha1"
 
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 	ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/cluster"
@@ -52,6 +55,7 @@ type Reconciler struct {
 	log         *zap.SugaredLogger
 	syncer      *sync.ResourceSyncer
 	remoteDummy *unstructured.Unstructured
+	pubRes      *syncagentv1alpha1.PublishedResource
 }
 
 // Create creates a new controller and importantly does *not* add it to the manager,
@@ -99,6 +103,7 @@ func Create(
 		log:         log,
 		remoteDummy: remoteDummy,
 		syncer:      syncer,
+		pubRes:      pubRes,
 	}
 
 	ctrlOptions := controller.Options{
@@ -152,8 +157,22 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
 		return reconcile.Result{}, nil
 	}
 
+	syncContext := sync.NewContext(ctx, wsCtx)
+
+	// if desired, fetch the cluster path as well (some downstream service providers might make use of it,
+	// but since it requires an additional permission claim, it's optional)
+	if r.pubRes.Spec.EnableClusterPaths {
+		lc := &kcpdevcorev1alpha1.LogicalCluster{}
+		if err := r.vwClient.Get(wsCtx, types.NamespacedName{Name: kcpdevcorev1alpha1.LogicalClusterName}, lc); err != nil {
+			return reconcile.Result{}, fmt.Errorf("failed to retrieve remote logicalcluster: %w", err)
+		}
+
+		path := lc.Annotations[kcpcore.LogicalClusterPathAnnotationKey]
+		syncContext = syncContext.WithClusterPath(logicalcluster.NewPath(path))
+	}
+
 	// sync main object
-	requeue, err := r.syncer.Process(sync.NewContext(ctx, wsCtx), remoteObj)
+	requeue, err := r.syncer.Process(syncContext, remoteObj)
 	if err != nil {
 		return reconcile.Result{}, err
 	}

Diff for: internal/controller/syncmanager/lifecycle/cluster.go

@@ -24,10 +24,12 @@ import (
 	"regexp"
 	"strings"
 
+	kcpdevcorev1alpha1 "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
 	"github.com/kcp-dev/logicalcluster/v3"
 	"go.uber.org/zap"
 
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
@@ -130,7 +132,14 @@ func NewCluster(address string, baseRestConfig *rest.Config) (*Cluster, error) {
 		return newClusterAwareRoundTripper(rt)
 	})
 
+	scheme := runtime.NewScheme()
+
+	if err := kcpdevcorev1alpha1.AddToScheme(scheme); err != nil {
+		return nil, fmt.Errorf("failed to register scheme %s: %w", kcpdevcorev1alpha1.SchemeGroupVersion, err)
+	}
+
 	clusterObj, err := cluster.New(config, func(o *cluster.Options) {
+		o.Scheme = scheme
 		o.NewCache = kcp.NewClusterAwareCache
 		o.NewAPIReader = kcp.NewClusterAwareAPIReader
 		o.NewClient = kcp.NewClusterAwareClient

Diff for: internal/sync/context.go

@@ -19,11 +19,13 @@ package sync
 import (
 	"context"
 
+	"github.com/kcp-dev/logicalcluster/v3"
 	"sigs.k8s.io/controller-runtime/pkg/kontext"
 )
 
 type Context struct {
-	clusterName string
+	clusterName logicalcluster.Name
+	clusterPath logicalcluster.Path
 	local       context.Context
 	remote      context.Context
 }
@@ -35,8 +37,17 @@ func NewContext(local, remote context.Context) Context {
 	}
 
 	return Context{
-		clusterName: string(clusterName),
+		clusterName: clusterName,
 		local:       local,
 		remote:      remote,
 	}
 }
+
+func (c *Context) WithClusterPath(path logicalcluster.Path) Context {
+	return Context{
+		clusterName: c.clusterName,
+		clusterPath: path,
+		local:       c.local,
+		remote:      c.remote,
+	}
+}

Diff for: internal/sync/context_test.go

@@ -31,7 +31,7 @@ func TestNewContext(t *testing.T) {
 
 	combinedCtx := NewContext(context.Background(), ctx)
 
-	if combinedCtx.clusterName != clusterName.String() {
+	if combinedCtx.clusterName != clusterName {
 		t.Fatalf("Expected function to recognize the cluster name in the context, but got %q", combinedCtx.clusterName)
 	}
 }