feat(billing): store payment processing entered at ts on invoice (#3645)

Author: GAlexIHU

go.sum

@@ -2007,6 +2007,8 @@ github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
 github.com/oklog/ulid/v2 v2.1.1 h1:suPZ4ARWLOJLegGFiZZ1dFAkqzhMjL3J1TzI+5wHz8s=
 github.com/oklog/ulid/v2 v2.1.1/go.mod h1:rcEKHmBBKfef9DhnvX7y1HZBYxjXb0cP5ExxNsTT1QQ=
+github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
+github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
 github.com/oliveagle/jsonpath v0.0.0-20180606110733-2e52cf6e6852 h1:Yl0tPBa8QPjGmesFh1D0rDy+q1Twx6FyU7VWHi8wZbI=
 github.com/oliveagle/jsonpath v0.0.0-20180606110733-2e52cf6e6852/go.mod h1:eqOVx5Vwu4gd2mmMZvVZsgIqNSaW3xxRThUJ0k/TPk4=
 github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=

openmeter/billing/adapter/invoice.go

@@ -457,6 +457,7 @@ func (a *adapter) UpdateInvoice(ctx context.Context, in billing.UpdateInvoiceAda
 			SetOrClearDescription(in.Description).
 			SetOrClearDueAt(convert.SafeToUTC(in.DueAt)).
 			SetOrClearCollectionAt(convert.SafeToUTC(in.CollectionAt)).
+			SetOrClearPaymentProcessingEnteredAt(convert.SafeToUTC(in.PaymentProcessingEnteredAt)).
 			SetOrClearDraftUntil(convert.SafeToUTC(in.DraftUntil)).
 			SetOrClearIssuedAt(convert.SafeToUTC(in.IssuedAt)).
 			SetOrClearDeletedAt(convert.SafeToUTC(in.DeletedAt)).
@@ -679,7 +680,8 @@ func (a *adapter) mapInvoiceBaseFromDB(ctx context.Context, invoice *db.BillingI
 		UpdatedAt: invoice.UpdatedAt.In(time.UTC),
 		DeletedAt: convert.TimePtrIn(invoice.DeletedAt, time.UTC),
 
-		CollectionAt: lo.ToPtr(invoice.CollectionAt.In(time.UTC)),
+		CollectionAt:               lo.ToPtr(invoice.CollectionAt.In(time.UTC)),
+		PaymentProcessingEnteredAt: convert.TimePtrIn(invoice.PaymentProcessingEnteredAt, time.UTC),
 
 		ExternalIDs: billing.InvoiceExternalIDs{
 			Invoicing: lo.FromPtr(invoice.InvoicingAppExternalID),

openmeter/billing/invoice.go

@@ -282,6 +282,8 @@ type InvoiceBase struct {
 	QuantitySnapshotedAt *time.Time `json:"quantitySnapshotedAt,omitempty"`
 
 	CollectionAt *time.Time `json:"collectionAt,omitempty"`
+	// PaymentProcessingEnteredAt stores when the invoice first entered payment processing
+	PaymentProcessingEnteredAt *time.Time `json:"paymentProcessingEnteredAt,omitempty"`
 
 	// Customer is either a snapshot of the contact information of the customer at the time of invoice being sent
 	// or the data from the customer entity (draft state)

openmeter/billing/service/invoicestate.go

@@ -52,8 +52,16 @@ func allocateStateMachine() *InvoiceStateMachine {
 				return fmt.Errorf("invalid state type: %v", state)
 			}
 
+			previousStatus := out.Invoice.Status
 			out.Invoice.Status = invState
 
+			if invState == billing.InvoiceStatusPaymentProcessingPending &&
+				previousStatus != billing.InvoiceStatusPaymentProcessingPending &&
+				out.Invoice.PaymentProcessingEnteredAt == nil {
+				now := clock.Now().UTC()
+				out.Invoice.PaymentProcessingEnteredAt = &now
+			}
+
 			sd, err := out.StatusDetails(ctx)
 			if err != nil {
 				return err
@@ -366,6 +374,7 @@ func (m *InvoiceStateMachine) calculateAvailableActionDetails(ctx context.Contex
 
 	originalState := m.Invoice.Status
 	originalValidationErrors := m.Invoice.ValidationIssues
+	originalPaymentProcessingEnteredAt := m.Invoice.PaymentProcessingEnteredAt
 	m.Invoice.ValidationIssues = nil
 
 	if err := m.StateMachine.FireCtx(ctx, baseTrigger); err != nil {
@@ -389,6 +398,7 @@ func (m *InvoiceStateMachine) calculateAvailableActionDetails(ctx context.Contex
 
 	resultingState := m.Invoice.Status
 	m.Invoice.Status = originalState
+	m.Invoice.PaymentProcessingEnteredAt = originalPaymentProcessingEnteredAt
 	m.Invoice.ValidationIssues = originalValidationErrors
 
 	return &billing.InvoiceAvailableActionDetails{