firewalldb: update comments and var names

Change all comments and variable names mentioning "session ID" to "group
ID" instead. As of this commit, session linking is not yet possible and
so what ever session IDs are passed in are also group IDs.

Author: ellemouton

firewalldb/kvstores.go

@@ -13,11 +13,11 @@ the `perm` and `temp` buckets are identical in structure. The only difference is
 that the `temp` bucket is cleared on restart of the db.
 
 rules -> perm -> rule-name -> global   -> {k:v}
-              -> sessions -> sessionID -> session-kv-store  -> {k:v}
+              -> sessions -> group ID  -> session-kv-store  -> {k:v}
 			               -> feature-kv-stores -> feature-name -> {k:v}
 
       -> temp -> rule-name -> global   -> {k:v}
-	      -> sessions -> sessionID -> session-kv-store  -> {k:v}
+	      -> sessions -> group ID  -> session-kv-store  -> {k:v}
 				       -> feature-kv-stores -> feature-name -> {k:v}
 */
 
@@ -44,7 +44,7 @@ var (
 	sessKVStoreBucketKey = []byte("session-kv-store")
 
 	// featureKVStoreBucketKey is the kye under which a kv store specific
-	// the session id and feature name is stored.
+	// the group id and feature name is stored.
 	featureKVStoreBucketKey = []byte("feature-kv-store")
 )
 
