GODRIVER-2976 Remove deprecated BSON code. #1698

qingyang-hu · 2024-07-03T21:36:29Z

GODRIVER-2976

Summary

Remove all deprecated BSON code.

Background & Motivation

mongodb-drivers-pr-bot · 2024-07-03T21:43:20Z

API Change Report

./bson

incompatible changes

CompareTimestamp: removed
CopyValueToBytes: removed
ErrNilType: removed
ErrNoDecoder: removed
ErrNoEncoder: removed
ErrNoTypeMapEntry: removed
ErrNotPointer: removed
ExtJSONValueReaderPool: removed
ExtJSONValueWriterPool: removed
IsValidObjectID: removed
MarshalValueWithRegistry: removed
NewExtJSONValueReaderPool: removed
NewExtJSONValueWriterPool: removed
NewValueReaderPool: removed
NewValueWriterPool: removed
SliceWriter: removed
UnmarshalExtJSONWithContext: removed
UnmarshalExtJSONWithRegistry: removed
UnmarshalValueWithRegistry: removed
UnmarshalWithContext: removed
UnmarshalWithRegistry: removed
ValueReaderPool: removed
ValueWriterFlusher: removed
ValueWriterPool: removed

qingyang-hu · 2024-07-05T15:42:55Z

bson/extjson_reader.go

