13566028875

Committed 27 Feb 2025 12:09PM UTC coverage: 49.396% (-9.4%) from 58.748%

Build # 13566028875

Build Type

Pull #9555

github

Committed by

ellemouton

Commit Message

graph/db: populate the graph cache in Start instead of during construction

In this commit, we move the graph cache population logic out of the
ChannelGraph constructor and into its Start method instead.

Pull Request Pull Request #9555: graph: extract cache from CRUD [6]

Run Details

34 of 54 new or added lines in 4 files covered. (62.96%)

27464 existing lines in 436 files now uncovered.

101095 of 204664 relevant lines covered (49.4%)

1.54 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/watchtower/wtdb/migration3/client_db.go

package migration3

import (
        "bytes"
        "encoding/binary"
        "errors"

        "github.com/lightningnetwork/lnd/kvdb"
        "github.com/lightningnetwork/lnd/tlv"
)

var (
        // cChanDetailsBkt is a top-level bucket storing:
        //   channel-id => cChannelSummary -> encoded ClientChanSummary.
        //                 => cChanDBID -> db-assigned-id
        cChanDetailsBkt = []byte("client-channel-detail-bucket")

        // cChanDBID is a key used in the cChanDetailsBkt to store the
        // db-assigned-id of a channel.
        cChanDBID = []byte("client-channel-db-id")

        // cChanIDIndexBkt is a top-level bucket storing:
        //    db-assigned-id -> channel-ID
        cChanIDIndexBkt = []byte("client-channel-id-index")

        // cChannelSummary is a key used in cChanDetailsBkt to store the encoded
        // body of ClientChanSummary.
        cChannelSummary = []byte("client-channel-summary")

        // ErrUninitializedDB signals that top-level buckets for the database
        // have not been initialized.
        ErrUninitializedDB = errors.New("db not initialized")

        // ErrCorruptChanDetails signals that the clients channel detail's
        // on-disk structure deviates from what is expected.
        ErrCorruptChanDetails = errors.New("channel details corrupted")

        byteOrder = binary.BigEndian
)

// MigrateChannelIDIndex adds a new channel ID index to the tower client db.
// This index is a mapping from db-assigned ID (a uint64 encoded using BigSize
// encoding) to real channel ID (32 bytes). This mapping will allow us to
// persist channel pointers with fewer bytes in the future.
func MigrateChannelIDIndex(tx kvdb.RwTx) error {
        log.Infof("Migrating the tower client db to add a new channel ID " +
                "index which stores a mapping from db-assigned ID to real " +
                "channel ID")

        // Create a new top-level bucket for the new index.
        indexBkt, err := tx.CreateTopLevelBucket(cChanIDIndexBkt)
        if err != nil {
                return err
        }

        // Get the top-level channel-details bucket. The keys of this bucket
        // are the real channel IDs.
        chanDetailsBkt := tx.ReadWriteBucket(cChanDetailsBkt)
        if chanDetailsBkt == nil {
                return ErrUninitializedDB
        }

        // Iterate over the keys of the channel-details bucket.
        return chanDetailsBkt.ForEach(func(chanID, _ []byte) error {
                // Ask the db for a new, unique, ID for the index bucket.
                nextSeq, err := indexBkt.NextSequence()
                if err != nil {
                        return err
                }

                // Encode the sequence number using BigSize encoding.
                var newIndex bytes.Buffer
                err = tlv.WriteVarInt(&newIndex, nextSeq, &[8]byte{})
                if err != nil {
                        return err
                }

                // Add the mapping from the db-assigned ID to the channel ID
                // to the new index.
                newIndexBytes := newIndex.Bytes()
                err = indexBkt.Put(newIndexBytes, chanID)
                if err != nil {
                        return err
                }

                chanDetails := chanDetailsBkt.NestedReadWriteBucket(chanID)
                if chanDetails == nil {
                        return ErrCorruptChanDetails
                }

                // Here we ensure that the channel-details bucket includes a
                // channel summary. The only reason we do this is so that we can
                // simulate a migration fail in a test to ensure that a
                // migration fail results in an untouched db.
                chanSummaryBytes := chanDetails.Get(cChannelSummary)
                if chanSummaryBytes == nil {
                        return ErrCorruptChanDetails
                }

                // In the channel-details sub-bucket for this channel, add the
                // new DB-assigned ID for this channel under the cChanDBID key.
                return chanDetails.Put(cChanDBID, newIndexBytes)
        })
}

