[Feature]: Persist imported Mission Control Data across restarts

cmd/lncli/cmd_import_mission_control.go

@@ -28,6 +28,11 @@ var importMissionControlCommand = cli.Command{
 			Name:  "force",
 			Usage: "whether to force the history entry import",
 		},
+		cli.BoolFlag{
+			Name: "persist_mc",
+			Usage: "whether to persist the imported mission " +
+				"control to disk",
+		},
 	},
 }
 
@@ -91,7 +96,8 @@ func importMissionControl(ctx *cli.Context) error {
 		Pairs: []*routerrpc.PairHistory{
 			importResult,
 		},
-		Force: ctx.IsSet("force"),
+		Force:     ctx.IsSet("force"),
+		PersistMc: ctx.IsSet("persist_mc"),
 	}
 
 	rpcCtx := context.Background()

cmd/lncli/cmd_mission_control.go

@@ -355,6 +355,13 @@ var resetMissionControlCommand = cli.Command{
 	Category: "Mission Control",
 	Usage:    "Reset internal mission control state.",
 	Action:   actionDecorator(resetMissionControl),
+	Flags: []cli.Flag{
+		cli.BoolFlag{
+			Name: "reset_imported_persisted_mc",
+			Usage: "whether to reset the imported and persisted " +
+				"mission control state on disk.",
+		},
+	},
 }
 
 func resetMissionControl(ctx *cli.Context) error {
@@ -364,7 +371,10 @@ func resetMissionControl(ctx *cli.Context) error {
 
 	client := routerrpc.NewRouterClient(conn)
 
-	req := &routerrpc.ResetMissionControlRequest{}
+	resetImportedPersistedMC := ctx.IsSet("reset_imported_persisted_mc")
+	req := &routerrpc.ResetMissionControlRequest{
+		ResetImportedPersistedMc: resetImportedPersistedMC,
+	}
 	_, err := client.ResetMissionControl(ctxc, req)
 	return err
 }

lnrpc/routerrpc/router.proto

@@ -80,7 +80,8 @@ service Router {
 
     /* lncli: `resetmc`
     ResetMissionControl clears all mission control state and starts with a clean
-    slate.
+    state. If the reset_imported_persisted_mc flag is set to true, it also
+    resets the imported and persisted mission control data on disk.
     */
     rpc ResetMissionControl (ResetMissionControlRequest)
         returns (ResetMissionControlResponse);
@@ -443,6 +444,9 @@ message SendToRouteResponse {
 }
 
 message ResetMissionControlRequest {
+    // Whether to reset the imported and persisted mission control state on
+    // disk.
+    bool reset_imported_persisted_mc = 1;
 }
 
 message ResetMissionControlResponse {
@@ -467,6 +471,9 @@ message XImportMissionControlRequest {
     // override the failure pair is imported before the success pair and both
     // still clamp existing failure/success amounts.
     bool force = 2;
+
+    // Whether to persist the imported mission control to disk.
+    bool persist_mc = 3;
 }
 
 message XImportMissionControlResponse {

lnrpc/routerrpc/router.swagger.json

@@ -165,7 +165,7 @@
     },
     "/v2/router/mc/reset": {
       "post": {
-        "summary": "lncli: `resetmc`\nResetMissionControl clears all mission control state and starts with a clean\nslate.",
+        "summary": "lncli: `resetmc`\nResetMissionControl clears all mission control state and starts with a clean\nstate. If the reset_imported_persisted_mc flag is set to true, it also\nresets the imported and persisted mission control data on disk.",
         "operationId": "Router_ResetMissionControl",
         "responses": {
           "200": {
@@ -1624,7 +1624,13 @@
       }
     },
     "routerrpcResetMissionControlRequest": {
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "reset_imported_persisted_mc": {
+          "type": "boolean",
+          "description": "Whether to reset the imported and persisted mission control state on\ndisk."
+        }
+      }
     },
     "routerrpcResetMissionControlResponse": {
       "type": "object"
@@ -1895,6 +1901,10 @@
         "force": {
           "type": "boolean",
           "description": "Whether to force override MC pair history. Note that even with force\noverride the failure pair is imported before the success pair and both\nstill clamp existing failure/success amounts."
+        },
+        "persist_mc": {
+          "type": "boolean",
+          "description": "Whether to persist the imported mission control to disk."
         }
       }
     },

lnrpc/routerrpc/router_backend.go

@@ -114,17 +114,21 @@ type MissionControl interface {
 		amt lnwire.MilliSatoshi, capacity btcutil.Amount) float64
 
 	// ResetHistory resets the history of MissionControl returning it to a
-	// state as if no payment attempts have been made.
-	ResetHistory() error
+	// state as if no payment attempts have been made.If the
+	// resetImportedPersistedMC flag is set to true, it also resets the
+	// imported and persisted mission control data on disk.
+	ResetHistory(resetImportedPersistedMC bool) error
 
 	// GetHistorySnapshot takes a snapshot from the current mission control
 	// state and actual probability estimates.
 	GetHistorySnapshot() *routing.MissionControlSnapshot
 
 	// ImportHistory imports the mission control snapshot to our internal
-	// state. This import will only be applied in-memory, and will not be
-	// persisted across restarts.
-	ImportHistory(snapshot *routing.MissionControlSnapshot, force bool) error
+	// state. This import will be applied both in-memory and persisted to
+	// disk, ensuring that the mission control data is available across
+	// restarts (if persistMC flag is set).
+	ImportHistory(snapshot *routing.MissionControlSnapshot, force bool,
+		persistMC bool) error
 
 	// GetPairHistorySnapshot returns the stored history for a given node
 	// pair.

lnrpc/routerrpc/router_backend_test.go

@@ -251,7 +251,7 @@ func (m *mockMissionControl) GetProbability(fromNode, toNode route.Vertex,
 	return testMissionControlProb
 }
 
-func (m *mockMissionControl) ResetHistory() error {
+func (m *mockMissionControl) ResetHistory(resetImportedPersistedMC bool) error {
 	return nil
 }
 

lnrpc/routerrpc/router_server.go

@@ -887,11 +887,14 @@ func (s *Server) SendToRouteV2(ctx context.Context,
 }
 
 // ResetMissionControl clears all mission control state and starts with a clean
-// slate.
+// state. If the ResetImportedPersistedMc flag is set to true, it also resets
+// the imported and persisted mission control data on disk.
 func (s *Server) ResetMissionControl(ctx context.Context,
 	req *ResetMissionControlRequest) (*ResetMissionControlResponse, error) {
 
-	err := s.cfg.RouterBackend.MissionControl.ResetHistory()
+	err := s.cfg.RouterBackend.MissionControl.ResetHistory(
+		req.ResetImportedPersistedMc,
+	)
 	if err != nil {
 		return nil, err
 	}
@@ -1115,7 +1118,7 @@ func (s *Server) XImportMissionControl(_ context.Context,
 	}
 
 	err := s.cfg.RouterBackend.MissionControl.ImportHistory(
-		snapshot, req.Force,
+		snapshot, req.Force, req.PersistMc,
 	)
 	if err != nil {
 		return nil, err

routing/missioncontrol.go

@@ -266,8 +266,23 @@ func (m *MissionControl) init() error {
 		m.applyPaymentResult(result)
 	}
 
+	mcSnapshots, err := m.store.fetchMCData()
+	if err != nil {
+		return err
+	}
+
+	mcPairsPersisted := 0
+	for _, mcSnapshot := range mcSnapshots {
+		err := m.ImportHistory(mcSnapshot, false, true)
+		if err != nil {
+			return err
+		}
+		mcPairsPersisted += len(mcSnapshot.Pairs)
+	}
+
 	log.Debugf("Mission control state reconstruction finished: "+
-		"n=%v, time=%v", len(results), time.Since(start))
+		"raw_payment_results_count=%v, persisted_mc_pairs_count=%v, "+
+		"time=%v", len(results), mcPairsPersisted, time.Since(start))
 
 	return nil
 }
@@ -312,8 +327,10 @@ func (m *MissionControl) SetConfig(cfg *MissionControlConfig) error {
 }
 
 // ResetHistory resets the history of MissionControl returning it to a state as
-// if no payment attempts have been made.
-func (m *MissionControl) ResetHistory() error {
+// if no payment attempts have been made. If the resetImportedPersistedMC
+// flag is set to true, it also resets the imported and persisted mission
+// control data on disk.
+func (m *MissionControl) ResetHistory(resetImportedPersistedMC bool) error {
 	m.Lock()
 	defer m.Unlock()
 
@@ -323,6 +340,13 @@ func (m *MissionControl) ResetHistory() error {
 
 	m.state.resetHistory()
 
+	if resetImportedPersistedMC {
+		err := m.store.resetMCData()
+		if err != nil {
+			return err
+		}
+	}
+
 	log.Debugf("Mission control history cleared")
 
 	return nil
@@ -360,11 +384,11 @@ func (m *MissionControl) GetHistorySnapshot() *MissionControlSnapshot {
 	return m.state.getSnapshot()
 }
 
-// ImportHistory imports the set of mission control results provided to our
-// in-memory state. These results are not persisted, so will not survive
-// restarts.
+// ImportHistory imports the set of mission control results to our in-memory
+// state and disk, ensuring that the mission control data is available across
+// restarts (if persistMC flag is set).
 func (m *MissionControl) ImportHistory(history *MissionControlSnapshot,
-	force bool) error {
+	force bool, persistMC bool) error {
 
 	if history == nil {
 		return errors.New("cannot import nil history")
@@ -378,6 +402,13 @@ func (m *MissionControl) ImportHistory(history *MissionControlSnapshot,
 
 	imported := m.state.importSnapshot(history, force)
 
+	if persistMC {
+		err := m.store.persistMCData(history)
+		if err != nil {
+			return err
+		}
+	}
+
 	log.Infof("Imported %v results to mission control", imported)
 
 	return nil