multi: let most ActionDB methods take a context

Author: ellemouton

firewall/request_logger.go

@@ -128,7 +128,7 @@ func (r *RequestLogger) CustomCaveatName() string {
 
 // Intercept processes an RPC middleware interception request and returns the
 // interception result which either accepts or rejects the intercepted message.
-func (r *RequestLogger) Intercept(_ context.Context,
+func (r *RequestLogger) Intercept(ctx context.Context,
 	req *lnrpc.RPCMiddlewareRequest) (*lnrpc.RPCMiddlewareResponse, error) {
 
 	ri, err := NewInfoFromRequest(req)
@@ -156,7 +156,7 @@ func (r *RequestLogger) Intercept(_ context.Context,
 
 	// Parse incoming requests and act on them.
 	case MWRequestTypeRequest:
-		return mid.RPCErr(req, r.addNewAction(ri, withPayloadData))
+		return mid.RPCErr(req, r.addNewAction(ctx, ri, withPayloadData))
 
 	// Parse and possibly manipulate outgoing responses.
 	case MWRequestTypeResponse:
@@ -170,7 +170,7 @@ func (r *RequestLogger) Intercept(_ context.Context,
 		}
 
 		return mid.RPCErr(
-			req, r.MarkAction(ri.RequestID, state, errReason),
+			req, r.MarkAction(ctx, ri.RequestID, state, errReason),
 		)
 
 	default:
@@ -179,7 +179,7 @@ func (r *RequestLogger) Intercept(_ context.Context,
 }
 
 // addNewAction persists the new action to the db.
-func (r *RequestLogger) addNewAction(ri *RequestInfo,
+func (r *RequestLogger) addNewAction(ctx context.Context, ri *RequestInfo,
 	withPayloadData bool) error {
 
 	// If no macaroon is provided, then an empty 4-byte array is used as the
@@ -223,7 +223,7 @@ func (r *RequestLogger) addNewAction(ri *RequestInfo,
 		}
 	}
 
-	id, err := r.actionsDB.AddAction(action)
+	id, err := r.actionsDB.AddAction(ctx, action)
 	if err != nil {
 		return err
 	}
@@ -240,7 +240,7 @@ func (r *RequestLogger) addNewAction(ri *RequestInfo,
 
 // MarkAction can be used to set the state of an action identified by the given
 // requestID.
-func (r *RequestLogger) MarkAction(reqID uint64,
+func (r *RequestLogger) MarkAction(ctx context.Context, reqID uint64,
 	state firewalldb.ActionState, errReason string) error {
 
 	r.mu.Lock()
@@ -252,5 +252,5 @@ func (r *RequestLogger) MarkAction(reqID uint64,
 	}
 	delete(r.reqIDToAction, reqID)
 
-	return r.actionsDB.SetActionState(actionLocator, state, errReason)
+	return r.actionsDB.SetActionState(ctx, actionLocator, state, errReason)
 }

firewall/rule_enforcer.go

@@ -32,8 +32,9 @@ type RuleEnforcer struct {
 	ruleDB            firewalldb.RulesDB
 	actionsDB         firewalldb.ActionReadDBGetter
 	sessionDB         firewalldb.SessionDB
-	markActionErrored func(reqID uint64, reason string) error
-	privMapDB         firewalldb.PrivacyMapper
+	markActionErrored func(ctx context.Context, reqID uint64,
+		reason string) error
+	privMapDB firewalldb.PrivacyMapper
 
 	permsMgr        *perms.Manager
 	getFeaturePerms featurePerms
@@ -63,7 +64,8 @@ func NewRuleEnforcer(ruleDB firewalldb.RulesDB,
 	routerClient lndclient.RouterClient,
 	lndClient lndclient.LightningClient, lndConnID string,
 	ruleMgrs rules.ManagerSet,
-	markActionErrored func(reqID uint64, reason string) error,
+	markActionErrored func(ctx context.Context, reqID uint64,
+		reason string) error,
 	privMap firewalldb.PrivacyMapper) *RuleEnforcer {
 
 	return &RuleEnforcer{
@@ -164,7 +166,9 @@ func (r *RuleEnforcer) Intercept(ctx context.Context,
 
 		replacement, err := r.handleRequest(ctx, ri)
 		if err != nil {
-			dbErr := r.markActionErrored(ri.RequestID, err.Error())
+			dbErr := r.markActionErrored(
+				ctx, ri.RequestID, err.Error(),
+			)
 			if dbErr != nil {
 				log.Error("could not mark action for "+
 					"request ID %d as Errored: %v",

firewalldb/actions.go

@@ -181,9 +181,9 @@ func WithActionState(state ActionState) ListActionOption {
 // ActionsWriteDB is an abstraction over the Actions DB that will allow a
 // caller to add new actions as well as change the values of an existing action.
 type ActionsWriteDB interface {
-	AddAction(action *Action) (uint64, error)
-	SetActionState(al *ActionLocator, state ActionState,
-		errReason string) error
+	AddAction(ctx context.Context, action *Action) (uint64, error)
+	SetActionState(ctx context.Context, al *ActionLocator,
+		state ActionState, errReason string) error
 }
 
 // RuleAction represents a method call that was performed at a certain time at

firewalldb/actions_kvdb.go

@@ -53,7 +53,7 @@ var (
 )
 
 // AddAction serialises and adds an Action to the DB under the given sessionID.
-func (db *BoltDB) AddAction(action *Action) (uint64, error) {
+func (db *BoltDB) AddAction(_ context.Context, action *Action) (uint64, error) {
 	var buf bytes.Buffer
 	if err := SerializeAction(&buf, action); err != nil {
 		return 0, err
@@ -167,8 +167,8 @@ func getAction(actionsBkt *bbolt.Bucket, al *ActionLocator) (*Action, error) {
 
 // SetActionState finds the action specified by the ActionLocator and sets its
 // state to the given state.
-func (db *BoltDB) SetActionState(al *ActionLocator, state ActionState,
-	errorReason string) error {
+func (db *BoltDB) SetActionState(_ context.Context, al *ActionLocator,
+	state ActionState, errorReason string) error {
 
 	if errorReason != "" && state != ActionStateError {
 		return fmt.Errorf("error reason should only be set for " +

firewalldb/actions_test.go

@@ -66,11 +66,11 @@ func TestActionStorage(t *testing.T) {
 	require.NoError(t, err)
 	require.Len(t, actions, 0)
 
-	id, err := db.AddAction(action1)
+	id, err := db.AddAction(ctx, action1)
 	require.NoError(t, err)
 	require.Equal(t, uint64(1), id)
 
-	id, err = db.AddAction(action2)
+	id, err = db.AddAction(ctx, action2)
 	require.NoError(t, err)
 	require.Equal(t, uint64(1), id)
 
@@ -92,7 +92,7 @@ func TestActionStorage(t *testing.T) {
 	require.Len(t, actions, 0)
 
 	err = db.SetActionState(
-		&ActionLocator{
+		ctx, &ActionLocator{
 			SessionID: sessionID2,
 			ActionID:  uint64(1),
 		}, ActionStateDone, "",
@@ -109,7 +109,7 @@ func TestActionStorage(t *testing.T) {
 	action2.State = ActionStateDone
 	require.Equal(t, action2, actions[0])
 
-	id, err = db.AddAction(action1)
+	id, err = db.AddAction(ctx, action1)
 	require.NoError(t, err)
 	require.Equal(t, uint64(2), id)
 
@@ -125,7 +125,7 @@ func TestActionStorage(t *testing.T) {
 
 	// Try set an error reason for a non Errored state.
 	err = db.SetActionState(
-		&ActionLocator{
+		ctx, &ActionLocator{
 			SessionID: sessionID2,
 			ActionID:  uint64(1),
 		}, ActionStateDone, "hello",
@@ -134,7 +134,7 @@ func TestActionStorage(t *testing.T) {
 
 	// Now try move the action to errored with a reason.
 	err = db.SetActionState(
-		&ActionLocator{
+		ctx, &ActionLocator{
 			SessionID: sessionID2,
 			ActionID:  uint64(1),
 		}, ActionStateError, "fail whale",
@@ -184,7 +184,7 @@ func TestListActions(t *testing.T) {
 			State:              ActionStateDone,
 		}
 
-		_, err := db.AddAction(action)
+		_, err := db.AddAction(ctx, action)
 		require.NoError(t, err)
 	}
 
@@ -373,7 +373,7 @@ func TestListGroupActions(t *testing.T) {
 	require.Empty(t, al)
 
 	// Add an action under session 1.
-	_, err = db.AddAction(action1)
+	_, err = db.AddAction(ctx, action1)
 	require.NoError(t, err)
 
 	// There should now be one action in the group.
@@ -383,7 +383,7 @@ func TestListGroupActions(t *testing.T) {
 	require.Equal(t, sessionID1, al[0].SessionID)
 
 	// Add an action under session 2.
-	_, err = db.AddAction(action2)
+	_, err = db.AddAction(ctx, action2)
 	require.NoError(t, err)
 
 	// There should now be actions in the group.

firewalldb/interface.go

@@ -105,12 +105,12 @@ type PrivacyMapper interface {
 // the Action persistence and querying.
 type ActionDB interface {
 	// AddAction persists the given action to the database.
-	AddAction(action *Action) (uint64, error)
+	AddAction(ctx context.Context, action *Action) (uint64, error)
 
 	// SetActionState finds the action specified by the ActionLocator and
 	// sets its state to the given state.
-	SetActionState(al *ActionLocator, state ActionState,
-		errReason string) error
+	SetActionState(ctx context.Context, al *ActionLocator,
+		state ActionState, errReason string) error
 
 	// ListActions returns a list of Actions that pass the filterFn
 	// requirements. The query IndexOffset and MaxNum params can be used to

terminal.go

@@ -1118,9 +1118,11 @@ func (g *LightningTerminal) startInternalSubServers(ctx context.Context,
 			g.permsMgr, g.lndClient.NodePubkey,
 			g.lndClient.Router,
 			g.lndClient.Client, g.lndConnID, g.ruleMgrs,
-			func(reqID uint64, reason string) error {
+			func(ctx context.Context, reqID uint64,
+				reason string) error {
+
 				return requestLogger.MarkAction(
-					reqID, firewalldb.ActionStateError,
+					ctx, reqID, firewalldb.ActionStateError,
 					reason,
 				)
 			}, g.stores.firewall,