Merge branch 'master' into GODRIVER-3086

Author: prestonvasquez

.evergreen/config.yml

@@ -388,6 +388,14 @@ functions:
           TASKFILE_TARGET: test-short
         args: [*task-runner, run-docker]
 
+  run-goleak-test:
+    - command: subprocess.exec
+      type: test
+      params:
+        binary: "bash"
+        include_expansions_in_env: ["MONGODB_URI"]
+        args: [*task-runner, test-goleak]
+
   run-ocsp-server:
     - command: subprocess.exec
       params:
@@ -1100,6 +1108,26 @@ tasks:
       - func: bootstrap-mongo-orchestration
       - func: run-docker-test
 
+  - name: test-goroutine-leaks-replicaset
+    tags: ["goleak"]
+    commands:
+      - func: bootstrap-mongo-orchestration
+        vars:
+          TOPOLOGY: "replica_set"
+          AUTH: "noauth"
+          SSL: "nossl"
+      - func: run-goleak-test
+
+  - name: test-goroutine-leaks-sharded
+    tags: ["goleak"]
+    commands:
+      - func: bootstrap-mongo-orchestration
+        vars:
+          TOPOLOGY: "sharded_cluster"
+          AUTH: "noauth"
+          SSL: "nossl"
+      - func: run-goleak-test
+
   - name: test-load-balancer-noauth-nossl
     tags: ["load-balancer"]
     commands:
@@ -2056,6 +2084,16 @@ buildvariants:
     tasks:
       - name: "test-docker-runner"
 
+  - name: goroutine-leaks-test
+    tags: ["pullrequest"]
+    display_name: "Goroutine Leaks Test"
+    run_on:
+      - ubuntu2204-large
+    expansions:
+      GO_DIST: "/opt/golang/go1.22"
+    tasks:
+      - name: ".goleak"
+
   - matrix_name: "tests-rhel-36-with-zlib-support"
     tags: ["pullrequest"]
     matrix_spec: { version: ["3.6"], os-ssl-32: ["rhel87-64"] }

Dockerfile

@@ -1,7 +1,7 @@
 # Dockerfile for Go Driver local development.
 
 # Build libmongocrypt in a separate build stage.
-FROM ubuntu:20.04 as libmongocrypt
+FROM artifactory.corp.mongodb.com/dockerhub/ubuntu:20.04 as libmongocrypt
 
 RUN apt-get -qq update && \
   apt-get -qqy install --no-install-recommends \
@@ -17,7 +17,7 @@ RUN cd /root && bash ./install-libmongocrypt.sh
 
 
 # Copy in the files from the libmongocrypt build stage.
-FROM ubuntu:20.04
+FROM artifactory.corp.mongodb.com/dockerhub/ubuntu:20.04
 
 # Install common deps.
 RUN export DEBIAN_FRONTEND=noninteractive && \

Taskfile.yml

@@ -105,6 +105,8 @@ tasks:
 
   test-gcpkms: bash etc/run-gcpkms-test.sh
 
+  test-goleak: bash etc/run-goleak-test.sh
+
   ### Local FaaS tasks. ###
   build-faas-awslambda:
     requires: 

bson/decoder.go

@@ -87,7 +87,7 @@ func (d *Decoder) SetRegistry(r *Registry) {
 	d.dc.Registry = r
 }
 
