refactor: introduce constants for DefaultServicePort and ForceRefreshAnnotation in ScalityUIComponent

Author: ZiyangLinScality

internal/controller/scalityuicomponent/constants.go

@@ -0,0 +1,9 @@
+package scalityuicomponent
+
+const (
+	// DefaultServicePort is the default port used to connect to the UI component service
+	DefaultServicePort = 80
+
+	// ForceRefreshAnnotation is the annotation key to trigger a force refresh of the configuration
+	ForceRefreshAnnotation = "ui.scality.com/force-refresh"
+)

internal/controller/scalityuicomponent/controller.go

@@ -22,9 +22,6 @@ import (
 	uiv1alpha1 "github.com/scality/ui-operator/api/v1alpha1"
 )
 
-// DefaultServicePort is the default port used to connect to the UI component service
-const DefaultServicePort = 80
-
 // MicroAppConfig represents the structure of the micro-app-configuration file
 type MicroAppConfig struct {
 	Kind       string     `json:"kind"`
@@ -325,7 +322,7 @@ func (r *ScalityUIComponentReconciler) processUIComponentConfig(ctx context.Cont
 
 	// Check for force-refresh annotation
 	if scalityUIComponent.Annotations != nil {
-		if val, exists := scalityUIComponent.Annotations["ui.scality.com/force-refresh"]; exists && val == "true" {
+		if val, exists := scalityUIComponent.Annotations[ForceRefreshAnnotation]; exists && val == "true" {
 			needsFetch = true
 			reasons = append(reasons, "force-refresh annotation present")
 		}
@@ -483,7 +480,7 @@ func (r *ScalityUIComponentReconciler) removeForceRefreshAnnotation(ctx context.
 		return
 	}
 
-	if _, exists := scalityUIComponent.Annotations["ui.scality.com/force-refresh"]; !exists {
+	if _, exists := scalityUIComponent.Annotations[ForceRefreshAnnotation]; !exists {
 		return
 	}
 
@@ -502,11 +499,11 @@ func (r *ScalityUIComponentReconciler) removeForceRefreshAnnotation(ctx context.
 			return nil
 		}
 
-		if _, exists := fresh.Annotations["ui.scality.com/force-refresh"]; !exists {
+		if _, exists := fresh.Annotations[ForceRefreshAnnotation]; !exists {
 			return nil
 		}
 
-		delete(fresh.Annotations, "ui.scality.com/force-refresh")
+		delete(fresh.Annotations, ForceRefreshAnnotation)
 		return r.Update(ctx, fresh)
 	})
 

internal/controller/scalityuicomponent/controller_test.go

@@ -990,7 +990,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 			if scalityUIComponent.Annotations == nil {
 				scalityUIComponent.Annotations = make(map[string]string)
 			}
-			scalityUIComponent.Annotations["ui.scality.com/force-refresh"] = "true"
+			scalityUIComponent.Annotations[ForceRefreshAnnotation] = "true"
 			Expect(k8sClient.Update(ctx, scalityUIComponent)).To(Succeed())
 
 			By("Update mock to return different config")
@@ -1011,7 +1011,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 
 			By("Verify force-refresh annotation was removed")
 			Expect(k8sClient.Get(ctx, typeNamespacedName, scalityUIComponent)).To(Succeed())
-			_, hasAnnotation := scalityUIComponent.Annotations["ui.scality.com/force-refresh"]
+			_, hasAnnotation := scalityUIComponent.Annotations[ForceRefreshAnnotation]
 			Expect(hasAnnotation).To(BeFalse(), "force-refresh annotation should be removed after fetch")
 
 			By("Fifth reconcile - no fetch (annotation removed, image unchanged)")
@@ -1028,7 +1028,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 					Name:      "test-force-refresh-failure",
 					Namespace: "default",
 					Annotations: map[string]string{
-						"ui.scality.com/force-refresh": "true",
+						ForceRefreshAnnotation: "true",
 					},
 				},
 				Spec: uiv1alpha1.ScalityUIComponentSpec{
@@ -1075,7 +1075,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 
 			By("Verify force-refresh annotation was NOT removed on fetch failure (only removed on parse/validation failure)")
 			Expect(k8sClient.Get(ctx, typeNamespacedName, scalityUIComponent)).To(Succeed())
-			_, hasAnnotation := scalityUIComponent.Annotations["ui.scality.com/force-refresh"]
+			_, hasAnnotation := scalityUIComponent.Annotations[ForceRefreshAnnotation]
 			Expect(hasAnnotation).To(BeTrue(), "force-refresh annotation should remain on fetch failure for retry")
 		})
 
@@ -1087,7 +1087,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 					Name:      "test-force-refresh-parse-fail",
 					Namespace: "default",
 					Annotations: map[string]string{
-						"ui.scality.com/force-refresh": "true",
+						ForceRefreshAnnotation: "true",
 					},
 				},
 				Spec: uiv1alpha1.ScalityUIComponentSpec{
@@ -1132,7 +1132,7 @@ var _ = Describe("ScalityUIComponent Controller", func() {
 
 			By("Verify force-refresh annotation was removed on parse failure")
 			Expect(k8sClient.Get(ctx, typeNamespacedName, scalityUIComponent)).To(Succeed())
-			_, hasAnnotation := scalityUIComponent.Annotations["ui.scality.com/force-refresh"]
+			_, hasAnnotation := scalityUIComponent.Annotations[ForceRefreshAnnotation]
 			Expect(hasAnnotation).To(BeFalse(), "force-refresh annotation should be removed on parse failure")
 		})
 	})