multi: thread context through SendPayment

Author: ziggie1984

routing/router.go

@@ -896,8 +896,8 @@ func (l *LightningPayment) Identifier() [32]byte {
 // will be returned which describes the path the successful payment traversed
 // within the network to reach the destination. Additionally, the payment
 // preimage will also be returned.
-func (r *ChannelRouter) SendPayment(payment *LightningPayment) ([32]byte,
-	*route.Route, error) {
+func (r *ChannelRouter) SendPayment(ctx context.Context,
+	payment *LightningPayment) ([32]byte, *route.Route, error) {
 
 	paySession, shardTracker, err := r.PreparePayment(payment)
 	if err != nil {
@@ -908,7 +908,7 @@ func (r *ChannelRouter) SendPayment(payment *LightningPayment) ([32]byte,
 		spewPayment(payment))
 
 	return r.sendPayment(
-		context.Background(), payment.FeeLimit, payment.Identifier(),
+		ctx, payment.FeeLimit, payment.Identifier(),
 		payment.PayAttemptTimeout, paySession, shardTracker,
 		payment.FirstHopCustomRecords,
 	)

routing/router_test.go

@@ -324,7 +324,9 @@ func TestSendPaymentRouteFailureFallback(t *testing.T) {
 
 	// Send off the payment request to the router, route through pham nuwen
 	// should've been selected as a fall back and succeeded correctly.
-	paymentPreImage, route, err := ctx.router.SendPayment(payment)
+	paymentPreImage, route, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -403,7 +405,9 @@ func TestSendPaymentRouteInfiniteLoopWithBadHopHint(t *testing.T) {
 
 	// Send off the payment request to the router, should succeed
 	// ignoring the bad channel id hint.
-	paymentPreImage, route, paymentErr := ctx.router.SendPayment(payment)
+	paymentPreImage, route, paymentErr := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, paymentErr, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -634,7 +638,9 @@ func TestSendPaymentErrorRepeatedFeeInsufficient(t *testing.T) {
 
 	// Send off the payment request to the router, route through phamnuwen
 	// should've been selected as a fall back and succeeded correctly.
-	paymentPreImage, route, err := ctx.router.SendPayment(payment)
+	paymentPreImage, route, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -741,7 +747,9 @@ func TestSendPaymentErrorFeeInsufficientPrivateEdge(t *testing.T) {
 
 	// Send off the payment request to the router, route through son
 	// goku and then across the private channel to elst.
-	paymentPreImage, route, err := ctx.router.SendPayment(payment)
+	paymentPreImage, route, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -867,7 +875,9 @@ func TestSendPaymentPrivateEdgeUpdateFeeExceedsLimit(t *testing.T) {
 
 	// Send off the payment request to the router, route through son
 	// goku and then across the private channel to elst.
-	paymentPreImage, route, err := ctx.router.SendPayment(payment)
+	paymentPreImage, route, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -990,7 +1000,9 @@ func TestSendPaymentErrorNonFinalTimeLockErrors(t *testing.T) {
 	// Send off the payment request to the router, this payment should
 	// succeed as we should actually go through Pham Nuwen in order to get
 	// to Sophon, even though he has higher fees.
-	paymentPreImage, rt, err := ctx.router.SendPayment(payment)
+	paymentPreImage, rt, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -1016,7 +1028,9 @@ func TestSendPaymentErrorNonFinalTimeLockErrors(t *testing.T) {
 	// w.r.t to the block height, and instead go through Pham Nuwen. We
 	// flip a bit in the payment hash to allow resending this payment.
 	payment.paymentHash[1] ^= 1
-	paymentPreImage, rt, err = ctx.router.SendPayment(payment)
+	paymentPreImage, rt, err = ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -1085,7 +1099,7 @@ func TestSendPaymentErrorPathPruning(t *testing.T) {
 
 	// When we try to dispatch that payment, we should receive an error as
 	// both attempts should fail and cause both routes to be pruned.
-	_, _, err = ctx.router.SendPayment(payment)
+	_, _, err = ctx.router.SendPayment(t.Context(), payment)
 	require.Error(t, err, "payment didn't return error")
 
 	// The final error returned should also indicate that the peer wasn't
@@ -1130,7 +1144,9 @@ func TestSendPaymentErrorPathPruning(t *testing.T) {
 	// This shouldn't return an error, as we'll make a payment attempt via
 	// the pham nuwen channel based on the assumption that there might be an
 	// intermittent issue with the songoku <-> sophon channel.
-	paymentPreImage, rt, err := ctx.router.SendPayment(payment)
+	paymentPreImage, rt, err := ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -1170,7 +1186,9 @@ func TestSendPaymentErrorPathPruning(t *testing.T) {
 
 	// We flip a bit in the payment hash to allow resending this payment.
 	payment.paymentHash[1] ^= 1
-	paymentPreImage, rt, err = ctx.router.SendPayment(payment)
+	paymentPreImage, rt, err = ctx.router.SendPayment(
+		t.Context(), payment,
+	)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -1302,7 +1320,7 @@ func TestUnknownErrorSource(t *testing.T) {
 	// the route a->b->c is tried first. An unreadable faiure is returned
 	// which should pruning the channel a->b. We expect the payment to
 	// succeed via a->d.
-	_, _, err = ctx.router.SendPayment(payment)
+	_, _, err = ctx.router.SendPayment(t.Context(), payment)
 	require.NoErrorf(t, err, "unable to send payment: %v",
 		payment.paymentHash)
 
@@ -1327,7 +1345,7 @@ func TestUnknownErrorSource(t *testing.T) {
 	// Send off the payment request to the router. We expect the payment to
 	// fail because both routes have been pruned.
 	payment.paymentHash[1] ^= 1
-	_, _, err = ctx.router.SendPayment(payment)
+	_, _, err = ctx.router.SendPayment(t.Context(), payment)
 	if err == nil {
 		t.Fatalf("expected payment to fail")
 	}

rpcserver.go

@@ -5960,7 +5960,7 @@ func (r *rpcServer) dispatchPaymentIntent(ctx context.Context,
 		}
 
 		preImage, route, routerErr = r.server.chanRouter.SendPayment(
-			payment,
+			ctx, payment,
 		)
 	} else {
 		var attempt *paymentsdb.HTLCAttempt