couchbase / sync_gateway / 227

Committed 07 Nov 2024 03:25PM UTC coverage: 65.169% (+0.02%) from 65.145%

Build # 227

Build Type

push

jenkins

Committed by

web-flow

Commit Message

Revert "CBG-4321: store skipped sequences as single entries below a certain threshold" (#7184)

This reverts commit d9ae0e6a9.

Run Details

5 of 5 new or added lines in 2 files covered. (100.0%)

14 existing lines in 5 files now uncovered.

36593 of 56151 relevant lines covered (65.17%)

0.74 hits per line

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

72.06

/base/leaky_bucket.go

/*
Copyright 2016-Present Couchbase, Inc.
Use of this software is governed by the Business Source License included in
the file licenses/BSL-Couchbase.txt.  As of the Change Date specified in that
file, in accordance with the Business Source License, use of this software will
be governed by the Apache License, Version 2.0, included in the file
licenses/APL2.txt.
*/

package base

import (
        "context"
        "expvar"
        "fmt"

        sgbucket "github.com/couchbase/sg-bucket"
)

var _ Bucket = &LeakyBucket{}

// A wrapper around a Bucket to support forced errors.  For testing use only.
type LeakyBucket struct {
        bucket      Bucket
        config      *LeakyBucketConfig
        collections map[string]*LeakyDataStore
}

var _ sgbucket.BucketStore = &LeakyBucket{}
var _ sgbucket.DynamicDataStoreBucket = &LeakyBucket{}

func NewLeakyBucket(bucket Bucket, config LeakyBucketConfig) *LeakyBucket {
        return &LeakyBucket{
                bucket:      bucket,
                config:      &config,
                collections: make(map[string]*LeakyDataStore),
        }
}

func (b *LeakyBucket) GetName() string {
        return b.bucket.GetName()
}

func (b *LeakyBucket) UUID() (string, error) {
        return b.bucket.UUID()
}

func (b *LeakyBucket) Close(ctx context.Context) {
        if !b.config.IgnoreClose {
                b.bucket.Close(ctx)
        }
}

// For walrus handling, ignore close needs to be set after the bucket is initialized
func (b *LeakyBucket) SetIgnoreClose(value bool) {
        b.config.IgnoreClose = value
}

func (b *LeakyBucket) CloseAndDelete(ctx context.Context) error {
        if bucket, ok := b.bucket.(sgbucket.DeleteableStore); ok {
                return bucket.CloseAndDelete(ctx)
        }
        return nil
}

func (b *LeakyBucket) IsSupported(feature sgbucket.BucketStoreFeature) bool {
        return b.bucket.IsSupported(feature)
}

func (b *LeakyBucket) GetMaxVbno() (uint16, error) {
        return b.bucket.GetMaxVbno()
}

func (b *LeakyBucket) DefaultDataStore() sgbucket.DataStore {
        return NewLeakyDataStore(b, b.bucket.DefaultDataStore(), b.config)
}

func (b *LeakyBucket) ListDataStores() ([]sgbucket.DataStoreName, error) {
        return b.bucket.ListDataStores()
}

func (b *LeakyBucket) NamedDataStore(name sgbucket.DataStoreName) (sgbucket.DataStore, error) {
        dataStore, err := b.bucket.NamedDataStore(name)
        if err != nil {
                return nil, err
        }
        return NewLeakyDataStore(b, dataStore, b.config), nil
}

func (b *LeakyBucket) GetUnderlyingBucket() Bucket {
        return b.bucket
}

func (b *LeakyBucket) CreateDataStore(ctx context.Context, name sgbucket.DataStoreName) error {
        dynamicDataStore, ok := b.GetUnderlyingBucket().(sgbucket.DynamicDataStoreBucket)
        if !ok {
                return fmt.Errorf("Bucket %T doesn't support dynamic collection creation", b.GetUnderlyingBucket())
        }
        return dynamicDataStore.CreateDataStore(ctx, name)
}

func (b *LeakyBucket) DropDataStore(name sgbucket.DataStoreName) error {
        dynamicDataStore, ok := b.GetUnderlyingBucket().(sgbucket.DynamicDataStoreBucket)
        if !ok {
                return fmt.Errorf("Bucket %T doesn't support dynamic collection creation", b.GetUnderlyingBucket())
        }
        return dynamicDataStore.DropDataStore(name)
}

// The config object that controls the LeakyBucket behavior
type LeakyBucketConfig struct {
        // Incr() fails N times before finally succeeding
        IncrTemporaryFailCount uint16

        // Allows us to force a number of failed executions of GetDDoc, DeleteDDoc and DropIndex. It will fail the
        // number of times specific in these values and then succeed.
        DDocDeleteErrorCount int
        DDocGetErrorCount    int

        DCPFeedMissingDocs []string // Emulate entry not appearing on DCP feed

        ForceErrorSetRawKeys []string // Issuing a SetRaw call with a specified key will return an error

        ForceTimeoutErrorOnUpdateKeys []string // Specified keys will return timeout error AFTER write is sent to server

        // Returns a partial error the first time ViewCustom is called
        FirstTimeViewCustomPartialError bool
        PostQueryCallback               func(ddoc, viewName string, params map[string]interface{}) // Issues callback after issuing query when bucket.ViewQuery is called

        PostN1QLQueryCallback func()

        // UpdateCallback issues additional callback in WriteUpdate after standard callback completes, but prior to document write.  Allows
        // tests to trigger CAS retry handling by modifying the underlying document in a UpdateCallback implementation.
        UpdateCallback func(key string)

        // GetRawCallback issues a callback prior to running GetRaw. Allows tests to issue a doc mutation or deletion prior
        // to GetRaw being ran.
        GetRawCallback       func(key string) error
        GetWithXattrCallback func(key string) error

        PostUpdateCallback func(key string)

        SetXattrCallback func(key string) error

        // WriteWithXattrCallback is ran before WriteWithXattr is called. This can be used to trigger a CAS retry
        WriteWithXattrCallback func(key string)

        // IncrCallback issues a callback during incr.  Used for sequence allocation race tests
        IncrCallback func()

        // When IgnoreClose is set to true, bucket.Close() is a no-op.  Used when multiple references to a bucket are active.
        IgnoreClose bool
}

func (b *LeakyBucket) StartDCPFeed(ctx context.Context, args sgbucket.FeedArguments, callback sgbucket.FeedEventCallbackFunc, dbStats *expvar.Map) error {
        if len(b.config.DCPFeedMissingDocs) > 0 {
                wrappedCallback := func(event sgbucket.FeedEvent) bool {
                        for _, key := range b.config.DCPFeedMissingDocs {
                                if string(event.Key) == key {
                                        return false
                                }
                        }
                        return callback(event)
                }
                return b.bucket.StartDCPFeed(ctx, args, wrappedCallback, dbStats)
        }
        return b.bucket.StartDCPFeed(ctx, args, callback, dbStats)
}

1	/*
2	Copyright 2016-Present Couchbase, Inc.
3	Use of this software is governed by the Business Source License included in
4	the file licenses/BSL-Couchbase.txt. As of the Change Date specified in that
5	file, in accordance with the Business Source License, use of this software will
6	be governed by the Apache License, Version 2.0, included in the file
7	licenses/APL2.txt.
8	*/
9
10	package base
11
12	import (
13	"context"
14	"expvar"
15	"fmt"
16
17	sgbucket "github.com/couchbase/sg-bucket"
18	)
19
20	var _ Bucket = &LeakyBucket{}
21
22	// A wrapper around a Bucket to support forced errors. For testing use only.
23	type LeakyBucket struct {
24	bucket Bucket
25	config *LeakyBucketConfig
26	collections map[string]*LeakyDataStore
27	}
28
29	var _ sgbucket.BucketStore = &LeakyBucket{}
30	var _ sgbucket.DynamicDataStoreBucket = &LeakyBucket{}
31
32	func NewLeakyBucket(bucket Bucket, config LeakyBucketConfig) *LeakyBucket {	1✔
33	return &LeakyBucket{	1✔
34	bucket: bucket,	1✔
35	config: &config,	1✔
36	collections: make(map[string]*LeakyDataStore),	1✔
37	}	1✔
38	}	1✔
39
40	func (b *LeakyBucket) GetName() string {	1✔
41	return b.bucket.GetName()	1✔
42	}	1✔
43
44	func (b *LeakyBucket) UUID() (string, error) {	1✔
45	return b.bucket.UUID()	1✔
46	}	1✔
47
48	func (b *LeakyBucket) Close(ctx context.Context) {	1✔
49	if !b.config.IgnoreClose {	2✔
50	b.bucket.Close(ctx)	1✔
51	}	1✔
52	}
53
54	// For walrus handling, ignore close needs to be set after the bucket is initialized
55	func (b *LeakyBucket) SetIgnoreClose(value bool) {	×
56	b.config.IgnoreClose = value	×
57	}	×
58
59	func (b *LeakyBucket) CloseAndDelete(ctx context.Context) error {	×
60	if bucket, ok := b.bucket.(sgbucket.DeleteableStore); ok {	×
61	return bucket.CloseAndDelete(ctx)	×
62	}	×
63	return nil	×
64	}
65
66	func (b *LeakyBucket) IsSupported(feature sgbucket.BucketStoreFeature) bool {	1✔
67	return b.bucket.IsSupported(feature)	1✔
68	}	1✔
69
70	func (b *LeakyBucket) GetMaxVbno() (uint16, error) {	×
71	return b.bucket.GetMaxVbno()	×
72	}	×
73
74	func (b *LeakyBucket) DefaultDataStore() sgbucket.DataStore {	1✔
75	return NewLeakyDataStore(b, b.bucket.DefaultDataStore(), b.config)	1✔
76	}	1✔
77
78	func (b *LeakyBucket) ListDataStores() ([]sgbucket.DataStoreName, error) {	1✔
79	return b.bucket.ListDataStores()	1✔
80	}	1✔
81
82	func (b *LeakyBucket) NamedDataStore(name sgbucket.DataStoreName) (sgbucket.DataStore, error) {	1✔
83	dataStore, err := b.bucket.NamedDataStore(name)	1✔
84	if err != nil {	1✔
85	return nil, err	×
86	}	×
87	return NewLeakyDataStore(b, dataStore, b.config), nil	1✔
88	}
89
90	func (b *LeakyBucket) GetUnderlyingBucket() Bucket {	1✔
91	return b.bucket	1✔
92	}	1✔
93
94	func (b *LeakyBucket) CreateDataStore(ctx context.Context, name sgbucket.DataStoreName) error {	1✔
95	dynamicDataStore, ok := b.GetUnderlyingBucket().(sgbucket.DynamicDataStoreBucket)	1✔
96	if !ok {	1✔
97	return fmt.Errorf("Bucket %T doesn't support dynamic collection creation", b.GetUnderlyingBucket())	×
98	}	×
99	return dynamicDataStore.CreateDataStore(ctx, name)	1✔
100	}
101
102	func (b *LeakyBucket) DropDataStore(name sgbucket.DataStoreName) error {	1✔
103	dynamicDataStore, ok := b.GetUnderlyingBucket().(sgbucket.DynamicDataStoreBucket)	1✔
104	if !ok {	1✔
105	return fmt.Errorf("Bucket %T doesn't support dynamic collection creation", b.GetUnderlyingBucket())	×
106	}	×
107	return dynamicDataStore.DropDataStore(name)	1✔
108	}
109
110	// The config object that controls the LeakyBucket behavior
111	type LeakyBucketConfig struct {
112	// Incr() fails N times before finally succeeding
113	IncrTemporaryFailCount uint16
114
115	// Allows us to force a number of failed executions of GetDDoc, DeleteDDoc and DropIndex. It will fail the
116	// number of times specific in these values and then succeed.
117	DDocDeleteErrorCount int
118	DDocGetErrorCount int
119
120	DCPFeedMissingDocs []string // Emulate entry not appearing on DCP feed
121
122	ForceErrorSetRawKeys []string // Issuing a SetRaw call with a specified key will return an error
123
124	ForceTimeoutErrorOnUpdateKeys []string // Specified keys will return timeout error AFTER write is sent to server
125
126	// Returns a partial error the first time ViewCustom is called
127	FirstTimeViewCustomPartialError bool
128	PostQueryCallback func(ddoc, viewName string, params map[string]interface{}) // Issues callback after issuing query when bucket.ViewQuery is called
129
130	PostN1QLQueryCallback func()
131
132	// UpdateCallback issues additional callback in WriteUpdate after standard callback completes, but prior to document write. Allows
133	// tests to trigger CAS retry handling by modifying the underlying document in a UpdateCallback implementation.
134	UpdateCallback func(key string)
135
136	// GetRawCallback issues a callback prior to running GetRaw. Allows tests to issue a doc mutation or deletion prior
137	// to GetRaw being ran.
138	GetRawCallback func(key string) error
139	GetWithXattrCallback func(key string) error
140
141	PostUpdateCallback func(key string)
142
143	SetXattrCallback func(key string) error
144
145	// WriteWithXattrCallback is ran before WriteWithXattr is called. This can be used to trigger a CAS retry
146	WriteWithXattrCallback func(key string)
147
148	// IncrCallback issues a callback during incr. Used for sequence allocation race tests
149	IncrCallback func()
150
151	// When IgnoreClose is set to true, bucket.Close() is a no-op. Used when multiple references to a bucket are active.
152	IgnoreClose bool
153	}
154
155	func (b LeakyBucket) StartDCPFeed(ctx context.Context, args sgbucket.FeedArguments, callback sgbucket.FeedEventCallbackFunc, dbStats expvar.Map) error {	1✔
156	if len(b.config.DCPFeedMissingDocs) > 0 {	2✔
157	wrappedCallback := func(event sgbucket.FeedEvent) bool {	2✔
158	for _, key := range b.config.DCPFeedMissingDocs {	2✔
159	if string(event.Key) == key {	1✔
UNCOV 160	return false	×
UNCOV 161	}	×
162	}
163	return callback(event)	1✔
164	}
165	return b.bucket.StartDCPFeed(ctx, args, wrappedCallback, dbStats)	1✔
166	}
167	return b.bucket.StartDCPFeed(ctx, args, callback, dbStats)	1✔
168	}

couchbase / sync_gateway / 227

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