-// ExtJSONValueReaderPool is a pool for ValueReaders that read ExtJSON.
-//
-// Deprecated: ExtJSONValueReaderPool will not be supported in Go Driver 2.0.
-type ExtJSONValueReaderPool struct {


qingyang-hu · 2024-07-05T15:43:50Z

bson/marshal.go

-//
-// Deprecated: Using a custom registry to marshal individual BSON values will not be supported in Go
-// Driver 2.0.
-func MarshalValueWithRegistry(r *Registry, val interface{}) (Type, []byte, error) {


Only called in the mongo package. Moved there.

qingyang-hu · 2024-07-05T15:52:45Z

bson/reader.go

-// The bytes of the value will be appended to dst.
-//
-// Deprecated: BytesReader will not be supported in Go Driver 2.0.
-type BytesReader interface {


Only used by copier.

qingyang-hu · 2024-07-05T16:00:11Z

mongo/mongo.go

 // getEncoder takes a writer, BSON options, and a BSON registry and returns a properly configured
 // bson.Encoder that writes to the given writer.
 func getEncoder(
 	w io.Writer,
 	opts *options.BSONOptions,
 	reg *bson.Registry,
 ) (*bson.Encoder, error) {
-	vw := bvwPool.Get(w)


Stop pooling since Put is never called.

qingyang-hu · 2024-07-05T17:28:21Z

bson/bson_test.go

@@ -30,28 +30,6 @@ func noerr(t *testing.T, err error) {
 	}
 }

-func TestCompareTimestamp(t *testing.T) {


qingyang-hu · 2024-07-05T17:54:59Z

bson/extjson_writer.go

-// NewExtJSONValueWriterPool creates a new pool for ValueWriter instances that write to ExtJSON.
-//
-// Deprecated: ExtJSONValueWriterPool will not be supported in Go Driver 2.0.
-func NewExtJSONValueWriterPool() *ExtJSONValueWriterPool {


Only used in "marshal.go".

qingyang-hu · 2024-07-05T18:07:17Z

bson/registry.go

-// ErrNotPointer is returned when a non-pointer type is provided to LookupDecoder.
-//
-// Deprecated: ErrNotPointer will not be supported in Go Driver 2.0.
-var ErrNotPointer = errors.New("non-pointer provided to LookupDecoder")


qingyang-hu · 2024-07-05T18:13:57Z

bson/value_reader.go

-// NewValueReaderPool instantiates a new ValueReaderPool.
-//
-// Deprecated: ValueReaderPool will not be supported in Go Driver 2.0.
-func NewValueReaderPool() *ValueReaderPool {


qingyang-hu · 2024-07-05T18:15:10Z

bson/value_writer.go

-// NewValueWriterPool creates a new pool for ValueWriter instances that write to BSON.
-//
-// Deprecated: ValueWriterPool will not be supported in Go Driver 2.0.
-func NewValueWriterPool() *ValueWriterPool {


Only used in "default_value_encoders.go".

qingyang-hu · 2024-07-05T18:18:49Z

bson/writer.go

-// implement ValueWriter may also implement this interface.
-//
-// Deprecated: BytesWriter will not be supported in Go Driver 2.0.
-type BytesWriter interface {


Only used in copier.

qingyang-hu · 2024-07-05T18:20:45Z

bson/writer.go

-// ValueWriterFlusher is a superset of ValueWriter that exposes functionality to flush to the underlying buffer.
-//
-// Deprecated: ValueWriterFlusher will not be supported in Go Driver 2.0.
-type ValueWriterFlusher interface {


Only used by ValueWriterPool.GetAtModeElement(), which is only called by MarshalValueWithRegistry().

matthewdale · 2024-07-16T17:40:28Z

mongo/util.go

+	},
+}
+
+func marshalValueWithRegistry(r *bson.Registry, val interface{}) (bsoncore.Value, error) {


This is redundant with the existing marshalValue function. The memory optimization is good, but we should make that memory optimization in a single place for all callers, either in this PR or in another PR.

I've switched to marshalValue. Optimization can be done in another PR.

matthewdale · 2024-07-16T18:47:30Z

bson/registry_test.go

+					if !cmp.Equal(goterr.Error(), wanterr, cmp.Comparer(assert.CompareErrors)) {
+						t.Errorf("errors did not match: got %#v, want %q", goterr, wanterr)


This should use assert.EqualError.

Suggested change

if !cmp.Equal(goterr.Error(), wanterr, cmp.Comparer(assert.CompareErrors)) {

t.Errorf("errors did not match: got %#v, want %q", goterr, wanterr)

assert.EqualError(t, goterr, wanterr, "errors did not match")

prestonvasquez · 2024-07-16T22:17:53Z

bson/copier_test.go

-		t.Run("CopyValue error", func(t *testing.T) {
-			want := errors.New("CopyValue error")
-			llvrw := &TestValueReaderWriter{t: t, bsontype: TypeString, err: want, errAfter: llvrwReadString}
-			_, _, got := appendValueBytes(make([]byte, 0), llvrw)
-			if !assert.CompareErrors(got, want) {
-				t.Errorf("Errors do not match. got %v; want %v", got, want)
-			}
-		})


This subtest should be moved to CopyValueToBytes.

prestonvasquez · 2024-07-16T22:43:57Z

bson/unmarshal_value_test.go

-		}
-	})
-	// tests covering GODRIVER-2779
-	t.Run("UnmarshalValueWithRegistry with custom registry", func(t *testing.T) {


Custom registry's can still be defined using NewDecoder. Do we currently apply the test matrix for this test to NewDecoder. If not, instead of removing this test suggest updating it to the new pattern.

Moved to TestUnmarshalWithRegistry in "unmarshal_test.go"

prestonvasquez · 2024-07-16T22:45:39Z

bson/unmarshal_value_test.go

@@ -110,13 +56,11 @@ func BenchmarkSliceCodecUnmarshal(b *testing.B) {
 			bytes:    bsoncore.AppendString(nil, strings.Repeat("t", 4096)),
 		},
 	}
-	reg := NewRegistry()


Suggest using NewDecoder with SetRegistry to preserve the original intention of this benchmark.

qingyang-hu · 2024-07-17T16:36:56Z

internal/integration/unified/client_entity.go

+		atomic.AddInt32(&c.numConnsCheckedOut, 1)
 	case event.ConnectionCheckedIn:
-		c.numConnsCheckedOut--
+		atomic.AddInt32(&c.numConnsCheckedOut, -1)


Updated for racing

matthewdale

Looks good! 👍

mongodb-drivers-pr-bot bot added the priority-3-low Low Priority PR for Review label Jul 3, 2024

WIP

fd391ba

qingyang-hu force-pushed the godriver2976p4 branch from 41bdaad to fd391ba Compare July 3, 2024 22:02

WIP

615c93d

qingyang-hu force-pushed the godriver2976p4 branch from c712eba to 0832721 Compare July 4, 2024 04:31

WIP

6d76528

qingyang-hu force-pushed the godriver2976p4 branch from 0832721 to 6d76528 Compare July 4, 2024 04:56

qingyang-hu commented Jul 5, 2024

View reviewed changes

qingyang-hu force-pushed the godriver2976p4 branch from a097df1 to 96d0d2c Compare July 5, 2024 16:01

qingyang-hu commented Jul 5, 2024

View reviewed changes

WIP

87a2c5a

qingyang-hu force-pushed the godriver2976p4 branch from 96d0d2c to 87a2c5a Compare July 5, 2024 17:50

qingyang-hu commented Jul 5, 2024

View reviewed changes

qingyang-hu marked this pull request as ready for review July 5, 2024 18:25

qingyang-hu requested review from matthewdale and prestonvasquez July 5, 2024 18:25

qingyang-hu added priority-2-medium Medium Priority PR for Review and removed priority-3-low Low Priority PR for Review labels Jul 5, 2024

qingyang-hu mentioned this pull request Jul 6, 2024

GODRIVER-2835 Change the bson.ValueReader input to an io.Reader. #1673

Merged

matthewdale requested changes Jul 16, 2024

View reviewed changes

Merge branch 'master' into godriver2976p4

97c53ce

updates

4712598

qingyang-hu requested a review from matthewdale July 16, 2024 21:59

prestonvasquez requested changes Jul 16, 2024

View reviewed changes

qingyang-hu added 2 commits July 17, 2024 11:28

update tests

8974936

fix racing

f79e67d

qingyang-hu commented Jul 17, 2024

View reviewed changes

qingyang-hu requested a review from prestonvasquez July 17, 2024 16:37

qingyang-hu added priority-1-high High Priority PR for Review and removed priority-2-medium Medium Priority PR for Review labels Jul 18, 2024

prestonvasquez approved these changes Jul 18, 2024

View reviewed changes

matthewdale approved these changes Jul 19, 2024

View reviewed changes

qingyang-hu merged commit 4d84e76 into mongodb:master Jul 19, 2024
24 of 32 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GODRIVER-2976 Remove deprecated BSON code. #1698

GODRIVER-2976 Remove deprecated BSON code. #1698

qingyang-hu commented Jul 3, 2024 •

edited

Loading

mongodb-drivers-pr-bot bot commented Jul 3, 2024 •

edited

Loading

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024 •

edited

Loading

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

qingyang-hu Jul 5, 2024

matthewdale Jul 16, 2024

qingyang-hu Jul 16, 2024

matthewdale Jul 16, 2024

prestonvasquez Jul 16, 2024

prestonvasquez Jul 16, 2024

qingyang-hu Jul 17, 2024

prestonvasquez Jul 16, 2024

qingyang-hu Jul 17, 2024

matthewdale left a comment

		if !cmp.Equal(goterr.Error(), wanterr, cmp.Comparer(assert.CompareErrors)) {
		t.Errorf("errors did not match: got %#v, want %q", goterr, wanterr)

	if !cmp.Equal(goterr.Error(), wanterr, cmp.Comparer(assert.CompareErrors)) {
	t.Errorf("errors did not match: got %#v, want %q", goterr, wanterr)
	assert.EqualError(t, goterr, wanterr, "errors did not match")

GODRIVER-2976 Remove deprecated BSON code. #1698

GODRIVER-2976 Remove deprecated BSON code. #1698

Conversation

qingyang-hu commented Jul 3, 2024 • edited Loading

Summary

Background & Motivation

mongodb-drivers-pr-bot bot commented Jul 3, 2024 • edited Loading

API Change Report

./bson

incompatible changes

Choose a reason for hiding this comment

qingyang-hu Jul 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthewdale left a comment

Choose a reason for hiding this comment

qingyang-hu commented Jul 3, 2024 •

edited

Loading

mongodb-drivers-pr-bot bot commented Jul 3, 2024 •

edited

Loading

qingyang-hu Jul 5, 2024 •

edited

Loading