workflow/meta: Correctly update status description (#129)

Author: andrewwormald

delete.go

@@ -71,6 +71,7 @@ func runDelete(
 			store,
 			record,
 			RunStateRequestedDataDeleted,
+			record.Meta.StatusDescription,
 		)
 	}
 }

runstate.go

@@ -126,7 +126,7 @@ func (rsc *runStateControllerImpl) update(ctx context.Context, rs RunState, reas
 	previousRunState := rsc.record.RunState
 	rsc.record.RunState = rs
 	rsc.record.Meta.RunStateReason = reason
-	return updateRecord(ctx, rsc.store, rsc.record, previousRunState)
+	return updateRecord(ctx, rsc.store, rsc.record, previousRunState, rsc.record.Meta.StatusDescription)
 }
 
 var runStateTransitions = map[RunState]map[RunState]bool{

trigger.go

@@ -97,7 +97,7 @@ func trigger[Type any, Status StatusType](
 		Meta:         meta,
 	}
 
-	err = updateRecord(ctx, store, wr, RunStateUnknown)
+	err = updateRecord(ctx, store, wr, RunStateUnknown, startingStatus.String())
 	if err != nil {
 		return "", err
 	}

update.go

@@ -63,7 +63,7 @@ func newUpdater[Type any, Status StatusType](
 			return err
 		}
 
-		return updateRecord(ctx, store, updatedRecord, record.RunState)
+		return updateRecord(ctx, store, updatedRecord, record.RunState, next.String())
 	}
 }
 
@@ -91,11 +91,18 @@ func validateTransition[Status StatusType](current, next Status, graph *graph.Gr
 	return nil
 }
 
-func updateRecord(ctx context.Context, store storeFunc, record *Record, previousRunState RunState) error {
+func updateRecord(
+	ctx context.Context,
+	store storeFunc,
+	record *Record,
+	previousRunState RunState,
+	statusDescription string,
+) error {
 	// Push run state changes for observability
 	metrics.RunStateChanges.WithLabelValues(record.WorkflowName, previousRunState.String(), record.RunState.String()).
 		Inc()
 
+	record.Meta.StatusDescription = statusDescription
 	// Increment the version by 1.
 	record.Meta.Version++
 

workflow_test.go

@@ -151,6 +151,7 @@ func TestWorkflowAcceptanceTest(t *testing.T) {
 	r, err := recordStore.Latest(ctx, wf.Name(), fid)
 	require.Nil(t, err)
 	require.Equal(t, int(expectedFinalStatus), r.Status)
+	require.Equal(t, "Completed", r.Meta.StatusDescription)
 
 	var actual MyType
 	err = workflow.Unmarshal(r.Object, &actual)