1	package migration3
2
3	import (
4	"bytes"
5	"encoding/binary"
6	"errors"
7
8	"github.com/lightningnetwork/lnd/kvdb"
9	"github.com/lightningnetwork/lnd/tlv"
10	)
11
12	var (
13	// cChanDetailsBkt is a top-level bucket storing:
14	// channel-id => cChannelSummary -> encoded ClientChanSummary.
15	// => cChanDBID -> db-assigned-id
16	cChanDetailsBkt = []byte("client-channel-detail-bucket")
17
18	// cChanDBID is a key used in the cChanDetailsBkt to store the
19	// db-assigned-id of a channel.
20	cChanDBID = []byte("client-channel-db-id")
21
22	// cChanIDIndexBkt is a top-level bucket storing:
23	// db-assigned-id -> channel-ID
24	cChanIDIndexBkt = []byte("client-channel-id-index")
25
26	// cChannelSummary is a key used in cChanDetailsBkt to store the encoded
27	// body of ClientChanSummary.
28	cChannelSummary = []byte("client-channel-summary")
29
30	// ErrUninitializedDB signals that top-level buckets for the database
31	// have not been initialized.
32	ErrUninitializedDB = errors.New("db not initialized")
33
34	// ErrCorruptChanDetails signals that the clients channel detail's
35	// on-disk structure deviates from what is expected.
36	ErrCorruptChanDetails = errors.New("channel details corrupted")
37
38	byteOrder = binary.BigEndian
39	)
40
41	// MigrateChannelIDIndex adds a new channel ID index to the tower client db.
42	// This index is a mapping from db-assigned ID (a uint64 encoded using BigSize
43	// encoding) to real channel ID (32 bytes). This mapping will allow us to
44	// persist channel pointers with fewer bytes in the future.
UNCOV 45	func MigrateChannelIDIndex(tx kvdb.RwTx) error {	×
UNCOV 46	log.Infof("Migrating the tower client db to add a new channel ID " +	×
UNCOV 47	"index which stores a mapping from db-assigned ID to real " +	×
UNCOV 48	"channel ID")	×
UNCOV 49		×
UNCOV 50	// Create a new top-level bucket for the new index.	×
UNCOV 51	indexBkt, err := tx.CreateTopLevelBucket(cChanIDIndexBkt)	×
UNCOV 52	if err != nil {	×
53	return err	×
54	}	×
55
56	// Get the top-level channel-details bucket. The keys of this bucket
57	// are the real channel IDs.
UNCOV 58	chanDetailsBkt := tx.ReadWriteBucket(cChanDetailsBkt)	×
UNCOV 59	if chanDetailsBkt == nil {	×
60	return ErrUninitializedDB	×
61	}	×
62
63	// Iterate over the keys of the channel-details bucket.
UNCOV 64	return chanDetailsBkt.ForEach(func(chanID, _ []byte) error {	×
UNCOV 65	// Ask the db for a new, unique, ID for the index bucket.	×
UNCOV 66	nextSeq, err := indexBkt.NextSequence()	×
UNCOV 67	if err != nil {	×
68	return err	×
69	}	×
70
71	// Encode the sequence number using BigSize encoding.
UNCOV 72	var newIndex bytes.Buffer	×
UNCOV 73	err = tlv.WriteVarInt(&newIndex, nextSeq, &[8]byte{})	×
UNCOV 74	if err != nil {	×
75	return err	×
76	}	×
77
78	// Add the mapping from the db-assigned ID to the channel ID
79	// to the new index.
UNCOV 80	newIndexBytes := newIndex.Bytes()	×
UNCOV 81	err = indexBkt.Put(newIndexBytes, chanID)	×
UNCOV 82	if err != nil {	×
83	return err	×
84	}	×
85
UNCOV 86	chanDetails := chanDetailsBkt.NestedReadWriteBucket(chanID)	×
UNCOV 87	if chanDetails == nil {	×
88	return ErrCorruptChanDetails	×
89	}	×
90
91	// Here we ensure that the channel-details bucket includes a
92	// channel summary. The only reason we do this is so that we can
93	// simulate a migration fail in a test to ensure that a
94	// migration fail results in an untouched db.
UNCOV 95	chanSummaryBytes := chanDetails.Get(cChannelSummary)	×
UNCOV 96	if chanSummaryBytes == nil {	×
UNCOV 97	return ErrCorruptChanDetails	×
UNCOV 98	}	×
99
100	// In the channel-details sub-bucket for this channel, add the
101	// new DB-assigned ID for this channel under the cChanDBID key.
UNCOV 102	return chanDetails.Put(cChanDBID, newIndexBytes)	×
103	})
104	}

lightningnetwork / lnd / 13566028875

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous