Remove the Request

Author: josvazg

internal/crapi/crapi.go

@@ -38,7 +38,9 @@ type Translator interface {
 	Mappings() ([]*refs.Mapping, error)
 }
 
-// Request holds common parameters for all translation request
+// Request is deprecated do not use
+//
+// Deprecated: request is no longer used in the ToAPI and FromAPI calls
 type Request struct {
 	Translator   Translator
 	Dependencies []client.Object
@@ -47,13 +49,13 @@ type Request struct {
 // APIImporter can translate itself into Kubernetes Objects.
 // Use to customize or accelerate translations ad-hoc
 type APIImporter[T any, P refs.PtrClientObj[T]] interface {
-	FromAPI(tr *Request, target P) ([]client.Object, error)
+	FromAPI(tr Translator, target P, objs ...client.Object) ([]client.Object, error)
 }
 
 // APIExporter can translate itself to an API Object.
 // Use to customize or accelerate translations ad-hoc
 type APIExporter[T any] interface {
-	ToAPI(tr *Request, target *T) error
+	ToAPI(tr Translator, target *T, objs ...client.Object) error
 }
 
 // ToAPI translates a source Kubernetes spec into a target API structure.
@@ -62,18 +64,18 @@ type APIExporter[T any] interface {
 // The source is set to the Kubernetes CR value. Only the spec data is used here.
 // The request includes the translator and the dependencies associated with the
 // source CR, usually Kubernetes secrets.
-func ToAPI[T any](r *Request, target *T, source client.Object) error {
+func ToAPI[T any](tr Translator, target *T, source client.Object, objs ...client.Object) error {
 	exporter, ok := (source).(APIExporter[T])
 	if ok {
-		return exporter.ToAPI(r, target)
+		return exporter.ToAPI(tr, target)
 	}
 	unstructuredSrc, err := unstructured.ToUnstructured(source)
 	if err != nil {
 		return fmt.Errorf("failed to convert k8s source value to unstructured: %w", err)
 	}
 	targetUnstructured := map[string]any{}
 
-	if err := collapseReferences(r, unstructuredSrc, source); err != nil {
+	if err := collapseReferences(tr, unstructuredSrc, source, objs); err != nil {
 		return fmt.Errorf("failed to process API mappings: %w", err)
 	}
 
@@ -82,7 +84,7 @@ func ToAPI[T any](r *Request, target *T, source client.Object) error {
 		return fmt.Errorf("target must be a struct but got %v", targetType.Kind())
 	}
 
-	value, err := unstructured.GetField[map[string]any](unstructuredSrc, "spec", r.Translator.MajorVersion())
+	value, err := unstructured.GetField[map[string]any](unstructuredSrc, "spec", tr.MajorVersion())
 	if err != nil {
 		return fmt.Errorf("failed to access source spec value: %w", err)
 	}
@@ -108,10 +110,10 @@ func ToAPI[T any](r *Request, target *T, source client.Object) error {
 // objects, such as Kubernetes secrets, for instance. This list does not include
 // the mutated target, and will be empty if nothing else was extracted off the ç
 // response.
-func FromAPI[S any, T any, P refs.PtrClientObj[T]](r *Request, target P, source *S) ([]client.Object, error) {
+func FromAPI[S any, T any, P refs.PtrClientObj[T]](tr Translator, target P, source *S, objs ...client.Object) ([]client.Object, error) {
 	importer, ok := any(source).(APIImporter[T, P])
 	if ok {
-		return importer.FromAPI(r, target)
+		return importer.FromAPI(tr, target, objs...)
 	}
 	sourceUnstructured, err := unstructured.ToUnstructured(source)
 	if err != nil {
@@ -124,12 +126,12 @@ func FromAPI[S any, T any, P refs.PtrClientObj[T]](r *Request, target P, source
 	}
 
 	versionedSpec, err := unstructured.GetOrCreateField(
-		targetUnstructured, map[string]any{}, "spec", r.Translator.MajorVersion())
+		targetUnstructured, map[string]any{}, "spec", tr.MajorVersion())
 	if err != nil {
 		return nil, fmt.Errorf("failed to ensure versioned spec object in unstructured target: %w", err)
 	}
 	versionedStatus, err := unstructured.GetOrCreateField(
-		targetUnstructured, map[string]any{}, "status", r.Translator.MajorVersion())
+		targetUnstructured, map[string]any{}, "status", tr.MajorVersion())
 	if err != nil {
 		return nil, fmt.Errorf("failed to create versioned status object in unstructured target: %w", err)
 	}
@@ -140,7 +142,7 @@ func FromAPI[S any, T any, P refs.PtrClientObj[T]](r *Request, target P, source
 	versionedSpec["entry"] = versionedSpecEntry
 	unstructured.CopyFields(versionedStatus, sourceUnstructured)
 
-	extraObjects, err := expandReferences(r, targetUnstructured, target)
+	extraObjects, err := expandReferences(tr, targetUnstructured, target, objs)
 	if err != nil {
 		return nil, fmt.Errorf("failed to process API mappings: %w", err)
 	}
@@ -153,23 +155,23 @@ func FromAPI[S any, T any, P refs.PtrClientObj[T]](r *Request, target P, source
 // collapseReferences finds all Kubernetes references, solves them and collapses
 // them by replacing their values from the reference (e.g Kubernetes secret or
 // group), into the corresponding API request value
-func collapseReferences(r *Request, req map[string]any, main client.Object) error {
-	mappings, err := r.Translator.Mappings()
+func collapseReferences(tr Translator, req map[string]any, main client.Object, objs []client.Object) error {
+	mappings, err := tr.Mappings()
 	if err != nil {
 		return fmt.Errorf("failed to extract mappings to collapse: %w", err)
 	}
-	return refs.CollapseAll(mappings, main, r.Dependencies, req)
+	return refs.CollapseAll(mappings, main, objs, req)
 }
 
 // expandReferences finds all API fields that must be referenced, and expand
 // such reference, moving the value (e.g. sensitive field or group id) to a
 // referenced Kubernetes object (e.g. Kubernetes secret or Atlas Group)
-func expandReferences(r *Request, cr map[string]any, main client.Object) ([]client.Object, error) {
-	mappings, err := r.Translator.Mappings()
+func expandReferences(tr Translator, cr map[string]any, main client.Object, objs []client.Object) ([]client.Object, error) {
+	mappings, err := tr.Mappings()
 	if err != nil {
 		return nil, fmt.Errorf("failed to extract mappings to expand: %w", err)
 	}
-	return refs.ExpandAll(mappings, main, r.Dependencies, cr)
+	return refs.ExpandAll(mappings, main, objs, cr)
 }
 
 func propertyValueOrNil(schema *openapi3.Schema, propertyName string) *openapi3.Schema {

internal/crapi/crapi_test.go

@@ -407,8 +407,7 @@ func testFromAPI[S any, T any, P refs.PtrClientObj[T]](t *testing.T, kind string
 	require.NoError(t, err)
 	tr, err := crapi.NewTranslator(crd, version, sdkVersion)
 	require.NoError(t, err)
-	r := crapi.Request{Translator: tr}
-	results, err := crapi.FromAPI(&r, target, input)
+	results, err := crapi.FromAPI(tr, target, input)
 	require.NoError(t, err)
 	assert.Equal(t, want, target)
 	assert.Equal(t, wantDeps, results)
@@ -578,8 +577,7 @@ func TestToAPIAllRefs(t *testing.T) {
 			require.NoError(t, err)
 			tr, err := crapi.NewTranslator(crd, version, sdkVersion)
 			require.NoError(t, err)
-			r := crapi.Request{Translator: tr, Dependencies: tc.deps}
-			require.NoError(t, crapi.ToAPI(&r, &tc.target, tc.input))
+			require.NoError(t, crapi.ToAPI(tr, &tc.target, tc.input, tc.deps...))
 			assert.Equal(t, tc.want, tc.target)
 		})
 	}
@@ -2007,8 +2005,7 @@ func testToAPI[T any](t *testing.T, kind string, input client.Object, objs []cli
 	require.NoError(t, err)
 	tr := trs[sdkVersion]
 	require.NotNil(t, tr)
-	r := crapi.Request{Translator: tr, Dependencies: objs}
-	require.NoError(t, crapi.ToAPI(&r, target, input))
+	require.NoError(t, crapi.ToAPI(tr, target, input, objs...))
 	assert.Equal(t, want, target)
 }