Make (XR) readiness a top-level CompositionResult field

Just a drive-by nit. The convention in this struct is for XR scoped
stuff to be top-level, e.g. ConnectionDetails, events, etc.

Signed-off-by: Nic Cope <[email protected]>

Author: negz

internal/controller/apiextensions/composite/composed.go

@@ -22,15 +22,6 @@ import (
 	v1 "github.com/crossplane/crossplane/apis/apiextensions/v1"
 )
 
-// A CompositeResource is an output of the composition process.
-type CompositeResource struct { //nolint:revive // stick with CompositeResource
-	// Ready indicated whether the composite resource should be marked as
-	// ready or unready regardless of the state of the composed resoureces.
-	// If it is nil the readiness of the composite is determined by the
-	// readiness of the composed resources.
-	Ready *bool
-}
-
 // A ResourceName uniquely identifies the composed resource within a Composition
 // and within Composition Function gRPC calls. This is not the metadata.name of
 // the actual composed resource instance; rather it is the name of an entry in a

internal/controller/apiextensions/composite/composition_functions.go

@@ -439,16 +439,6 @@ func (c *FunctionComposer) Compose(ctx context.Context, xr *composite.Unstructur
 		}
 	}
 
-	compositeRes := CompositeResource{}
-
-	// Consider the explicit composite unready state in the function response:
-	switch d.GetComposite().GetReady() { //nolint:exhaustive // only check for false or true
-	case fnv1.Ready_READY_TRUE:
-		compositeRes.Ready = ptr.To(true)
-	case fnv1.Ready_READY_FALSE:
-		compositeRes.Ready = ptr.To(false)
-	}
-
 	// Garbage collect any observed resources that aren't part of our final
 	// desired state. We must do this before we update the XR's resource
 	// references to ensure that we don't forget and leak them if a delete
@@ -563,14 +553,25 @@ func (c *FunctionComposer) Compose(ctx context.Context, xr *composite.Unstructur
 		return CompositionResult{}, errors.Wrap(err, errApplyXRStatus)
 	}
 
+	var ready *bool
+	switch d.GetComposite().GetReady() {
+	case fnv1.Ready_READY_TRUE:
+		ready = ptr.To(true)
+	case fnv1.Ready_READY_FALSE:
+		ready = ptr.To(false)
+	case fnv1.Ready_READY_UNSPECIFIED:
+		// Remains nil.
+	}
+
 	result := CompositionResult{
-		ConnectionDetails: d.GetComposite().GetConnectionDetails(),
-		Composite:         compositeRes,
 		Composed:          resources,
+		ConnectionDetails: d.GetComposite().GetConnectionDetails(),
+		Ready:             ready,
 		Events:            events,
 		Conditions:        conditions,
 		TTL:               ttl,
 	}
+
 	return result, nil
 }
 

internal/controller/apiextensions/composite/reconciler.go

@@ -157,12 +157,23 @@ type CompositionRequest struct {
 
 // A CompositionResult is the result of the composition process.
 type CompositionResult struct {
-	Composite         CompositeResource
-	Composed          []ComposedResource
+	// Composed resource details.
+	Composed []ComposedResource
+
+	// XR connection details.
 	ConnectionDetails managed.ConnectionDetails
-	Events            []TargetedEvent
-	Conditions        []TargetedCondition
-	TTL               time.Duration
+
+	// XR readiness. When nil readiness is derived from composed resources.
+	Ready *bool
+
+	// XR and claim events.
+	Events []TargetedEvent
+
+	// XR and claim conditions.
+	Conditions []TargetedCondition
+
+	// TTL for this composition result.
+	TTL time.Duration
 }
 
 // A CompositionTarget is the target of a composition event or condition.
@@ -679,9 +690,9 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reco
 
 	// If the composer explicitly specified the XR's readiness it
 	// supersedes readiness derived from composed resources.
-	if res.Composite.Ready != nil {
+	if res.Ready != nil {
 		ready = xpv1.Creating()
-		if *res.Composite.Ready {
+		if *res.Ready {
 			ready = xpv1.Available()
 		}
 	}

internal/controller/apiextensions/composite/reconciler_test.go

@@ -29,6 +29,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
@@ -1257,11 +1258,9 @@ func TestReconcile(t *testing.T) {
 					})),
 					WithComposer(ComposerFn(func(_ context.Context, _ *composite.Unstructured, _ CompositionRequest) (CompositionResult, error) {
 						return CompositionResult{
-							Composite: CompositeResource{
-								Ready: &valBoolFalse,
-							},
 							Composed:          []ComposedResource{},
 							ConnectionDetails: cd,
+							Ready:             ptr.To(false),
 							Events:            []TargetedEvent{},
 							Conditions:        []TargetedCondition{},
 						}, nil