15561477203

Committed 10 Jun 2025 01:54PM UTC coverage: 58.351% (-10.1%) from 68.487%

Build # 15561477203

Build Type

Pull #9356

github

Committed by

web-flow

Commit Message

Merge 6440b25db into c6d6d4c0b

Pull Request Pull Request #9356: lnrpc: add incoming/outgoing channel ids filter to forwarding history request

Run Details

33 of 36 new or added lines in 2 files covered. (91.67%)

28366 existing lines in 455 files now uncovered.

97715 of 167461 relevant lines covered (58.35%)

1.81 hits per line

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

80.0

/batch/interface.go

package batch

import "context"

// Request defines an operation that can be batched into a single bbolt
// transaction.
type Request[Q any] struct {
        // Opts holds various configuration options for a scheduled request.
        Opts *SchedulerOptions

        // Reset is called before each invocation of Update and is used to clear
        // any possible modifications to local state as a result of previous
        // calls to Update that were not committed due to a concurrent batch
        // failure.
        //
        // NOTE: This field is optional.
        Reset func()

        // Do is applied alongside other operations in the batch.
        //
        // NOTE: This method MUST NOT acquire any mutexes.
        Do func(tx Q) error

        // OnCommit is called if the batch or a subset of the batch including
        // this request all succeeded without failure. The passed error should
        // contain the result of the transaction commit, as that can still fail
        // even if none of the closures returned an error.
        //
        // NOTE: This field is optional.
        OnCommit func(commitErr error) error
}

// SchedulerOptions holds various configuration options for a scheduled request.
type SchedulerOptions struct {
        // Lazy should be true if we don't have to immediately execute this
        // request when it comes in. This means that it can be scheduled later,
        // allowing larger batches.
        Lazy bool

        // ReadOnly should be true if the request is read-only. By default,
        // this is false.
        ReadOnly bool
}

// NewDefaultSchedulerOpts returns a new SchedulerOptions with default values.
func NewDefaultSchedulerOpts() *SchedulerOptions {
        return &SchedulerOptions{
                Lazy:     false,
                ReadOnly: false,
        }
}

// NewSchedulerOptions returns a new SchedulerOptions with the given options
// applied on top of the default options.
func NewSchedulerOptions(options ...SchedulerOption) *SchedulerOptions {
        opts := NewDefaultSchedulerOpts()
        for _, o := range options {
                o(opts)
        }

        return opts
}

// SchedulerOption is a type that can be used to supply options to a scheduled
// request.
type SchedulerOption func(*SchedulerOptions)

// LazyAdd will make the request be executed lazily, added to the next batch to
// reduce db contention.
func LazyAdd() SchedulerOption {
        return func(opts *SchedulerOptions) {
                opts.Lazy = true
        }
}

// ReadOnly will mark the request as read-only. This means that the
// transaction will be executed in read-only mode, and no changes will be
// made to the database. If any requests in the same batch are not read-only,
// then the entire batch will be executed in read-write mode.
func ReadOnly() SchedulerOption {
        return func(opts *SchedulerOptions) {
                opts.ReadOnly = true
        }
}

// Scheduler abstracts a generic batching engine that accumulates an incoming
// set of Requests, executes them, and returns the error from the operation.
type Scheduler[Q any] interface {
        // Execute schedules a Request for execution with the next available
        // batch. This method blocks until the underlying closure has been
        // run against the database. The resulting error is returned to the
        // caller.
        Execute(ctx context.Context, req *Request[Q]) error
}

1	package batch
2
3	import "context"
4
5	// Request defines an operation that can be batched into a single bbolt
6	// transaction.
7	type Request[Q any] struct {
8	// Opts holds various configuration options for a scheduled request.
9	Opts *SchedulerOptions
10
11	// Reset is called before each invocation of Update and is used to clear
12	// any possible modifications to local state as a result of previous
13	// calls to Update that were not committed due to a concurrent batch
14	// failure.
15	//
16	// NOTE: This field is optional.
17	Reset func()
18
19	// Do is applied alongside other operations in the batch.
20	//
21	// NOTE: This method MUST NOT acquire any mutexes.
22	Do func(tx Q) error
23
24	// OnCommit is called if the batch or a subset of the batch including
25	// this request all succeeded without failure. The passed error should
26	// contain the result of the transaction commit, as that can still fail
27	// even if none of the closures returned an error.
28	//
29	// NOTE: This field is optional.
30	OnCommit func(commitErr error) error
31	}
32
33	// SchedulerOptions holds various configuration options for a scheduled request.
34	type SchedulerOptions struct {
35	// Lazy should be true if we don't have to immediately execute this
36	// request when it comes in. This means that it can be scheduled later,
37	// allowing larger batches.
38	Lazy bool
39
40	// ReadOnly should be true if the request is read-only. By default,
41	// this is false.
42	ReadOnly bool
43	}
44
45	// NewDefaultSchedulerOpts returns a new SchedulerOptions with default values.
46	func NewDefaultSchedulerOpts() *SchedulerOptions {	3✔
47	return &SchedulerOptions{	3✔
48	Lazy: false,	3✔
49	ReadOnly: false,	3✔
50	}	3✔
51	}	3✔
52
53	// NewSchedulerOptions returns a new SchedulerOptions with the given options
54	// applied on top of the default options.
55	func NewSchedulerOptions(options ...SchedulerOption) *SchedulerOptions {	3✔
56	opts := NewDefaultSchedulerOpts()	3✔
57	for _, o := range options {	6✔
58	o(opts)	3✔
59	}	3✔
60
61	return opts	3✔
62	}
63
64	// SchedulerOption is a type that can be used to supply options to a scheduled
65	// request.
66	type SchedulerOption func(*SchedulerOptions)
67
68	// LazyAdd will make the request be executed lazily, added to the next batch to
69	// reduce db contention.
70	func LazyAdd() SchedulerOption {	3✔
71	return func(opts *SchedulerOptions) {	6✔
72	opts.Lazy = true	3✔
73	}	3✔
74	}
75
76	// ReadOnly will mark the request as read-only. This means that the
77	// transaction will be executed in read-only mode, and no changes will be
78	// made to the database. If any requests in the same batch are not read-only,
79	// then the entire batch will be executed in read-write mode.
UNCOV 80	func ReadOnly() SchedulerOption {	×
UNCOV 81	return func(opts *SchedulerOptions) {	×
UNCOV 82	opts.ReadOnly = true	×
UNCOV 83	}	×
84	}
85
86	// Scheduler abstracts a generic batching engine that accumulates an incoming
87	// set of Requests, executes them, and returns the error from the operation.
88	type Scheduler[Q any] interface {
89	// Execute schedules a Request for execution with the next available
90	// batch. This method blocks until the underlying closure has been
91	// run against the database. The resulting error is returned to the
92	// caller.
93	Execute(ctx context.Context, req *Request[Q]) error
94	}

lightningnetwork / lnd / 15561477203

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