Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GODRIVER-2388 Improved Bulk Write API. #1884

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

qingyang-hu
Copy link
Collaborator

@qingyang-hu qingyang-hu commented Nov 5, 2024

GODRIVER-2388
GODRIVER-3348
GODRIVER-3349
GODRIVER-3364

GODRIVER-3421 (added in fc91428)

Summary

Improved Bulk Write API.

Background & Motivation

Refactor the (Operation).createWireMessage() to support the bulk write batching.

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added the priority-3-low Low Priority PR for Review label Nov 5, 2024
Copy link
Contributor

mongodb-drivers-pr-bot bot commented Nov 5, 2024

API Change Report

./v2/mongo

compatible changes

(*Client).BulkWrite: added
ClientBulkWriteDeleteResult: added
ClientBulkWriteException: added
ClientBulkWriteInsertResult: added
ClientBulkWriteResult: added
ClientBulkWriteUpdateResult: added
ClientDeleteManyModel: added
ClientDeleteOneModel: added
ClientInsertOneModel: added
ClientReplaceOneModel: added
ClientUpdateManyModel: added
ClientUpdateOneModel: added
ClientWriteModels: added
NewClientDeleteManyModel: added
NewClientDeleteOneModel: added
NewClientInsertOneModel: added
NewClientReplaceOneModel: added
NewClientUpdateManyModel: added
NewClientUpdateOneModel: added

./v2/mongo/options

compatible changes

ClientBulkWrite: added
ClientBulkWriteOptions: added
ClientBulkWriteOptionsBuilder: added

./v2/x/mongo/driver

incompatible changes

(*Batches).AdvanceBatch: removed
(*Batches).ClearBatch: removed
(*Batches).Valid: removed
Batches.Current: removed
##NewCursorResponse: changed from func(ResponseInfo) (CursorResponse, error) to func(./v2/x/bsonx/bsoncore.Document, ResponseInfo) (CursorResponse, error)
Operation.Batches: changed from *Batches to OperationBatches
##Operation.ProcessResponseFn: changed from func(ResponseInfo) error to func(context.Context, ./v2/x/bsonx/bsoncore.Document, ResponseInfo) error
ResponseInfo.ServerResponse: removed

compatible changes

(*Batches).AdvanceBatches: added
(*Batches).AppendBatchArray: added
(*Batches).AppendBatchSequence: added
(*Batches).IsOrdered: added
(*Batches).Size: added
ExtractCursorDocument: added
OperationBatches: added
ResponseInfo.Error: added

./v2/x/mongo/driver/session

incompatible changes

Client.RetryRead: removed
Client.RetryWrite: removed

./v2/x/mongo/driver/wiremessage

compatible changes

DocumentSequenceToArray: added