@@ -72,12 +72,12 @@ type KVStores interface {
 type KVStoreTx interface {
 	// Global returns a persisted global, rule-name indexed, kv store. A
 	// rule with a given name will have access to this store independent of
-	// session ID or feature.
+	// group ID or feature.
 	Global() KVStore
 
 	// Local returns a persisted local kv store for the rule. Depending on
 	// how the implementation is initialised, this will either be under the
-	// session ID namespace or the session ID _and_ feature name namespace.
+	// group ID namespace or the group ID _and_ feature name namespace.
 	Local() KVStore
 
 	// GlobalTemp is similar to the Global store except that its contents
@@ -105,17 +105,17 @@ type KVStore interface {
 
 // RulesDB can be used to initialise a new rules.KVStores.
 type RulesDB interface {
-	GetKVStores(rule string, sessionID session.ID, feature string) KVStores
+	GetKVStores(rule string, groupID session.ID, feature string) KVStores
 }
 
 // GetKVStores constructs a new rules.KVStores backed by a bbolt db.
-func (db *DB) GetKVStores(rule string, sessionID session.ID,
+func (db *DB) GetKVStores(rule string, groupID session.ID,
 	feature string) KVStores {
 
 	return &kvStores{
 		DB:          db,
 		ruleName:    rule,
-		sessionID:   sessionID,
+		groupID:     groupID,
 		featureName: feature,
 	}
 }
@@ -124,7 +124,7 @@ func (db *DB) GetKVStores(rule string, sessionID session.ID,
 type kvStores struct {
 	*DB
 	ruleName    string
-	sessionID   session.ID
+	groupID     session.ID
 	featureName string
 }
 
@@ -237,10 +237,10 @@ func (tx *kvStoreTx) Global() KVStore {
 //
 // NOTE: this is part of the KVStoreTx interface.
 func (tx *kvStoreTx) Local() KVStore {
-	fn := getSessionRuleBucket(true, tx.ruleName, tx.sessionID)
+	fn := getSessionRuleBucket(true, tx.ruleName, tx.groupID)
 	if tx.featureName != "" {
 		fn = getSessionFeatureRuleBucket(
-			true, tx.ruleName, tx.sessionID, tx.featureName,
+			true, tx.ruleName, tx.groupID, tx.featureName,
 		)
 	}
 
@@ -268,10 +268,10 @@ func (tx *kvStoreTx) GlobalTemp() KVStore {
 //
 // NOTE: this is part of the KVStoreTx interface.
 func (tx *kvStoreTx) LocalTemp() KVStore {
-	fn := getSessionRuleBucket(true, tx.ruleName, tx.sessionID)
+	fn := getSessionRuleBucket(true, tx.ruleName, tx.groupID)
 	if tx.featureName != "" {
 		fn = getSessionFeatureRuleBucket(
-			false, tx.ruleName, tx.sessionID, tx.featureName,
+			false, tx.ruleName, tx.groupID, tx.featureName,
 		)
 	}
 
@@ -390,11 +390,11 @@ func getGlobalRuleBucket(perm bool, ruleName string) getBucketFunc {
 }
 
 // getSessionRuleBucket returns a function that can be used to fetch the
-// bucket under which a kv store for a specific rule-name and session ID is
+// bucket under which a kv store for a specific rule-name and group ID is
 // stored. The `perm` param determines if the temporary or permanent store is
 // used.
 func getSessionRuleBucket(perm bool, ruleName string,
-	sessionID session.ID) getBucketFunc {
+	groupID session.ID) getBucketFunc {
 
 	return func(tx *bbolt.Tx, create bool) (*bbolt.Bucket, error) {
 		ruleBucket, err := getRuleBucket(perm, ruleName)(tx, create)
@@ -414,27 +414,28 @@ func getSessionRuleBucket(perm bool, ruleName string,
 				return nil, err
 			}
 
-			return sessBucket.CreateBucketIfNotExists(sessionID[:])
+			return sessBucket.CreateBucketIfNotExists(groupID[:])
 		}
 
 		sessBucket := ruleBucket.Bucket(sessKVStoreBucketKey)
 		if sessBucket == nil {
 			return nil, nil
 		}
-		return sessBucket.Bucket(sessionID[:]), nil
+		return sessBucket.Bucket(groupID[:]), nil
 	}
 }
 
 // getSessionFeatureRuleBucket returns a function that can be used to fetch the
-// bucket under which a kv store for a specific rule-name, session ID and
+// bucket under which a kv store for a specific rule-name, group ID and
 // feature name is stored. The `perm` param determines if the temporary or
 // permanent store is used.
 func getSessionFeatureRuleBucket(perm bool, ruleName string,
-	sessionID session.ID, featureName string) getBucketFunc {
+	groupID session.ID, featureName string) getBucketFunc {
 
 	return func(tx *bbolt.Tx, create bool) (*bbolt.Bucket, error) {
 		sessBucket, err := getSessionRuleBucket(
-			perm, ruleName, sessionID)(tx, create)
+			perm, ruleName, groupID,
+		)(tx, create)
 		if err != nil {
 			return nil, err
 		}

firewalldb/kvstores_test.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"testing"
 
+	"github.com/lightninglabs/lightning-terminal/session"
 	"github.com/stretchr/testify/require"
 )
 
@@ -153,17 +154,17 @@ func TestKVStoreNameSpaces(t *testing.T) {
 	})
 
 	var (
-		sessionID1 = [4]byte{1, 1, 1, 1}
-		sessionID2 = [4]byte{2, 2, 2, 2}
+		groupID1 = intToSessionID(1)
+		groupID2 = intToSessionID(2)
 	)
 
-	// Two DBs for same session but different features.
-	rulesDB1 := db.GetKVStores("test-rule", sessionID1, "auto-fees")
-	rulesDB2 := db.GetKVStores("test-rule", sessionID1, "re-balance")
+	// Two DBs for same group but different features.
+	rulesDB1 := db.GetKVStores("test-rule", groupID1, "auto-fees")
+	rulesDB2 := db.GetKVStores("test-rule", groupID1, "re-balance")
 
-	// The third DB is for the same rule but a different session. It is
+	// The third DB is for the same rule but a different group. It is
 	// for the same feature as db 2.
-	rulesDB3 := db.GetKVStores("test-rule", sessionID2, "re-balance")
+	rulesDB3 := db.GetKVStores("test-rule", groupID2, "re-balance")
 
 	// Test that the three ruleDBs share the same global space.
 	err = rulesDB1.Update(func(tx KVStoreTx) error {
@@ -270,12 +271,12 @@ func TestKVStoreNameSpaces(t *testing.T) {
 	require.NoError(t, err)
 	require.True(t, bytes.Equal(v, []byte("3")))
 
-	// Test that the session space is shared by the first two dbs but not
+	// Test that the group space is shared by the first two dbs but not
 	// the third. To do this, we re-init the DB's but leave the feature
-	// names out. This way, we will access the session storage.
-	rulesDB1 = db.GetKVStores("test-rule", sessionID1, "")
-	rulesDB2 = db.GetKVStores("test-rule", sessionID1, "")
-	rulesDB3 = db.GetKVStores("test-rule", sessionID2, "")
+	// names out. This way, we will access the group storage.
+	rulesDB1 = db.GetKVStores("test-rule", groupID1, "")
+	rulesDB2 = db.GetKVStores("test-rule", groupID1, "")
+	rulesDB3 = db.GetKVStores("test-rule", groupID2, "")
 
 	err = rulesDB1.Update(func(tx KVStoreTx) error {
 		return tx.Local().Set(ctx, "test", []byte("thing 1"))
@@ -325,3 +326,10 @@ func TestKVStoreNameSpaces(t *testing.T) {
 	require.NoError(t, err)
 	require.True(t, bytes.Equal(v, []byte("thing 3")))
 }
+
+func intToSessionID(i uint32) session.ID {
+	var id session.ID
+	byteOrder.PutUint32(id[:], i)
+
+	return id
+}

firewalldb/privacy_mapper.go

@@ -16,8 +16,8 @@ import (
 /*
 	The PrivacyMapper data is stored in the following structure in the db:
 
-	privacy -> session id -> real-to-pseudo -> {k:v}
-			      -> pseudo-to-real -> {k:v}
+	privacy -> group id -> real-to-pseudo -> {k:v}
+			    -> pseudo-to-real -> {k:v}
 */
 
 const (
@@ -33,16 +33,16 @@ var (
 	pseudoStrAlphabetLen = len(pseudoStrAlphabet)
 )
 
-// NewPrivacyMapDB is a function type that takes a session ID and uses it to
+// NewPrivacyMapDB is a function type that takes a group ID and uses it to
 // construct a new PrivacyMapDB.
-type NewPrivacyMapDB func(sessionID session.ID) PrivacyMapDB
+type NewPrivacyMapDB func(groupID session.ID) PrivacyMapDB
 
 // PrivacyDB constructs a PrivacyMapDB that will be indexed under the given
-// sessionID key.
-func (db *DB) PrivacyDB(sessionID session.ID) PrivacyMapDB {
+// group ID key.
+func (db *DB) PrivacyDB(groupID session.ID) PrivacyMapDB {
 	return &privacyMapDB{
-		DB:        db,
-		sessionID: sessionID,
+		DB:      db,
+		groupID: groupID,
 	}
 }
 
@@ -83,7 +83,7 @@ type PrivacyMapTx interface {
 // privacyMapDB is an implementation of PrivacyMapDB.
 type privacyMapDB struct {
 	*DB
-	sessionID session.ID
+	groupID session.ID
 }
 
 // beginTx starts db transaction. The transaction will be a read or read-write
@@ -175,7 +175,7 @@ func (p *privacyMapTx) NewPair(real, pseudo string) error {
 		return err
 	}
 
-	sessBucket, err := privacyBucket.CreateBucketIfNotExists(p.sessionID[:])
+	sessBucket, err := privacyBucket.CreateBucketIfNotExists(p.groupID[:])
 	if err != nil {
 		return err
 	}
@@ -210,7 +210,7 @@ func (p *privacyMapTx) PseudoToReal(pseudo string) (string, error) {
 		return "", err
 	}
 
-	sessBucket := privacyBucket.Bucket(p.sessionID[:])
+	sessBucket := privacyBucket.Bucket(p.groupID[:])
 	if sessBucket == nil {
 		return "", ErrNoSuchKeyFound
 	}
@@ -236,7 +236,7 @@ func (p *privacyMapTx) RealToPseudo(real string) (string, error) {
 		return "", err
 	}
 
-	sessBucket := privacyBucket.Bucket(p.sessionID[:])
+	sessBucket := privacyBucket.Bucket(p.groupID[:])
 	if sessBucket == nil {
 		return "", ErrNoSuchKeyFound
 	}