Record actions as well as sub-status types in the history summary

Signed-off-by: Matthew Whitehead <[email protected]>

Author: matthew1001

pkg/apitypes/managed_tx.go

@@ -62,8 +62,10 @@ type TxHistoryStateTransitionEntry struct {
 // subStatus was entered. Because the detailed history might wrap, this means we can retain some basic
 // information about the complete history of the transaction beyond the life of the individual history records.
 type TxHistorySummaryEntry struct {
-	Status          TxSubStatus     `json:"subStatus"`
+	Status          TxSubStatus     `json:"subStatus,omitempty"`
+	Action          TxAction        `json:"action,omitempty"`
 	FirstOccurrence *fftypes.FFTime `json:"firstOccurrence"`
+	LastOccurrence  *fftypes.FFTime `json:"lastOccurrence"`
 	Count           int             `json:"count"`
 }
 

pkg/txhistory/txhistory.go

@@ -81,19 +81,20 @@ func (h *manager) SetSubStatus(ctx context.Context, mtx *apitypes.ManagedTX, sub
 		mtx.History = mtx.History[1:]
 	}
 
-	// As was as detailed sub-status records (which might be a long list and early entries
+	// As we have a possibly indefinite list of sub-status records (which might be a long list and early entries
 	// get purged at some point) we keep a separate list of all the discrete types of sub-status
-	// we've ever seen for this transaction along with a count of them. This means an early sub-status
+	// and action we've we've ever seen for this transaction along with a count of them. This means an early sub-status
 	// (e.g. "queued") followed by 100s of different sub-status types will still be recorded
 	for _, statusType := range mtx.HistorySummary {
 		if statusType.Status == subStatus {
-			// Just increment the counter
+			// Just increment the counter and last timestamp
+			statusType.LastOccurrence = fftypes.Now()
 			statusType.Count++
 			return
 		}
 	}
 
-	mtx.HistorySummary = append(mtx.HistorySummary, &apitypes.TxHistorySummaryEntry{Status: subStatus, Count: 1, FirstOccurrence: fftypes.Now()})
+	mtx.HistorySummary = append(mtx.HistorySummary, &apitypes.TxHistorySummaryEntry{Status: subStatus, Count: 1, FirstOccurrence: fftypes.Now(), LastOccurrence: fftypes.Now()})
 }
 
 // Takes a string that might be valid JSON, and returns valid JSON that is either:
@@ -141,6 +142,20 @@ func (h *manager) AddSubStatusAction(ctx context.Context, mtx *apitypes.ManagedT
 			if info != nil {
 				entry.LastInfo = jsonOrString(info)
 			}
+
+			// As we have a possibly indefinite list of sub-status records (which might be a long list and early entries
+			// get purged at some point) we keep a separate list of all the discrete types of sub-status
+			// and action we've we've ever seen for this transaction along with a count of them. This means an early sub-status
+			// (e.g. "queued") with an action that never happens again (e.g. "assignNonce") followed by 100s of different sub-status
+			// types will still be recorded
+			for _, actionType := range mtx.HistorySummary {
+				if actionType.Action == action {
+					// Just increment the counter and last timestamp
+					actionType.LastOccurrence = fftypes.Now()
+					actionType.Count++
+					break
+				}
+			}
 			return
 		}
 	}
@@ -163,4 +178,5 @@ func (h *manager) AddSubStatusAction(ctx context.Context, mtx *apitypes.ManagedT
 	}
 
 	currentSubStatus.Actions = append(currentSubStatus.Actions, newAction)
+	mtx.HistorySummary = append(mtx.HistorySummary, &apitypes.TxHistorySummaryEntry{Action: action, Count: 1, FirstOccurrence: fftypes.Now(), LastOccurrence: fftypes.Now()})
 }

pkg/txhistory/txhistory_test.go

@@ -136,6 +136,23 @@ func TestManagedTXSubStatusAction(t *testing.T) {
 	assert.Equal(t, 1, mtx.History[0].Actions[3].Count)
 	assert.Nil(t, mtx.History[0].Actions[3].LastErrorTime)
 
+	// History is the complete list of unique sub-status types and actions
+	assert.Equal(t, 5, len(mtx.HistorySummary))
+
+	// Sanity check the history summary entries
+	for _, historyEntry := range mtx.HistorySummary {
+		assert.NotNil(t, historyEntry.FirstOccurrence)
+		assert.NotNil(t, historyEntry.LastOccurrence)
+		assert.GreaterOrEqual(t, historyEntry.Count, 1)
+
+		if historyEntry.Action == apitypes.TxActionRetrieveGasPrice {
+			// The first and last occurrence timestamps shoudn't be the same
+			assert.NotEqual(t, historyEntry.FirstOccurrence, historyEntry.LastOccurrence)
+
+			// We should have a count of 3 for this action
+			assert.Equal(t, historyEntry.Count, 3)
+		}
+	}
 }
 
 func TestManagedTXSubStatusInvalidJSON(t *testing.T) {