session: rename GetSession method

Rename it to GetSessionByLocalPub so that it is more accurately named
and so that we free up the GetSession name for future use.

Author: ellemouton

session/interface.go

@@ -294,8 +294,10 @@ type Store interface {
 		expiry time.Time, serverAddr string, opts ...Option) (*Session,
 		error)
 
-	// GetSession fetches the session with the given key.
-	GetSession(ctx context.Context, key *btcec.PublicKey) (*Session, error)
+	// GetSessionByLocalPub fetches the session with the given local pub
+	// key.
+	GetSessionByLocalPub(ctx context.Context,
+		key *btcec.PublicKey) (*Session, error)
 
 	// ListAllSessions returns all sessions currently known to the store.
 	ListAllSessions(ctx context.Context) ([]*Session, error)

session/kvdb_store.go

@@ -331,11 +331,11 @@ func (db *BoltStore) UpdateSessionRemotePubKey(_ context.Context, localPubKey,
 	})
 }
 
-// GetSession fetches the session with the given key.
+// GetSessionByLocalPub fetches the session with the given local pub key.
 //
 // NOTE: this is part of the Store interface.
-func (db *BoltStore) GetSession(_ context.Context, key *btcec.PublicKey) (
-	*Session, error) {
+func (db *BoltStore) GetSessionByLocalPub(_ context.Context,
+	key *btcec.PublicKey) (*Session, error) {
 
 	var session *Session
 	err := db.View(func(tx *bbolt.Tx) error {

session/store_test.go

@@ -82,7 +82,7 @@ func TestBasicSessionStore(t *testing.T) {
 	// Ensure that we can retrieve each session by both its local pub key
 	// and by its ID.
 	for _, s := range []*Session{s1, s2, s3} {
-		session, err := db.GetSession(ctx, s.LocalPublicKey)
+		session, err := db.GetSessionByLocalPub(ctx, s.LocalPublicKey)
 		require.NoError(t, err)
 		assertEqualSessions(t, s, session)
 
@@ -92,7 +92,7 @@ func TestBasicSessionStore(t *testing.T) {
 	}
 
 	// Fetch session 1 and assert that it currently has no remote pub key.
-	session1, err := db.GetSession(ctx, s1.LocalPublicKey)
+	session1, err := db.GetSessionByLocalPub(ctx, s1.LocalPublicKey)
 	require.NoError(t, err)
 	require.Nil(t, session1.RemotePublicKey)
 
@@ -107,7 +107,7 @@ func TestBasicSessionStore(t *testing.T) {
 	require.NoError(t, err)
 
 	// Assert that the session now does have the remote pub key.
-	session1, err = db.GetSession(ctx, s1.LocalPublicKey)
+	session1, err = db.GetSessionByLocalPub(ctx, s1.LocalPublicKey)
 	require.NoError(t, err)
 	require.True(t, remotePub.IsEqual(session1.RemotePublicKey))
 
@@ -116,7 +116,7 @@ func TestBasicSessionStore(t *testing.T) {
 
 	// Now revoke the session and assert that the state is revoked.
 	require.NoError(t, db.ShiftState(ctx, s1.ID, StateRevoked))
-	s1, err = db.GetSession(ctx, s1.LocalPublicKey)
+	s1, err = db.GetSessionByLocalPub(ctx, s1.LocalPublicKey)
 	require.NoError(t, err)
 	require.Equal(t, s1.State, StateRevoked)
 
@@ -299,7 +299,7 @@ func TestStateShift(t *testing.T) {
 
 	// Check that the session is in the StateCreated state. Also check that
 	// the "RevokedAt" time has not yet been set.
-	s1, err := db.GetSession(ctx, s1.LocalPublicKey)
+	s1, err := db.GetSessionByLocalPub(ctx, s1.LocalPublicKey)
 	require.NoError(t, err)
 	require.Equal(t, StateCreated, s1.State)
 	require.Equal(t, time.Time{}, s1.RevokedAt)
@@ -310,7 +310,7 @@ func TestStateShift(t *testing.T) {
 
 	// This should have worked. Since it is now in a terminal state, the
 	// "RevokedAt" time should be set.
-	s1, err = db.GetSession(ctx, s1.LocalPublicKey)
+	s1, err = db.GetSessionByLocalPub(ctx, s1.LocalPublicKey)
 	require.NoError(t, err)
 	require.Equal(t, StateRevoked, s1.State)
 	require.True(t, clock.Now().Equal(s1.RevokedAt))

session_rpcserver.go

@@ -577,7 +577,7 @@ func (s *sessionRpcServer) RevokeSession(ctx context.Context,
 		return nil, fmt.Errorf("error parsing public key: %v", err)
 	}
 
-	sess, err := s.cfg.db.GetSession(ctx, pubKey)
+	sess, err := s.cfg.db.GetSessionByLocalPub(ctx, pubKey)
 	if err != nil {
 		return nil, fmt.Errorf("error fetching session: %v", err)
 	}
@@ -1319,7 +1319,7 @@ func (s *sessionRpcServer) RevokeAutopilotSession(ctx context.Context,
 		return nil, fmt.Errorf("error parsing public key: %v", err)
 	}
 
-	sess, err := s.cfg.db.GetSession(ctx, pubKey)
+	sess, err := s.cfg.db.GetSessionByLocalPub(ctx, pubKey)
 	if err != nil {
 		return nil, err
 	}