[Part 6|*] Thread Contexts through payment methods Part 2

docs/release-notes/release-notes-0.21.0.md

@@ -54,6 +54,17 @@
     refacotor the payment related LND code to make it more modular.
   * Implement the SQL backend for the [payments 
     database](https://github.com/lightningnetwork/lnd/pull/9147)
+  * Implement query methods for the [payments db 
+    SQL Backend](https://github.com/lightningnetwork/lnd/pull/10287)
+  * Implement insert methods for the [payments db 
+    SQL Backend](https://github.com/lightningnetwork/lnd/pull/10291)
+  * Finalize SQL payments implementation [enabling unit and itests
+    for SQL backend](https://github.com/lightningnetwork/lnd/pull/10292)
+  * [Thread context through payment 
+    db functions Part 1](https://github.com/lightningnetwork/lnd/pull/10307)
+  * [Thread context through payment 
+    db functions Part 2](https://github.com/lightningnetwork/lnd/pull/10308)
+
 
 ## Code Health
 

itest/lnd_payment_test.go

@@ -504,61 +504,86 @@ func testListPayments(ht *lntest.HarnessTest) {
 		expected  bool
 	}
 
-	// Create test cases to check the timestamp filters.
-	createCases := func(createTimeSeconds uint64) []testCase {
+	// Create test cases with proper rounding for start and end dates.
+	createCases := func(startTimeSeconds,
+		endTimeSeconds uint64) []testCase {
+
 		return []testCase{
 			{
 				// Use a start date same as the creation date
-				// should return us the item.
+				// (truncated) should return us the item.
 				name:      "exact start date",
-				startDate: createTimeSeconds,
+				startDate: startTimeSeconds,
 				expected:  true,
 			},
 			{
 				// Use an earlier start date should return us
 				// the item.
 				name:      "earlier start date",
-				startDate: createTimeSeconds - 1,
+				startDate: startTimeSeconds - 1,
 				expected:  true,
 			},
 			{
 				// Use a future start date should return us
 				// nothing.
 				name:      "future start date",
-				startDate: createTimeSeconds + 1,
+				startDate: startTimeSeconds + 1,
 				expected:  false,
 			},
 			{
 				// Use an end date same as the creation date
-				// should return us the item.
+				// (ceiling) should return us the item.
 				name:     "exact end date",
-				endDate:  createTimeSeconds,
+				endDate:  endTimeSeconds,
 				expected: true,
 			},
 			{
 				// Use an end date in the future should return
 				// us the item.
 				name:     "future end date",
-				endDate:  createTimeSeconds + 1,
+				endDate:  endTimeSeconds + 1,
 				expected: true,
 			},
 			{
 				// Use an earlier end date should return us
 				// nothing.
-				name:     "earlier end date",
-				endDate:  createTimeSeconds - 1,
+				name: "earlier end date",
+				// The native sql backend has a higher
+				// precision than the kv backend, the native sql
+				// backend uses microseconds, the kv backend
+				// when filtering uses seconds so we need to
+				// subtract 2 seconds to ensure the payment is
+				// not included.
+				// We could also truncate before inserting
+				// into the sql db but I rather relax this test
+				// here.
+				endDate:  endTimeSeconds - 2,
 				expected: false,
 			},
 		}
 	}
 
-	// Get the payment creation time in seconds.
-	paymentCreateSeconds := uint64(
-		p.CreationTimeNs / time.Second.Nanoseconds(),
+	// Get the payment creation time in seconds, using different approaches
+	// for start and end date comparisons to avoid rounding issues.
+	creationTime := time.Unix(0, p.CreationTimeNs)
+
+	// For start date comparisons: use truncation (floor) to include
+	// payments from the beginning of that second.
+	paymentCreateSecondsStart := uint64(
+		creationTime.Truncate(time.Second).Unix(),
+	)
+
+	// For end date comparisons: use ceiling to include payments up to the
+	// end of that second.
+	paymentCreateSecondsEnd := uint64(
+		(p.CreationTimeNs + time.Second.Nanoseconds() - 1) /
+			time.Second.Nanoseconds(),
 	)
 
 	// Create test cases from the payment creation time.
-	testCases := createCases(paymentCreateSeconds)
+	testCases := createCases(
+		paymentCreateSecondsStart, paymentCreateSecondsEnd,
+	)
 
 	// We now check the timestamp filters in `ListPayments`.
 	for _, tc := range testCases {
@@ -578,7 +603,9 @@ func testListPayments(ht *lntest.HarnessTest) {
 	}
 
 	// Create test cases from the invoice creation time.
-	testCases = createCases(uint64(invoice.CreationDate))
+	testCases = createCases(
+		uint64(invoice.CreationDate), uint64(invoice.CreationDate),
+	)
 
 	// We now do the same check for `ListInvoices`.
 	for _, tc := range testCases {

lnrpc/routerrpc/router_backend.go

@@ -1745,6 +1745,8 @@ func (r *RouterBackend) MarshallPayment(payment *paymentsdb.MPPayment) (
 		// If any of the htlcs have settled, extract a valid
 		// preimage.
 		if htlc.Settle != nil {
+			// For AMP payments all hashes will be different so we
+			// will depict the last htlc preimage.
 			preimage = htlc.Settle.Preimage
 			fee += htlc.Route.TotalFees()
 		}

lnrpc/routerrpc/router_server.go

@@ -936,11 +936,11 @@ func (s *Server) SendToRouteV2(ctx context.Context,
 	// db.
 	if req.SkipTempErr {
 		attempt, err = s.cfg.Router.SendToRouteSkipTempErr(
-			hash, route, firstHopRecords,
+			ctx, hash, route, firstHopRecords,
 		)
 	} else {
 		attempt, err = s.cfg.Router.SendToRoute(
-			hash, route, firstHopRecords,
+			ctx, hash, route, firstHopRecords,
 		)
 	}
 	if attempt != nil {

payments/db/errors.go

@@ -130,4 +130,8 @@ var (
 	// NOTE: Only used for the kv backend.
 	ErrNoSequenceNrIndex = errors.New("payment sequence number index " +
 		"does not exist")
+
+	// errMaxPaymentsReached is used internally to signal that the maximum
+	// number of payments has been reached during a paginated query.
+	errMaxPaymentsReached = errors.New("max payments reached")
 )

payments/db/interface.go

@@ -21,21 +21,24 @@ type PaymentReader interface {
 
 	// FetchPayment fetches the payment corresponding to the given payment
 	// hash.
-	FetchPayment(paymentHash lntypes.Hash) (*MPPayment, error)
+	FetchPayment(ctx context.Context,
+		paymentHash lntypes.Hash) (*MPPayment, error)
 
 	// FetchInFlightPayments returns all payments with status InFlight.
-	FetchInFlightPayments() ([]*MPPayment, error)
+	FetchInFlightPayments(ctx context.Context) ([]*MPPayment, error)
 }
 
 // PaymentWriter represents the interface to write operations to the payments
 // database.
 type PaymentWriter interface {
 	// DeletePayment deletes a payment from the DB given its payment hash.
-	DeletePayment(paymentHash lntypes.Hash, failedAttemptsOnly bool) error
+	DeletePayment(ctx context.Context, paymentHash lntypes.Hash,
+		failedAttemptsOnly bool) error
 
 	// DeletePayments deletes all payments from the DB given the specified
 	// flags.
-	DeletePayments(failedOnly, failedAttemptsOnly bool) (int, error)
+	DeletePayments(ctx context.Context, failedOnly,
+		failedAttemptsOnly bool) (int, error)
 
 	PaymentControl
 }
@@ -58,10 +61,11 @@ type PaymentControl interface {
 	// exists in the database before creating a new payment. However, it
 	// should allow the user making a subsequent payment if the payment is
 	// in a Failed state.
-	InitPayment(lntypes.Hash, *PaymentCreationInfo) error
+	InitPayment(context.Context, lntypes.Hash, *PaymentCreationInfo) error
 
 	// RegisterAttempt atomically records the provided HTLCAttemptInfo.
-	RegisterAttempt(lntypes.Hash, *HTLCAttemptInfo) (*MPPayment, error)
+	RegisterAttempt(context.Context, lntypes.Hash,
+		*HTLCAttemptInfo) (*MPPayment, error)
 
 	// SettleAttempt marks the given attempt settled with the preimage. If
 	// this is a multi shard payment, this might implicitly mean the
@@ -71,23 +75,25 @@ type PaymentControl interface {
 	// error to prevent us from making duplicate payments to the same
 	// payment hash. The provided preimage is atomically saved to the DB
 	// for record keeping.
-	SettleAttempt(lntypes.Hash, uint64, *HTLCSettleInfo) (*MPPayment, error)
+	SettleAttempt(context.Context, lntypes.Hash, uint64,
+		*HTLCSettleInfo) (*MPPayment, error)
 
 	// FailAttempt marks the given payment attempt failed.
-	FailAttempt(lntypes.Hash, uint64, *HTLCFailInfo) (*MPPayment, error)
+	FailAttempt(context.Context, lntypes.Hash, uint64,
+		*HTLCFailInfo) (*MPPayment, error)
 
 	// Fail transitions a payment into the Failed state, and records
 	// the ultimate reason the payment failed. Note that this should only
 	// be called when all active attempts are already failed. After
 	// invoking this method, InitPayment should return nil on its next call
 	// for this payment hash, allowing the user to make a subsequent
 	// payment.
-	Fail(lntypes.Hash, FailureReason) (*MPPayment, error)
+	Fail(context.Context, lntypes.Hash, FailureReason) (*MPPayment, error)
 
 	// DeleteFailedAttempts removes all failed HTLCs from the db. It should
 	// be called for a given payment whenever all inflight htlcs are
 	// completed, and the payment has reached a final terminal state.
-	DeleteFailedAttempts(lntypes.Hash) error
+	DeleteFailedAttempts(context.Context, lntypes.Hash) error
 }
 
 // DBMPPayment is an interface that represents the payment state during a

payments/db/kv_store.go

@@ -186,7 +186,7 @@ func initKVStore(db kvdb.Backend) error {
 // making sure it does not already exist as an in-flight payment. When this
 // method returns successfully, the payment is guaranteed to be in the InFlight
 // state.
-func (p *KVStore) InitPayment(paymentHash lntypes.Hash,
+func (p *KVStore) InitPayment(_ context.Context, paymentHash lntypes.Hash,
 	info *PaymentCreationInfo) error {
 
 	// Obtain a new sequence number for this payment. This is used
@@ -290,10 +290,12 @@ func (p *KVStore) InitPayment(paymentHash lntypes.Hash,
 
 // DeleteFailedAttempts deletes all failed htlcs for a payment if configured
 // by the KVStore db.
-func (p *KVStore) DeleteFailedAttempts(hash lntypes.Hash) error {
+func (p *KVStore) DeleteFailedAttempts(ctx context.Context,
+	hash lntypes.Hash) error {
+
 	if !p.keepFailedPaymentAttempts {
 		const failedHtlcsOnly = true
-		err := p.DeletePayment(hash, failedHtlcsOnly)
+		err := p.DeletePayment(ctx, hash, failedHtlcsOnly)
 		if err != nil {
 			return err
 		}
@@ -357,7 +359,7 @@ func deserializePaymentIndex(r io.Reader) (lntypes.Hash, error) {
 
 // RegisterAttempt atomically records the provided HTLCAttemptInfo to the
 // DB.
-func (p *KVStore) RegisterAttempt(paymentHash lntypes.Hash,
+func (p *KVStore) RegisterAttempt(_ context.Context, paymentHash lntypes.Hash,
 	attempt *HTLCAttemptInfo) (*MPPayment, error) {
 
 	// Serialize the information before opening the db transaction.
@@ -428,7 +430,7 @@ func (p *KVStore) RegisterAttempt(paymentHash lntypes.Hash,
 // After invoking this method, InitPayment should always return an error to
 // prevent us from making duplicate payments to the same payment hash. The
 // provided preimage is atomically saved to the DB for record keeping.
-func (p *KVStore) SettleAttempt(hash lntypes.Hash,
+func (p *KVStore) SettleAttempt(_ context.Context, hash lntypes.Hash,
 	attemptID uint64, settleInfo *HTLCSettleInfo) (*MPPayment, error) {
 
 	var b bytes.Buffer
@@ -441,7 +443,7 @@ func (p *KVStore) SettleAttempt(hash lntypes.Hash,
 }
 
 // FailAttempt marks the given payment attempt failed.
-func (p *KVStore) FailAttempt(hash lntypes.Hash,
+func (p *KVStore) FailAttempt(_ context.Context, hash lntypes.Hash,
 	attemptID uint64, failInfo *HTLCFailInfo) (*MPPayment, error) {
 
 	var b bytes.Buffer
@@ -526,7 +528,7 @@ func (p *KVStore) updateHtlcKey(paymentHash lntypes.Hash,
 // payment failed. After invoking this method, InitPayment should return nil on
 // its next call for this payment hash, allowing the switch to make a
 // subsequent payment.
-func (p *KVStore) Fail(paymentHash lntypes.Hash,
+func (p *KVStore) Fail(_ context.Context, paymentHash lntypes.Hash,
 	reason FailureReason) (*MPPayment, error) {
 
 	var (
@@ -583,8 +585,8 @@ func (p *KVStore) Fail(paymentHash lntypes.Hash,
 }
 
 // FetchPayment returns information about a payment from the database.
-func (p *KVStore) FetchPayment(paymentHash lntypes.Hash) (
-	*MPPayment, error) {
+func (p *KVStore) FetchPayment(_ context.Context,
+	paymentHash lntypes.Hash) (*MPPayment, error) {
 
 	var payment *MPPayment
 	err := kvdb.View(p.db, func(tx kvdb.RTx) error {
@@ -739,7 +741,9 @@ func fetchPaymentStatus(bucket kvdb.RBucket) (PaymentStatus, error) {
 }
 
 // FetchInFlightPayments returns all payments with status InFlight.
-func (p *KVStore) FetchInFlightPayments() ([]*MPPayment, error) {
+func (p *KVStore) FetchInFlightPayments(_ context.Context) ([]*MPPayment,
+	error) {
+
 	var (
 		inFlights      []*MPPayment
 		start          = time.Now()
@@ -1273,7 +1277,7 @@ func fetchPaymentWithSequenceNumber(tx kvdb.RTx, paymentHash lntypes.Hash,
 // DeletePayment deletes a payment from the DB given its payment hash. If
 // failedHtlcsOnly is set, only failed HTLC attempts of the payment will be
 // deleted.
-func (p *KVStore) DeletePayment(paymentHash lntypes.Hash,
+func (p *KVStore) DeletePayment(_ context.Context, paymentHash lntypes.Hash,
 	failedHtlcsOnly bool) error {
 
 	return kvdb.Update(p.db, func(tx kvdb.RwTx) error {
@@ -1370,7 +1374,7 @@ func (p *KVStore) DeletePayment(paymentHash lntypes.Hash,
 // failedHtlcsOnly is set, the payment itself won't be deleted, only failed HTLC
 // attempts. The method returns the number of deleted payments, which is always
 // 0 if failedHtlcsOnly is set.
-func (p *KVStore) DeletePayments(failedOnly,
+func (p *KVStore) DeletePayments(_ context.Context, failedOnly,
 	failedHtlcsOnly bool) (int, error) {
 
 	var numPayments int