Fix hash code reconciliation

Author: thegridman

api/v1/hasher.go

@@ -62,11 +62,3 @@ func ComputeHash(in interface{}, collisionCount *int32) string {
 
 	return rand.SafeEncodeString(fmt.Sprint(hasher.Sum32()))
 }
-
-//// DeepHashObject writes specified object to hash using the spew library
-//// which follows pointers and prints actual values of the nested objects
-//// ensuring the hash does not change when a pointer changes.
-//func DeepHashObject(hasher hash.Hash, objectToWrite interface{}) {
-//	b, _ := json.Marshal(objectToWrite)
-//	hasher.Write(b)
-//}

controllers/coherence_controller.go

@@ -221,19 +221,20 @@ func (in *CoherenceReconciler) Reconcile(ctx context.Context, request ctrl.Reque
 
 		if found {
 			// The "storeHash" is not "", so it must have been processed by the Operator (could have been a previous version).
-			// There was a bug prior to 3.2.8 where the hash was calculated at the wrong point in the defaulting web-hook,
-			// so the "currentHash" may be wrong, and hence differ from the recalculated "hash".
-			if deployment.IsBeforeVersion("3.3.0") {
+			// There was a bug prior to 3.4.2 where the hash was calculated at the wrong point in the defaulting web-hook,
+			// and the has used only a portion of the spec, so the "currentHash" may be wrong, and hence differ from the
+			// recalculated "hash".
+			if deployment.IsBeforeVersion("3.4.2") {
 				// the AnnotationOperatorVersion annotation was added in the 3.2.8 web-hook, so if it is missing
-				// the Coherence resource was added or updated prior to 3.2.8
-				// In this case we just ignore the difference in hash.
+				// the Coherence resource was added or updated prior to 3.2.8, or the version is present but is
+				// prior to 3.4.2. In this case we just ignore the difference in hash.
 				// There is an edge case where the Coherence resource could have legitimately been updated whilst
 				// the Operator and web-hooks were uninstalled. In that case we would ignore the update until another
 				// update is made. The simplest way for the customer to work around this is to add the
 				// AnnotationOperatorVersion annotation with some value, which will then be overwritten by the web-hook
 				// and the Coherence resource will be correctly processes.
 				desiredResources = storage.GetLatest()
-				log.Info("Ignoring hash difference for pre-3.2.8 resource", "hash", hash, "store", storeHash)
+				log.Info("Ignoring hash difference for pre-3.4.2 resource", "hash", hash, "store", storeHash)
 			}
 		}
 	} else {
@@ -340,6 +341,7 @@ func (in *CoherenceReconciler) SetupWithManager(mgr ctrl.Manager, cs clients.Cli
 func (in *CoherenceReconciler) GetReconciler() reconcile.Reconciler { return in }
 
 // ensureHashApplied ensures that the hash label is present in the Coherence resource, patching it if required
+// Returns true if the hash label was applied to the Coherence resource, or false if the label was already present
 func (in *CoherenceReconciler) ensureHashApplied(ctx context.Context, c *coh.Coherence) (bool, error) {
 	currentHash := ""
 	labels := c.GetLabels()

controllers/coherencejob_controller.go

@@ -163,13 +163,32 @@ func (in *CoherenceJobReconciler) ReconcileDeployment(ctx context.Context, reque
 	var desiredResources coh.Resources
 
 	storeHash, found := storage.GetHash()
-	if !found || storeHash != hash || status.Phase != coh.ConditionTypeReady {
+	if !found || storeHash != hash || deployment.Status.Phase != coh.ConditionTypeReady {
 		// Storage state was saved with no hash or a different hash so is not in the desired state
-		// or the CoherenceJob resource is not in the Ready state
+		// or the Coherence resource is not in the Ready state
 		// Create the desired resources the deployment
 		if desiredResources, err = deployment.CreateKubernetesResources(); err != nil {
 			return in.HandleErrAndRequeue(ctx, err, nil, fmt.Sprintf(createResourcesFailedMessage, request.Name, request.Namespace, err), in.Log)
 		}
+
+		if found {
+			// The "storeHash" is not "", so it must have been processed by the Operator (could have been a previous version).
+			// There was a bug prior to 3.4.2 where the hash was calculated at the wrong point in the defaulting web-hook,
+			// and the has used only a portion of the spec, so the "currentHash" may be wrong, and hence differ from the
+			// recalculated "hash".
+			if deployment.IsBeforeVersion("3.4.2") {
+				// the AnnotationOperatorVersion annotation was added in the 3.2.8 web-hook, so if it is missing
+				// the Coherence resource was added or updated prior to 3.2.8, or the version is present but is
+				// prior to 3.4.2. In this case we just ignore the difference in hash.
+				// There is an edge case where the Coherence resource could have legitimately been updated whilst
+				// the Operator and web-hooks were uninstalled. In that case we would ignore the update until another
+				// update is made. The simplest way for the customer to work around this is to add the
+				// AnnotationOperatorVersion annotation with some value, which will then be overwritten by the web-hook
+				// and the Coherence resource will be correctly processes.
+				desiredResources = storage.GetLatest()
+				log.Info("Ignoring hash difference for pre-3.4.2 resource", "hash", hash, "store", storeHash)
+			}
+		}
 	} else {
 		// storage state was saved with the current hash so is already in the desired state
 		desiredResources = storage.GetLatest()