go/control/api: Improve node registration status clarity

.changelog/5256.feature.md

@@ -0,0 +1,10 @@
+go/control/api: Improve node registration status clarity
+
+Two new fields have been added to the node's control status output
+under the registration status section:
+
+- `successful` - true if the registration succeeded.
+- `error` - error message if the registration failed.
+
+Also, if the registration descriptor is expired, it is no longer
+shown in the output.

go/control/api/api.go

@@ -124,6 +124,12 @@ type IdentityStatus struct {
 
 // RegistrationStatus is the node registration status.
 type RegistrationStatus struct {
+	// Successful is true if the current registration has been successful.
+	Successful bool `json:"successful"`
+
+	// Error contains the error message if the current registration has not been successful.
+	Error string `json:"error,omitempty"`
+
 	// LastRegistration is the time of the last successful registration with the consensus registry
 	// service. In case the node did not successfully register yet, it will be the zero timestamp.
 	LastRegistration time.Time `json:"last_registration"`

go/worker/registration/worker.go

@@ -899,6 +899,16 @@ func (w *Worker) registerNode(epoch beacon.EpochTime, hook RegisterNodeHook) err
 	}
 
 	if err := hook(&nodeDesc); err != nil {
+		w.Lock()
+		w.status.Successful = false
+		w.status.Error = err.Error()
+		if w.status.Descriptor != nil {
+			if w.status.Descriptor.Expiration < uint64(epoch) {
+				w.status.Descriptor = nil
+			}
+		}
+		w.Unlock()
+
 		return err
 	}
 
@@ -908,7 +918,20 @@ func (w *Worker) registerNode(epoch beacon.EpochTime, hook RegisterNodeHook) err
 		w.logger.Error("not registering: no runtimes provided while runtimes are required",
 			"node_descriptor", nodeDesc,
 		)
-		return fmt.Errorf("registration: no runtimes provided while runtimes are required")
+
+		err := fmt.Errorf("registration: no runtimes provided while runtimes are required")
+
+		w.Lock()
+		w.status.Successful = false
+		w.status.Error = err.Error()
+		if w.status.Descriptor != nil {
+			if w.status.Descriptor.Expiration < uint64(epoch) {
+				w.status.Descriptor = nil
+			}
+		}
+		w.Unlock()
+
+		return err
 	}
 
 	sentryConsensusAddrs := w.querySentries()
@@ -917,7 +940,19 @@ func (w *Worker) registerNode(epoch beacon.EpochTime, hook RegisterNodeHook) err
 	if nodeDesc.HasRoles(registry.ConsensusAddressRequiredRoles) {
 		addrs, err := w.gatherConsensusAddresses(sentryConsensusAddrs)
 		if err != nil {
-			return fmt.Errorf("error gathering consensus addresses: %w", err)
+			err = fmt.Errorf("error gathering consensus addresses: %w", err)
+
+			w.Lock()
+			w.status.Successful = false
+			w.status.Error = err.Error()
+			if w.status.Descriptor != nil {
+				if w.status.Descriptor.Expiration < uint64(epoch) {
+					w.status.Descriptor = nil
+				}
+			}
+			w.Unlock()
+
+			return err
 		}
 		nodeDesc.Consensus.Addresses = addrs
 	}
@@ -946,6 +981,18 @@ func (w *Worker) registerNode(epoch beacon.EpochTime, hook RegisterNodeHook) err
 		w.logger.Error("failed to register node: unable to sign node descriptor",
 			"err", err,
 		)
+		err = fmt.Errorf("unable to sign node descriptor: %w", err)
+
+		w.Lock()
+		w.status.Successful = false
+		w.status.Error = err.Error()
+		if w.status.Descriptor != nil {
+			if w.status.Descriptor.Expiration < uint64(epoch) {
+				w.status.Descriptor = nil
+			}
+		}
+		w.Unlock()
+
 		return err
 	}
 
@@ -954,14 +1001,27 @@ func (w *Worker) registerNode(epoch beacon.EpochTime, hook RegisterNodeHook) err
 		w.logger.Error("failed to register node",
 			"err", err,
 		)
+
+		w.Lock()
+		w.status.Successful = false
+		w.status.Error = err.Error()
+		if w.status.Descriptor != nil {
+			if w.status.Descriptor.Expiration < uint64(epoch) {
+				w.status.Descriptor = nil
+			}
+		}
+		w.Unlock()
+
 		return err
 	}
 
 	// Update the registration status on successful registration.
-	w.RLock()
+	w.Lock()
+	w.status.Successful = true
+	w.status.Error = ""
 	w.status.LastRegistration = time.Now()
 	w.status.Descriptor = &nodeDesc
-	w.RUnlock()
+	w.Unlock()
 
 	w.logger.Info("node registered with the registry")
 	return nil