CBG-5013 move gocb dcp client to separate file #7917
Conversation
There was a problem hiding this comment.
Pull request overview
This PR renames the DCPClient struct to GoCBDCPClient and moves it to a dedicated file (gocb_dcp_client.go) in preparation for making DCPClient an interface. The changes are purely structural - no functional behavior is modified.
Key changes:
- Renamed
base/dcp_client.gotobase/gocb_dcp_client.go - Renamed all occurrences of
DCPClienttype toGoCBDCPClient - Updated all method receivers and return types accordingly
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
base/gocb_dcp_client.go |
Renamed struct DCPClient to GoCBDCPClient, updated all method receivers and function signatures |
base/dcp_client_test.go |
Updated test helper method receiver and variable type declarations to use GoCBDCPClient |
base/dcp_client_stream_observer.go |
Updated all stream observer method receivers from DCPClient to GoCBDCPClient |
tools/cache_perf_tool/dcpDataGeneration.go |
Updated variable and function signatures to use GoCBDCPClient instead of DCPClient |
| var ErrVbUUIDMismatch = errors.New("VbUUID mismatch when failOnRollback set") | ||
|
|
||
| type DCPClient struct { | ||
| type GoCBDCPClient struct { |
There was a problem hiding this comment.
The struct name has inconsistent casing: 'GoCB' should be 'Gocb' to follow Go naming conventions (GocbDCPClient).
| type GoCBDCPClient struct { | |
| type GocbDCPClient struct { |
There was a problem hiding this comment.
We aren't consistent with GoCB and Gocb. Most things use GoCB except GocbV2Bucket.
|
|
||
| // NewDCPClientForTest is a test-only function to create a DCP client with a specific number of vbuckets. | ||
| func NewDCPClientForTest(ctx context.Context, t *testing.T, ID string, callback sgbucket.FeedEventCallbackFunc, options DCPClientOptions, bucket *GocbV2Bucket, numVbuckets uint16) (*DCPClient, error) { | ||
| func NewDCPClientForTest(ctx context.Context, t *testing.T, ID string, callback sgbucket.FeedEventCallbackFunc, options DCPClientOptions, bucket *GocbV2Bucket, numVbuckets uint16) (*GoCBDCPClient, error) { |
There was a problem hiding this comment.
The function name 'NewDCPClientForTest' no longer matches the struct type 'GoCBDCPClient'. Consider renaming to 'NewGoCBDCPClientForTest' for consistency.
| } | ||
|
|
||
| func createDCPClient(t *testing.T, ctx context.Context, bucket *base.GocbV2Bucket, callback sgbucket.FeedEventCallbackFunc, dbStats *expvar.Map, numWorkers, numVBuckets int) (*base.DCPClient, error) { | ||
| func createDCPClient(t *testing.T, ctx context.Context, bucket *base.GocbV2Bucket, callback sgbucket.FeedEventCallbackFunc, dbStats *expvar.Map, numWorkers, numVBuckets int) (*base.GoCBDCPClient, error) { |
There was a problem hiding this comment.
The function name 'createDCPClient' no longer matches the struct type 'GoCBDCPClient'. Consider renaming to 'createGoCBDCPClient' for consistency.
| func createDCPClient(t *testing.T, ctx context.Context, bucket *base.GocbV2Bucket, callback sgbucket.FeedEventCallbackFunc, dbStats *expvar.Map, numWorkers, numVBuckets int) (*base.GoCBDCPClient, error) { | |
| func createGoCBDCPClient(t *testing.T, ctx context.Context, bucket *base.GocbV2Bucket, callback sgbucket.FeedEventCallbackFunc, dbStats *expvar.Map, numWorkers, numVBuckets int) (*base.GoCBDCPClient, error) { |
There was a problem hiding this comment.
I didn't rename this because it is a test tool.
CBG-5013 move gocb dcp client to separate file to prep for
DCPClientbecoming an interfacedcp_client.gotogocb_dcp_client.goDCPClienttoGocbDCPClientIntegration Tests
GSI=true,xattrs=truehttps://jenkins.sgwdev.com/job/SyncGatewayIntegration/192/ (unrelated db/indextest.TestRemoveIndexesUseViewsTrueAndFalse)