-// DefaultDocumentM causes the Decoder to always unmarshal documents into the primitive.M type. This
+// DefaultDocumentM causes the Decoder to always unmarshal documents into the bson.M type. This
 // behavior is restricted to data typed as "interface{}" or "map[string]interface{}".
 func (d *Decoder) DefaultDocumentM() {
 	d.dc.defaultDocumentType = reflect.TypeOf(M{})
@@ -101,7 +101,7 @@ func (d *Decoder) AllowTruncatingDoubles() {
 }
 
 // BinaryAsSlice causes the Decoder to unmarshal BSON binary field values that are the "Generic" or
-// "Old" BSON binary subtype as a Go byte slice instead of a primitive.Binary.
+// "Old" BSON binary subtype as a Go byte slice instead of a bson.Binary.
 func (d *Decoder) BinaryAsSlice() {
 	d.dc.binaryAsSlice = true
 }

bson/decoder_test.go

@@ -647,7 +647,8 @@ func TestDecoderConfiguration(t *testing.T) {
 
 		var got objectIDTest
 		err := dec.Decode(&got)
-		assert.EqualError(t, err, "error decoding key id: decoding an object ID to a non-hexadecimal string representation is not supported")
+		const want = "error decoding key id: decoding an object ID into a string is not supported by default (set Decoder.ObjectIDAsHexString to enable decoding as a hexadecimal string)"
+		assert.EqualError(t, err, want)
 	})
 	t.Run("DefaultDocumentM top-level", func(t *testing.T) {
 		t.Parallel()

bson/default_value_decoders.go

@@ -1166,6 +1166,12 @@ func valueUnmarshalerDecodeValue(_ DecodeContext, vr ValueReader, val reflect.Va
 		return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}
 	}
 
+	if vr.Type() == TypeNull {
+		val.Set(reflect.Zero(val.Type()))
+
+		return vr.ReadNull()
+	}
+
 	if val.Kind() == reflect.Ptr && val.IsNil() {
 		if !val.CanSet() {
 			return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}

bson/doc.go

@@ -47,20 +47,20 @@
 //  5. BSON boolean unmarshals to a bool.
 //  6. BSON embedded document unmarshals to the parent type (i.e. D for a D, M for an M).
 //  7. BSON array unmarshals to a bson.A.
-//  8. BSON ObjectId unmarshals to a primitive.ObjectID.
-//  9. BSON datetime unmarshals to a primitive.DateTime.
-//  10. BSON binary unmarshals to a primitive.Binary.
-//  11. BSON regular expression unmarshals to a primitive.Regex.
-//  12. BSON JavaScript unmarshals to a primitive.JavaScript.
-//  13. BSON code with scope unmarshals to a primitive.CodeWithScope.
-//  14. BSON timestamp unmarshals to an primitive.Timestamp.
-//  15. BSON 128-bit decimal unmarshals to an primitive.Decimal128.
-//  16. BSON min key unmarshals to an primitive.MinKey.
-//  17. BSON max key unmarshals to an primitive.MaxKey.
-//  18. BSON undefined unmarshals to a primitive.Undefined.
+//  8. BSON ObjectId unmarshals to a bson.ObjectID.
+//  9. BSON datetime unmarshals to a bson.DateTime.
+//  10. BSON binary unmarshals to a bson.Binary.
+//  11. BSON regular expression unmarshals to a bson.Regex.
+//  12. BSON JavaScript unmarshals to a bson.JavaScript.
+//  13. BSON code with scope unmarshals to a bson.CodeWithScope.
+//  14. BSON timestamp unmarshals to an bson.Timestamp.
+//  15. BSON 128-bit decimal unmarshals to an bson.Decimal128.
+//  16. BSON min key unmarshals to an bson.MinKey.
+//  17. BSON max key unmarshals to an bson.MaxKey.
+//  18. BSON undefined unmarshals to a bson.Undefined.
 //  19. BSON null unmarshals to nil.
-//  20. BSON DBPointer unmarshals to a primitive.DBPointer.
-//  21. BSON symbol unmarshals to a primitive.Symbol.
+//  20. BSON DBPointer unmarshals to a bson.DBPointer.
+//  21. BSON symbol unmarshals to a bson.Symbol.
 //
 // The above mappings also apply when marshaling a D or M to BSON. Some other useful marshaling mappings are:
 //

bson/marshal.go

@@ -133,7 +133,10 @@ func MarshalValue(val interface{}) (Type, []byte, error) {
 		return 0, nil, err
 	}
 	typ := sw.Next(2)
-	return Type(typ[0]), sw.Bytes(), nil
+	clone := append([]byte{}, sw.Bytes()...) // Don't hand out a shared reference to byte buffer bytes
+	// and fully copy the data. The byte buffer is (potentially) reused
+	// and handing out only a reference to the bytes may lead to race-conditions with the buffer.
+	return Type(typ[0]), clone, nil
 }
 
 // MarshalExtJSON returns the extended JSON encoding of val.

bson/marshal_value_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"go.mongodb.org/mongo-driver/v2/internal/assert"
+	"go.mongodb.org/mongo-driver/v2/internal/require"
 )
 
 func TestMarshalValue(t *testing.T) {
@@ -33,6 +34,25 @@ func TestMarshalValue(t *testing.T) {
 			})
 		}
 	})
+
+	t.Run("returns distinct address ranges", func(t *testing.T) {
+		// Call MarshalValue in a loop with the same large value (make sure to
+		// trigger the buffer pooling, which currently doesn't happen for very
+		// small values). Compare the previous and current BSON byte slices and
+		// make sure they always have distinct memory ranges.
+		//
+		// Don't run this test in parallel to maximize the chance that we get
+		// the same pooled buffer for most/all calls.
+		largeVal := strings.Repeat("1234567890", 100_000)
+		var prev []byte
+		for i := 0; i < 20; i++ {
+			_, b, err := MarshalValue(largeVal)
+			require.NoError(t, err)
+
+			assert.DifferentAddressRanges(t, b, prev)
+			prev = b
+		}
+	})
 }
 
 func compareMarshalValueResults(t *testing.T, tc marshalValueTestCase, gotType Type, gotBytes []byte) {

bson/primitive.go

@@ -60,7 +60,7 @@ func (d DateTime) MarshalJSON() ([]byte, error) {
 	return d.Time().UTC().MarshalJSON()
 }
 
-// UnmarshalJSON creates a primitive.DateTime from a JSON string.
+// UnmarshalJSON creates a bson.DateTime from a JSON string.
 func (d *DateTime) UnmarshalJSON(data []byte) error {
 	// Ignore "null" so that we can distinguish between a "null" value and
 	// valid value that is the zero time (as reported by time.Time.IsZero).