tags

Author: rushmash91

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,8 +1,8 @@
 ack_generate_info:
-  build_date: "2025-04-07T06:55:50Z"
-  build_hash: bf1bf427cd755bcbc37414eaea9e1d66465bc422
-  go_version: go1.24.1
-  version: v0.44.0-2-gbf1bf42-dirty
+  build_date: "2025-04-07T19:07:06Z"
+  build_hash: 69bbc9e5bb5b9f137ea46a4a605411e5e2ddd371
+  go_version: go1.24.0
+  version: v0.43.2-13-g69bbc9e-dirty
 api_directory_checksum: f1f3604161839adf828e8ecdbca457e930c7efa9
 api_version: v1alpha1
 aws_sdk_go_version: v1.32.6

generator.yaml

@@ -236,6 +236,8 @@ resources:
           input_fields:
             ApiKey: Id
     hooks:
+      delta_pre_compare:
+        code: compareTags(delta, a, b)
       sdk_update_post_build_request:
         template_path: hooks/api_key/sdk_update_post_build_request.go.tpl
       sdk_read_one_post_request:

pkg/resource/api_key/hooks.go

@@ -14,10 +14,12 @@
 package api_key
 
 import (
+	"context"
 	"fmt"
 	"strings"
 
 	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	"github.com/aws/aws-sdk-go-v2/aws"
 	svcsdk "github.com/aws/aws-sdk-go-v2/service/apigateway"
 	svcsdktypes "github.com/aws/aws-sdk-go-v2/service/apigateway/types"
@@ -43,6 +45,9 @@ func updateApiKeyInput(desired *resource, input *svcsdk.UpdateApiKeyInput, delta
 		patchSet.Replace("/customerId", desiredSpec.CustomerID)
 	}
 
+	// Tags are managed through separate TagResource/UntagResource APIs,
+	// not through patch operations in UpdateApiKey
+
 	// Handle StageKeys with add/remove operations
 	if delta.DifferentAt("Spec.StageKeys") && desiredSpec.StageKeys != nil {
 		// Convert StageKey objects to strings in the format "restApiId/stageName"
@@ -65,3 +70,127 @@ func updateApiKeyInput(desired *resource, input *svcsdk.UpdateApiKeyInput, delta
 	patchOps := patchSet.GetPatchOperations()
 	input.PatchOperations = append(patchOps, stageKeyPatches...)
 }
+
+// syncTags keeps tags in sync by calling TagResource and UntagResource APIs
+func (rm *resourceManager) syncTags(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncTags")
+	defer func() {
+		exit(err)
+	}()
+
+	if latest.ko.Status.ACKResourceMetadata == nil || latest.ko.Status.ACKResourceMetadata.ARN == nil {
+		return fmt.Errorf("resource ARN is nil")
+	}
+
+	resourceARN := aws.String(string(*latest.ko.Status.ACKResourceMetadata.ARN))
+
+	desiredTagsMap := desired.ko.Spec.Tags
+	latestTagsMap := latest.ko.Spec.Tags
+
+	desiredTags, _ := convertToOrderedACKTags(desiredTagsMap)
+	latestTags, _ := convertToOrderedACKTags(latestTagsMap)
+
+	added, updated, removed := ackcompare.GetTagsDifference(latestTags, desiredTags)
+
+	// Combine added and updated tags
+	toAdd := make(map[string]string)
+	for k, v := range added {
+		toAdd[k] = v
+	}
+	for k, v := range updated {
+		toAdd[k] = v
+	}
+
+	var toRemoveTagKeys []string
+	for k := range removed {
+		toRemoveTagKeys = append(toRemoveTagKeys, k)
+	}
+
+	// Remove tags using UntagResource API:
+	if len(toRemoveTagKeys) > 0 {
+		rlog.Debug("removing tags from resource", "tags", toRemoveTagKeys)
+		_, err = rm.sdkapi.UntagResource(
+			ctx,
+			&svcsdk.UntagResourceInput{
+				ResourceArn: resourceARN,
+				TagKeys:     toRemoveTagKeys,
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "UntagResource", err)
+		if err != nil {
+			return err
+		}
+	}
+
+	// Add tags using TagResource API
+	if len(toAdd) > 0 {
+		rlog.Debug("adding tags to resource", "tags", toAdd)
+		_, err = rm.sdkapi.TagResource(
+			ctx,
+			&svcsdk.TagResourceInput{
+				ResourceArn: resourceARN,
+				Tags:        toAdd,
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "TagResource", err)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func compareTags(
+	delta *ackcompare.Delta,
+	a *resource,
+	b *resource,
+) {
+	if len(a.ko.Spec.Tags) != len(b.ko.Spec.Tags) {
+		delta.Add("Spec.Tags", a.ko.Spec.Tags, b.ko.Spec.Tags)
+	} else if len(a.ko.Spec.Tags) > 0 {
+		// Convert map[string]*string to acktags.Tags for GetTagsDifference
+		aTagsConverted, _ := convertToOrderedACKTags(a.ko.Spec.Tags)
+		bTagsConverted, _ := convertToOrderedACKTags(b.ko.Spec.Tags)
+
+		added, updated, removed := ackcompare.GetTagsDifference(bTagsConverted, aTagsConverted)
+		if len(added) != 0 || len(updated) != 0 || len(removed) != 0 {
+			delta.Add("Spec.Tags", a.ko.Spec.Tags, b.ko.Spec.Tags)
+		}
+	}
+}
+
+// fetchCurrentTags returns the current tags for the resource
+// using the GetTags API: GET /tags/resource_arn
+func (rm *resourceManager) fetchCurrentTags(
+	ctx context.Context,
+	resourceARN *string,
+) (map[string]string, error) {
+	output, err := rm.sdkapi.GetTags(
+		ctx,
+		&svcsdk.GetTagsInput{
+			ResourceArn: resourceARN,
+		},
+	)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return output.Tags, nil
+}
+
+// CustomResourcesDifference helps return differences in custom resources
+func (rm *resourceManager) CustomResourcesDifference(
+	a *resource,
+	b *resource,
+) *ackcompare.Delta {
+	delta := ackcompare.NewDelta()
+	compareTags(delta, a, b)
+	return delta
+}

pkg/resource/rest_api/sdk.go

@@ -14,4 +14,14 @@
 		r.ko.Spec.StageKeys = stageKeys
 	} else {
 		r.ko.Spec.StageKeys = nil
-	} 
+	} 
+
+	// fetch tags
+	if r.ko.Status.ACKResourceMetadata != nil && r.ko.Status.ACKResourceMetadata.ARN != nil {
+		resourceARN := string(*r.ko.Status.ACKResourceMetadata.ARN)
+		tags, err := rm.fetchCurrentTags(ctx, &resourceARN)
+		if err != nil {
+			return nil, err
+		}
+		r.ko.Spec.Tags = aws.StringMap(tags)
+	}

templates/hooks/api_key/sdk_read_one_post_request.go.tpl

@@ -0,0 +1,14 @@
+
+	// Handle tag updates separately through TagResource/UntagResource APIs
+	if delta.DifferentAt("Spec.Tags") {
+		err = rm.syncTags(ctx, desired, latest)
+		if err != nil {
+			return nil, err
+		}
+	}
+	
+	// If only tags were different, return early
+	if !delta.DifferentExcept("Spec.Tags") {
+		return desired, nil
+	}
+