Merge pull request #9704 from ellemouton/ctx6

discovery+autopilot: revert passing contexts to `Start` methods

Author: ellemouton

autopilot/agent.go

@@ -202,10 +202,10 @@ func New(cfg Config, initialState []LocalChannel) (*Agent, error) {
 
 // Start starts the agent along with any goroutines it needs to perform its
 // normal duties.
-func (a *Agent) Start(ctx context.Context) error {
+func (a *Agent) Start() error {
 	var err error
 	a.started.Do(func() {
-		ctx, cancel := context.WithCancel(ctx)
+		ctx, cancel := context.WithCancel(context.Background())
 		a.cancel = fn.Some(cancel)
 
 		err = a.start(ctx)

autopilot/agent_test.go

@@ -221,7 +221,7 @@ func setup(t *testing.T, initialChans []LocalChannel) *testContext {
 
 	// With the autopilot agent and all its dependencies we'll start the
 	// primary controller goroutine.
-	if err := agent.Start(context.Background()); err != nil {
+	if err := agent.Start(); err != nil {
 		t.Fatalf("unable to start agent: %v", err)
 	}
 

autopilot/manager.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/wire"
-	"github.com/lightningnetwork/lnd/fn/v2"
 	graphdb "github.com/lightningnetwork/lnd/graph/db"
 	"github.com/lightningnetwork/lnd/lnwallet"
 	"github.com/lightningnetwork/lnd/lnwire"
@@ -55,9 +54,8 @@ type Manager struct {
 	// disabled.
 	pilot *Agent
 
-	quit   chan struct{}
-	wg     sync.WaitGroup
-	cancel fn.Option[context.CancelFunc]
+	quit chan struct{}
+	wg   sync.WaitGroup
 	sync.Mutex
 }
 
@@ -83,7 +81,6 @@ func (m *Manager) Stop() error {
 			log.Errorf("Unable to stop pilot: %v", err)
 		}
 
-		m.cancel.WhenSome(func(fn context.CancelFunc) { fn() })
 		close(m.quit)
 		m.wg.Wait()
 	})
@@ -100,16 +97,14 @@ func (m *Manager) IsActive() bool {
 
 // StartAgent creates and starts an autopilot agent from the Manager's
 // config.
-func (m *Manager) StartAgent(ctx context.Context) error {
+func (m *Manager) StartAgent() error {
 	m.Lock()
 	defer m.Unlock()
 
 	// Already active.
 	if m.pilot != nil {
 		return nil
 	}
-	ctx, cancel := context.WithCancel(ctx)
-	m.cancel = fn.Some(cancel)
 
 	// Next, we'll fetch the current state of open channels from the
 	// database to use as initial state for the auto-pilot agent.
@@ -125,7 +120,7 @@ func (m *Manager) StartAgent(ctx context.Context) error {
 		return err
 	}
 
-	if err := pilot.Start(ctx); err != nil {
+	if err := pilot.Start(); err != nil {
 		return err
 	}
 
@@ -169,8 +164,6 @@ func (m *Manager) StartAgent(ctx context.Context) error {
 				return
 			case <-m.quit:
 				return
-			case <-ctx.Done():
-				return
 			}
 		}
 
@@ -241,8 +234,6 @@ func (m *Manager) StartAgent(ctx context.Context) error {
 				return
 			case <-m.quit:
 				return
-			case <-ctx.Done():
-				return
 			}
 		}
 	}()

discovery/gossiper.go

@@ -643,10 +643,10 @@ func (d *AuthenticatedGossiper) PropagateChanPolicyUpdate(
 
 // Start spawns network messages handler goroutine and registers on new block
 // notifications in order to properly handle the premature announcements.
-func (d *AuthenticatedGossiper) Start(ctx context.Context) error {
+func (d *AuthenticatedGossiper) Start() error {
 	var err error
 	d.started.Do(func() {
-		ctx, cancel := context.WithCancel(ctx)
+		ctx, cancel := context.WithCancel(context.Background())
 		d.cancel = fn.Some(cancel)
 
 		log.Info("Authenticated Gossiper starting")
@@ -674,11 +674,11 @@ func (d *AuthenticatedGossiper) start(ctx context.Context) error {
 	// Start the reliable sender. In case we had any pending messages ready
 	// to be sent when the gossiper was last shut down, we must continue on
 	// our quest to deliver them to their respective peers.
-	if err := d.reliableSender.Start(ctx); err != nil {
+	if err := d.reliableSender.Start(); err != nil {
 		return err
 	}
 
-	d.syncMgr.Start(ctx)
+	d.syncMgr.Start()
 
 	d.banman.start()
 

discovery/gossiper_test.go

@@ -994,7 +994,7 @@ func createTestCtx(t *testing.T, startHeight uint32, isChanPeer bool) (
 		ScidCloser:            newMockScidCloser(isChanPeer),
 	}, selfKeyDesc)
 
-	if err := gossiper.Start(context.Background()); err != nil {
+	if err := gossiper.Start(); err != nil {
 		return nil, fmt.Errorf("unable to start router: %w", err)
 	}
 
@@ -1692,7 +1692,7 @@ func TestSignatureAnnouncementRetryAtStartup(t *testing.T) {
 		KeyLocator: tCtx.gossiper.selfKeyLoc,
 	})
 	require.NoError(t, err, "unable to recreate gossiper")
-	if err := gossiper.Start(context.Background()); err != nil {
+	if err := gossiper.Start(); err != nil {
 		t.Fatalf("unable to start recreated gossiper: %v", err)
 	}
 	defer gossiper.Stop()

discovery/reliable_sender.go

@@ -76,10 +76,10 @@ func newReliableSender(cfg *reliableSenderCfg) *reliableSender {
 }
 
 // Start spawns message handlers for any peers with pending messages.
-func (s *reliableSender) Start(ctx context.Context) error {
+func (s *reliableSender) Start() error {
 	var err error
 	s.start.Do(func() {
-		ctx, cancel := context.WithCancel(ctx)
+		ctx, cancel := context.WithCancel(context.Background())
 		s.cancel = fn.Some(cancel)
 
 		err = s.resendPendingMsgs(ctx)

discovery/sync_manager.go

@@ -8,7 +8,6 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
-	"github.com/lightningnetwork/lnd/fn/v2"
 	"github.com/lightningnetwork/lnd/lnpeer"
 	"github.com/lightningnetwork/lnd/lnwire"
 	"github.com/lightningnetwork/lnd/routing/route"
@@ -201,9 +200,8 @@ type SyncManager struct {
 	// number of queries.
 	rateLimiter *rate.Limiter
 
-	wg     sync.WaitGroup
-	quit   chan struct{}
-	cancel fn.Option[context.CancelFunc]
+	wg   sync.WaitGroup
+	quit chan struct{}
 }
 
 // newSyncManager constructs a new SyncManager backed by the given config.
@@ -248,13 +246,10 @@ func newSyncManager(cfg *SyncManagerCfg) *SyncManager {
 }
 
 // Start starts the SyncManager in order to properly carry out its duties.
-func (m *SyncManager) Start(ctx context.Context) {
+func (m *SyncManager) Start() {
 	m.start.Do(func() {
-		ctx, cancel := context.WithCancel(ctx)
-		m.cancel = fn.Some(cancel)
-
 		m.wg.Add(1)
-		go m.syncerHandler(ctx)
+		go m.syncerHandler()
 	})
 }
 
@@ -264,7 +259,6 @@ func (m *SyncManager) Stop() {
 		log.Debugf("SyncManager is stopping")
 		defer log.Debugf("SyncManager stopped")
 
-		m.cancel.WhenSome(func(fn context.CancelFunc) { fn() })
 		close(m.quit)
 		m.wg.Wait()
 
@@ -288,7 +282,7 @@ func (m *SyncManager) Stop() {
 //     much of the public network as possible.
 //
 // NOTE: This must be run as a goroutine.
-func (m *SyncManager) syncerHandler(ctx context.Context) {
+func (m *SyncManager) syncerHandler() {
 	defer m.wg.Done()
 
 	m.cfg.RotateTicker.Resume()
@@ -386,7 +380,7 @@ func (m *SyncManager) syncerHandler(ctx context.Context) {
 			}
 			m.syncersMu.Unlock()
 
-			s.Start(ctx)
+			s.Start()
 
 			// Once we create the GossipSyncer, we'll signal to the
 			// caller that they can proceed since the SyncManager's
@@ -538,9 +532,6 @@ func (m *SyncManager) syncerHandler(ctx context.Context) {
 
 		case <-m.quit:
 			return
-
-		case <-ctx.Done():
-			return
 		}
 	}
 }

discovery/sync_manager_test.go

@@ -2,7 +2,6 @@ package discovery
 
 import (
 	"bytes"
-	"context"
 	"fmt"
 	"io"
 	"reflect"
@@ -83,7 +82,7 @@ func TestSyncManagerNumActiveSyncers(t *testing.T) {
 	}
 
 	syncMgr := newPinnedTestSyncManager(numActiveSyncers, pinnedSyncers)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// First we'll start by adding the pinned syncers. These should
@@ -135,7 +134,7 @@ func TestSyncManagerNewActiveSyncerAfterDisconnect(t *testing.T) {
 
 	// We'll create our test sync manager to have two active syncers.
 	syncMgr := newTestSyncManager(2)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// The first will be an active syncer that performs a historical sync
@@ -188,7 +187,7 @@ func TestSyncManagerRotateActiveSyncerCandidate(t *testing.T) {
 
 	// We'll create our sync manager with three active syncers.
 	syncMgr := newTestSyncManager(1)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// The first syncer registered always performs a historical sync.
@@ -236,7 +235,7 @@ func TestSyncManagerNoInitialHistoricalSync(t *testing.T) {
 	t.Parallel()
 
 	syncMgr := newTestSyncManager(0)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We should not expect any messages from the peer.
@@ -270,7 +269,7 @@ func TestSyncManagerInitialHistoricalSync(t *testing.T) {
 		t.Fatal("expected graph to not be considered as synced")
 	}
 
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We should expect to see a QueryChannelRange message with a
@@ -339,7 +338,7 @@ func TestSyncManagerHistoricalSyncOnReconnect(t *testing.T) {
 	t.Parallel()
 
 	syncMgr := newTestSyncManager(2)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We should expect to see a QueryChannelRange message with a
@@ -373,7 +372,7 @@ func TestSyncManagerForceHistoricalSync(t *testing.T) {
 	t.Parallel()
 
 	syncMgr := newTestSyncManager(1)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We should expect to see a QueryChannelRange message with a
@@ -411,7 +410,7 @@ func TestSyncManagerGraphSyncedAfterHistoricalSyncReplacement(t *testing.T) {
 	t.Parallel()
 
 	syncMgr := newTestSyncManager(1)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We should expect to see a QueryChannelRange message with a
@@ -469,7 +468,7 @@ func TestSyncManagerWaitUntilInitialHistoricalSync(t *testing.T) {
 	// We'll start by creating our test sync manager which will hold up to
 	// 2 active syncers.
 	syncMgr := newTestSyncManager(numActiveSyncers)
-	syncMgr.Start(context.Background())
+	syncMgr.Start()
 	defer syncMgr.Stop()
 
 	// We'll go ahead and create our syncers.

discovery/syncer.go

@@ -405,11 +405,11 @@ func newGossipSyncer(cfg gossipSyncerCfg, sema chan struct{}) *GossipSyncer {
 
 // Start starts the GossipSyncer and any goroutines that it needs to carry out
 // its duties.
-func (g *GossipSyncer) Start(ctx context.Context) {
+func (g *GossipSyncer) Start() {
 	g.started.Do(func() {
 		log.Debugf("Starting GossipSyncer(%x)", g.cfg.peerPub[:])
 
-		ctx, _ := g.cg.Create(ctx)
+		ctx, _ := g.cg.Create(context.Background())
 
 		// TODO(conner): only spawn channelGraphSyncer if remote
 		// supports gossip queries, and only spawn replyHandler if we