12312390362

Committed 13 Dec 2024 08:44AM UTC coverage: 57.458% (+8.5%) from 48.92%

Build # 12312390362

Build Type

Pull #9343

github

Committed by

ellemouton

Commit Message

fn: rework the ContextGuard and add tests

In this commit, the ContextGuard struct is re-worked such that the
context that its new main WithCtx method provides is cancelled in sync
with a parent context being cancelled or with it's quit channel being
cancelled. Tests are added to assert the behaviour. In order for the
close of the quit channel to be consistent with the cancelling of the
derived context, the quit channel _must_ be contained internal to the
ContextGuard so that callers are only able to close the channel via the
exposed Quit method which will then take care to first cancel any
derived context that depend on the quit channel before returning.

Pull Request Pull Request #9343: fn: expand the ContextGuard and add tests

Run Details

101853 of 177264 relevant lines covered (57.46%)

24972.93 hits per line

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

50.0

/batch/interface.go

package batch

import "github.com/lightningnetwork/lnd/kvdb"

// Request defines an operation that can be batched into a single bbolt
// transaction.
type Request struct {
        // 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()

        // Update is applied alongside other operations in the batch.
        //
        // NOTE: This method MUST NOT acquire any mutexes.
        Update func(tx kvdb.RwTx) 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

        // 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
}

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

// LazyAdd will make the request be executed lazily, added to the next batch to
// reduce db contention.
func LazyAdd() SchedulerOption {
        return func(r *Request) {
                r.lazy = 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 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(req *Request) error
}

1	package batch
2
3	import "github.com/lightningnetwork/lnd/kvdb"
4
5	// Request defines an operation that can be batched into a single bbolt
6	// transaction.
7	type Request struct {
8	// Reset is called before each invocation of Update and is used to clear
9	// any possible modifications to local state as a result of previous
10	// calls to Update that were not committed due to a concurrent batch
11	// failure.
12	//
13	// NOTE: This field is optional.
14	Reset func()
15
16	// Update is applied alongside other operations in the batch.
17	//
18	// NOTE: This method MUST NOT acquire any mutexes.
19	Update func(tx kvdb.RwTx) error
20
21	// OnCommit is called if the batch or a subset of the batch including
22	// this request all succeeded without failure. The passed error should
23	// contain the result of the transaction commit, as that can still fail
24	// even if none of the closures returned an error.
25	//
26	// NOTE: This field is optional.
27	OnCommit func(commitErr error) error
28
29	// lazy should be true if we don't have to immediately execute this
30	// request when it comes in. This means that it can be scheduled later,
31	// allowing larger batches.
32	lazy bool
33	}
34
35	// SchedulerOption is a type that can be used to supply options to a scheduled
36	// request.
37	type SchedulerOption func(r *Request)
38
39	// LazyAdd will make the request be executed lazily, added to the next batch to
40	// reduce db contention.
41	func LazyAdd() SchedulerOption {	283✔
42	return func(r *Request) {	283✔
43	r.lazy = true	×
44	}	×
45	}
46
47	// Scheduler abstracts a generic batching engine that accumulates an incoming
48	// set of Requests, executes them, and returns the error from the operation.
49	type Scheduler interface {
50	// Execute schedules a Request for execution with the next available
51	// batch. This method blocks until the underlying closure has been
52	// run against the database. The resulting error is returned to the
53	// caller.
54	Execute(req *Request) error
55	}

lightningnetwork / lnd / 12312390362

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