@@ -398,7 +398,7 @@ func TestClientSideEncryptionCustomCrypt(t *testing.T) {
"expected 0 calls to DecryptExplicit, got %v", cc.numDecryptExplicitCalls)
assert.Equal(mt, cc.numCloseCalls, 0,
"expected 0 calls to Close, got %v", cc.numCloseCalls)
assert.Equal(mt, cc.numBypassAutoEncryptionCalls, 2,
assert.Equal(mt, cc.numBypassAutoEncryptionCalls, 1,
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only call it once after the operation.go refactoring.

// A top-level error that occurred when attempting to communicate with the server
// or execute the bulk write. This value may not be populated if the exception was
// thrown due to errors occurring on individual writes.
TopLevelError *WriteError
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cannot use Error as a field name because of the conflict with the conventional method name.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Consider the more conventional Err or WriteError.

@qingyang-hu qingyang-hu marked this pull request as ready for review November 5, 2024 20:18
@qingyang-hu qingyang-hu added priority-2-medium Medium Priority PR for Review and removed priority-3-low Low Priority PR for Review labels Nov 5, 2024
mongo/errors.go Show resolved Hide resolved
mongo/client.go Outdated Show resolved Hide resolved
mongo/client.go Outdated Show resolved Hide resolved
mongo/client_bulk_write_models.go Outdated Show resolved Hide resolved
}
type clientWriteModel struct {
namespace string
model interface{}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add stronger type constraints to this?

type clientBulkWriteModel interface {
	ClientInsertOneModel // etc.
}

type clientWriteModel struct {
	namespace string
	model     clientBulkWriteModel
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need an additional abstraction for an un-exported struct.

mongo/results.go Show resolved Hide resolved
mongo/results.go Outdated Show resolved Hide resolved
mongo/results.go Outdated Show resolved Hide resolved
mongo/results.go Outdated Show resolved Hide resolved
}

// Error implements the error interface.
func (bwe ClientBulkWriteException) Error() string {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function doesn't return an error if the write is unacknowledged. The specifications required that users be able to discern whether a BulkWriteResult contains acknowledged results. Either return an error indicating an unacknowledged result, or update ClientBulkWriteResult in the spirit of GODRIVER-2821.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can test this with the following:

package main

import (
	"context"

	"go.mongodb.org/mongo-driver/v2/bson"
	"go.mongodb.org/mongo-driver/v2/mongo"
	"go.mongodb.org/mongo-driver/v2/mongo/options"
	"go.mongodb.org/mongo-driver/v2/mongo/writeconcern"
)

func main() {
	client, err := mongo.Connect()
	if err != nil {
		panic(err)
	}

	defer func() { _ = client.Disconnect(context.Background()) }()

	pairs := &mongo.ClientWriteModels{}

	insertOneModel := mongo.NewClientInsertOneModel().SetDocument(bson.D{{"x", 1}})

	opts := options.ClientBulkWrite().SetWriteConcern(writeconcern.Unacknowledged()).SetOrdered(false)

	pairs = pairs.AppendInsertOne("db", "k", insertOneModel)
	_, err = client.BulkWrite(context.Background(), pairs, opts) // Should not panic
	if err != nil {
		panic(err)
	}
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a unified spec test that covers this case? If not we should add one / add an integration test.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +300 to +302
if filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the error message when the filter is not given.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

delete filter cannot be nil

Comment on lines +435 to +437
if doc.filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the error message when the filter is not given.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

update filter cannot be nil

@qingyang-hu qingyang-hu force-pushed the godriver2388v2 branch 4 times, most recently from 4bc724e to dbd44c9 Compare November 15, 2024 23:14
Copy link
Collaborator

@prestonvasquez prestonvasquez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qingyang-hu There are still outstanding issues from the previous review.

@@ -13,6 +13,55 @@ import (
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/operation"
)

// ClientBulkWriteResult is the result type returned by a client-level BulkWrite operation.
type ClientBulkWriteResult struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The specifications say that "Users MUST be able to discern whether a [result] contains verbose results without inspecting the value provided for verboseResults in [options]". Does this mean we should add a boolean value ClientBulkWriteResult: HasVerboseResults?

Copy link
Collaborator Author

@qingyang-hu qingyang-hu Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The initial thought was to leave results maps as nil when verboseResults is false. However, I think you are right that an additional HasVerboseResults field is more obvious.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, either solution sounds good to me.

},
}
var n int
n, _, err = batches.AppendBatchSequence(nil, 4, 16_000, 16_000)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the significance of 16_000 here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is just a number big enough not to cut the document, so only the maxCount regulates the output. Will add a comment there.

var idx int32
dst = wiremessage.AppendMsgSectionType(dst, wiremessage.DocumentSequence)
idx, dst = bsoncore.ReserveLength(dst)
dst = append(dst, identifier...)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the specifications:

The first entry in each document has the name of the operation as its key and the index ini the nsInfo array of the namespace on which the operation should be performed as its value

When I do command monitoring for client bulk write with multiple pairs, I get the following:

2024/11/18 14:39:47 started: &{Command:{"bulkWrite": {"$numberInt":"1"},"errorsOnly": false,"ordered": true,"lsid": {"id": {"$binary":{"base64":"XTDtLVGhTx6MEIcFDhf0qw==","subType":"04"}}},"txnNumber": {"$numberLong":"1"},"$clusterTime": {"clusterTime": {"$timestamp":{"t":1731965987,"i":1}},"signature": {"hash": {"$binary":{"base64":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","subType":"00"}},"keyId": {"$numberLong":"0"}}},"$db": "admin","ops": [{"insert": {"$numberInt":"0"},"document": {"_id": {"$oid":"673bb423a86efe4126c4c585"},"x": {"$numberInt":"1"}}},{"insert": {"$numberInt":"0"},"document": {"_id": {"$oid":"673bb423a86efe4126c4c586"},"x": {"$numberInt":"2"}}}],"nsInfo": [{"ns": "db.coll"}]} DatabaseName:admin CommandName:bulkWrite RequestID:1 ConnectionID:localhost:27017[-4] ServerConnectionID:0x14000390250 ServiceID:<nil>}

Where the index value for each document in the sequence is {"$numberInt":"0"}. Shouldn't this be {"$numberInt":"0"}, then {"$numberInt":"1"}, etc?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same thing occurs with the other client bulk write operations.

Copy link
Collaborator Author

@qingyang-hu qingyang-hu Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean the Int32 value of the operation name such as "insert", "update", or "delete"?

...
"ops":[
    {
        "insert":{
            "$numberInt":"0"
        },
...

It is "the index in the nsInfo array of the namespace on which the operation should be performed as its value".

The specs also require:

When constructing the nsInfo array for a bulkWrite batch, drivers MUST only include the namespaces that are referenced in the ops array for that batch.

and:

Drivers MUST NOT include duplicate namespaces in this list.

Therefore, if both operations perform on the same namespace, the nsInfo array should contain only one item, and both operation indices are 0, pointing to "db.coll".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, thanks for the explanation!

// AppendBatchSequence appends dst with document sequence of batches as long as the limits of max count, max
// document size, or total size allows. It returns the number of batches appended, the new appended slice, and
// any error raised. It returns the origenal input slice if nothing can be appends within the limits.
func (b *Batches) AppendBatchSequence(dst []byte, maxCount, maxDocSize, _ int) (int, []byte, error) {
Copy link
Collaborator

@prestonvasquez prestonvasquez Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does maxMessageSizeBytes not apply when not using bulk write? For example, when using collection.Insert would we batch up to 48mb or 16mb? If I understand the documentation correctly, the batch has a limit of 48mb and individual documents in the batch have a limit of 16mb. Right now it appears we are limiting the entire batch to 16mb. The clientBulkWrite API does what I would expect.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The logic derives from the original *Batches.AdvanceBatch(), which takes maxDocumentSize as maxMessageSizeBytes. A test case covers the logic here.

@matthewdale, do you know any history of the logic?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the logic in fc91428.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we open a ticket for this to avoid adding more complexity to this PR?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, it doesn't make sense to review incorrect logic since we've already refactored that block. Moreover, fc91428 removed the maxBsonObjectSize requirement from the client-level bulk write to simplify the PR.

However, I'm open to reverting and only keeping what is more relevant.

Copy link
Collaborator

@prestonvasquez prestonvasquez Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIU the updated solution correctly it is now possible to put a single document over the 16mb limit on the wire message, relying on the server to validate the document size. From what I can tell, this is spec-compliant. But do we want to make data-heavy round trips that we know are going to fail?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, both the client-level bulk write and legacy bulk write rely on the server to check the document size limit in fc91428.

But I agree the validation on the server side is inefficient. Pre-validating the size on the driver side is not a breach of the spec because it is not prohibited, either, especially for performance reasons. So I will commit another change to return driver side errors.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW IMO we can defer that work.

@@ -268,7 +271,13 @@ type Operation struct {
// has more documents than can fit in a single command. This should only be specified for
// commands that are batch compatible. For more information, please refer to the definition of
// Batches.
Batches *Batches
Batches interface {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest internalizing this interface so that we can create a compile check for mongo.modelBatches and x/mongo.Batches.

return len(mb.models) - mb.offset
}

func (mb *modelBatches) AppendBatchSequence(dst []byte, maxCount, maxDocSize, totalSize int) (int, []byte, error) {
Copy link
Collaborator

@prestonvasquez prestonvasquez Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have test coverage for this in the following two cases:

  1. One doc exceeds maxBsonObjectSize, I would expect an error.
  2. Multiple documents < maxBsonObjectSize together exceed maxMessageSizeBytes. I would expect n > 1.

Here is a helpful gist I used: https://gist.github.com/prestonvasquez/40daa306abc5a21147235d2ea982d841

Copy link
Collaborator Author

@qingyang-hu qingyang-hu Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've involved GODRIVER-3421 in fc91428, which removes the BSON document size validation requirement. So the first case is no longer needed. The second case is added in both client_bulk_write_test.go and client_test.go.

@qingyang-hu qingyang-hu force-pushed the godriver2388v2 branch 2 times, most recently from 9958e3f to 82df60a Compare December 4, 2024 20:14
Copy link
Collaborator Author

@qingyang-hu qingyang-hu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressing GODRIVER-3421, the BSON document size validation requirement for the client bulk write operation has been removed in fc91428. Both client bulk writes and legacy bulk writes rely on the server to check the document size limit now.

mtOpts := mtest.NewOptions().MinServerVersion("8.0").AtlasDataLake(false).ClientType(mtest.Pinned)
mt := mtest.New(t, mtOpts)

mt.Run("bulkWrite batch splits a writeModels input with greater than maxWriteBatchSize operations", func(mt *mtest.T) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we label the prose tests? I.e., this should be

3. bulkWrite batch splits a writeModels input with greater than maxWriteBatchSize operations

cli, err := mongo.Connect(cliOptions)
require.NoError(mt, err, "Connect error: %v", err)
_, err = cli.BulkWrite(context.Background(), models)
assert.ErrorContains(mt, err, "context deadline exceeded", "expected a timeout error, got: %v", err)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest using asser.ErrorIs and the package error context.DeadlineExceeded:

Suggested change
assert.ErrorContains(mt, err, "context deadline exceeded", "expected a timeout error, got: %v", err)
assert.ErrorIs(mt, err, context.DeadlineExceeded, "expected a timeout error, got: %v", err)

if res == nil || !res.Acknowledged {
return newDocumentResult(emptyCoreDocument, err), nil
}
rawBuilder := bsoncore.NewDocumentBuilder().
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we use bsoncore? Can we just populate mongo.ClientBulkWriteResult and encode?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The encoder encodes all fields in lowercase by default. An alternative may be a struct with tags. The current resolution follows the pattern in executeCreateChangeStream and executeListDatabases.

model.ArrayFilters = v.ArrayFilters
}
return v.Namespace, model, nil

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Hint *bson.RawValue
Upsert *bool
}
err := bson.Unmarshal(value, &v)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to define the extra fields? Can we unmarshal into an embedded mongo.ClientUpdateOneModel?

var v struct {
	Namespace string
	mongo.ClientUpdateOneModel
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spec tests put bulk write fields in parallel with the namespace. We cannot embed mongo.ClientUpdateOneModel without a nested level.

@@ -394,7 +394,7 @@ func TestClientSideEncryptionCustomCrypt(t *testing.T) {
"expected 0 calls to DecryptExplicit, got %v", cc.numDecryptExplicitCalls)
assert.Equal(mt, cc.numCloseCalls, 0,
"expected 0 calls to Close, got %v", cc.numCloseCalls)
assert.Equal(mt, cc.numBypassAutoEncryptionCalls, 2,
assert.Equal(mt, cc.numBypassAutoEncryptionCalls, 1,
"expected 2 calls to BypassAutoEncryption, got %v", cc.numBypassAutoEncryptionCalls)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Update error message to match updated assertion.

Suggested change
"expected 2 calls to BypassAutoEncryption, got %v", cc.numBypassAutoEncryptionCalls)
"expected 1 call to BypassAutoEncryption, got %v", cc.numBypassAutoEncryptionCalls)

@@ -422,6 +423,39 @@ func ReadMsgSectionRawDocumentSequence(src []byte) (identifier string, data []by
return identifier, rem, rest, true
}

// DocumentSequenceToArray converts a document sequence in byte slice to an array.
func DocumentSequenceToArray(src []byte) (dst, rem []byte, ok bool) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: This function is only used in operation.go, consider moving it there.

}

// AppendUpdateOne appends ClientUpdateOneModels.
func (m *ClientWriteModels) AppendUpdateOne(database, collection string, models ...*ClientUpdateOneModel) *ClientWriteModels {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to use per-model-type setters instead of the unexported interface pattern that the existing bulk write models use?

For example:

type ClientWriteModel interface {
	clientWriteModel()
}

type ClientUpdateOneModel struct { ... }

func (ClientUpdateOneModel) clientWriteModel() {}


func (m *ClientWriteModels) Append(database, collection string, models ...ClientWriteModel) *ClientWriteModels {
	m.models = append(...)
	return m
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've revised the (*Client).BulkWrite() signature to accept the Namespace-WriteModel pairs in a slice to align with the legacy bulk write API.

@@ -514,4 +515,39 @@ func TestClient(t *testing.T) {
errmsg := `invalid value "-1s" for "Timeout": value must be positive`
assert.Equal(t, errmsg, err.Error(), "expected error %v, got %v", errmsg, err.Error())
})
t.Run("bulkWrite with large messages", func(t *testing.T) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any test that connects to a running MongoDB server should ideally use mtest. Since we can't use mtest in the mongo package, this test case should be moved to internal/integration/client_test.go.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this file required, or can it be omitted?

@@ -718,6 +719,95 @@ func TestClient(t *testing.T) {
})
}
})
mtBulkWriteOpts := mtest.NewOptions().MinServerVersion("8.0").AtlasDataLake(false).ClientType(mtest.Pinned)
mt.RunOpts("bulk write with nil filter", mtBulkWriteOpts, func(mt *mtest.T) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: We should separate test functions as much as possible because it makes the code easier to read and the test easier to run. Consider splitting these two BulkWrite subtests into its own test func.

E.g.

func TestClient_BulkWrite(t *testing.T) {
    // ...

Comment on lines +579 to +584
type clientInsertDoc struct {
namespace int
document interface{}
}

func (d *clientInsertDoc) marshal(bsonOpts *options.BSONOptions, registry *bson.Registry) (interface{}, bsoncore.Document, error) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to omit these duplicated types and define the marshal functions on the exported type instead? Do the duplicated types serve any additional purpose?

Comment on lines +620 to +623
if err != nil {
if d.filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

update filter cannot be nil

Comment on lines +680 to +683
if err != nil {
if d.filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

delete filter cannot be nil

Comment on lines +435 to +437
if doc.filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

update filter cannot be nil

Comment on lines +300 to +302
if filter == nil {
return nil, fmt.Errorf("%w: filter is required", err)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to nest this nil filter check in this error handling block? Can we move this check to the beginning of marshal?

Optional: Consider a clearer error message, like

delete filter cannot be nil

// A top-level error that occurred when attempting to communicate with the server
// or execute the bulk write. This value may not be populated if the exception was
// thrown due to errors occurring on individual writes.
TopLevelError *WriteError
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Consider the more conventional Err or WriteError.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-2-medium Medium Priority PR for Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants