session: add ListSessionsByState method

Author: ellemouton

session/interface.go

@@ -167,6 +167,10 @@ type Store interface {
 	// ListSessionsByType returns all sessions of the given type.
 	ListSessionsByType(t Type) ([]*Session, error)
 
+	// ListSessionsByState returns all sessions currently known to the store
+	// that are in the given states.
+	ListSessionsByState(...State) ([]*Session, error)
+
 	// RevokeSession updates the state of the session with the given local
 	// public key to be revoked.
 	RevokeSession(*btcec.PublicKey) error

session/kvdb_store.go

@@ -383,6 +383,22 @@ func (db *BoltStore) ListSessionsByType(t Type) ([]*Session, error) {
 	})
 }
 
+// ListSessionsByState returns all sessions currently known to the store that
+// are in the given states.
+//
+// NOTE: this is part of the Store interface.
+func (db *BoltStore) ListSessionsByState(states ...State) ([]*Session, error) {
+	return db.listSessions(func(s *Session) bool {
+		for _, state := range states {
+			if s.State == state {
+				return true
+			}
+		}
+
+		return false
+	})
+}
+
 // listSessions returns all sessions currently known to the store that pass the
 // given filter function.
 func (db *BoltStore) listSessions(filterFn func(s *Session) bool) ([]*Session,

session/store_test.go

@@ -118,6 +118,33 @@ func TestBasicSessionStore(t *testing.T) {
 	assertEqualSessions(t, s1, sessions[0])
 	assertEqualSessions(t, s2, sessions[1])
 	assertEqualSessions(t, s3, sessions[2])
+
+	// Test that ListSessionsByState works.
+	sessions, err = db.ListSessionsByState(StateRevoked)
+	require.NoError(t, err)
+	require.Equal(t, 1, len(sessions))
+	assertEqualSessions(t, s1, sessions[0])
+
+	sessions, err = db.ListSessionsByState(StateCreated)
+	require.NoError(t, err)
+	require.Equal(t, 2, len(sessions))
+	assertEqualSessions(t, s2, sessions[0])
+	assertEqualSessions(t, s3, sessions[1])
+
+	sessions, err = db.ListSessionsByState(StateCreated, StateRevoked)
+	require.NoError(t, err)
+	require.Equal(t, 3, len(sessions))
+	assertEqualSessions(t, s1, sessions[0])
+	assertEqualSessions(t, s2, sessions[1])
+	assertEqualSessions(t, s3, sessions[2])
+
+	sessions, err = db.ListSessionsByState()
+	require.NoError(t, err)
+	require.Empty(t, sessions)
+
+	sessions, err = db.ListSessionsByState(StateInUse)
+	require.NoError(t, err)
+	require.Empty(t, sessions)
 }
 
 // TestLinkingSessions tests that session linking works as expected.