Merge pull request #2 from mongodb/release/1.17

Release/1.17

Author: adhocore

.evergreen/config.yml

@@ -615,6 +615,17 @@ functions:
           bash etc/run_docker.sh
           TOPOLOGY=sharded_cluster bash etc/run_docker.sh test-short
 
+  run-goleak-test:
+    - command: shell.exec
+      type: test
+      params:
+        shell: "bash"
+        working_dir: src/go.mongodb.org/mongo-driver
+        include_expansions_in_env: ["MONGODB_URI"]
+        script: |
+          ${PREPARE_SHELL}
+          bash etc/run-goleak-test.sh
+
   run-valid-ocsp-server:
     - command: shell.exec
       params:
@@ -1420,6 +1431,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:
@@ -2539,6 +2570,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"] }

.evergreen/run-fuzz.sh

@@ -35,7 +35,7 @@ do
 			done
 		fi
 
-		go test ${PARENTDIR} -run=${FUNC} -fuzz=${FUNC} -fuzztime=${FUZZTIME} || true
+		GOMAXPROCS=2 go test ${PARENTDIR} -run=${FUNC} -fuzz=${FUNC} -fuzztime=${FUZZTIME} || true
 
 		# Check if any new corpus files were generated for the fuzzer. If there are new corpus files, move them
 		# to $PROJECT_DIRECTORY/fuzz/$FUNC/* so they can be tarred up and uploaded to S3.

.github/reviewers.txt

@@ -1,4 +1,3 @@
 qingyang-hu
 matthewdale
 prestonvasquez
-blink1073

.github/workflows/merge-up.yml

@@ -0,0 +1,36 @@
+name: Merge up
+
+on:
+  push:
+    branches:
+      - release/*.*
+      - v*
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  merge-up:
+    name: Create merge up pull request
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
+        with:
+          app_id: ${{ vars.PR_APP_ID }}
+          private_key: ${{ secrets.PR_APP_PRIVATE_KEY }}
+          # Make sure to include fetch-depth 0 so all branches are fetched, not
+          # just the current one
+          fetch-depth: 0
+
+      - name: Create pull request
+        id: create-pull-request
+        uses: alcaeus/automatic-merge-up-action@main
+        with:
+          ref: ${{ github.ref_name }}
+          branchNamePattern: 'release/<major>.<minor>'
+          devBranchNamePattern: 'v<major>'
+          fallbackBranch: 'master'
+          enableAutoMerge: true

.pre-commit-config.yaml

@@ -51,6 +51,6 @@ repos:
       exclude: ^(vendor)
 
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.59.1
+  rev: v1.60.1
   hooks:
   - id: golangci-lint

Makefile

@@ -72,7 +72,7 @@ fmt:
 
 .PHONY: install-golangci-lint
 install-golangci-lint:
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.59.1
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.60.1
 
 # Lint with various GOOS and GOARCH targets to catch static analysis failures that may only affect
 # specific operating systems or architectures. For example, staticcheck will only check for 64-bit
@@ -106,7 +106,7 @@ test-race:
 
 .PHONY: test-short
 test-short:
-	go test $(BUILD_TAGS) -timeout 60s -short ./...
+	go test $(BUILD_TAGS) -timeout 60s -short -race ./...
 
 ### Local FaaS targets. ###
 .PHONY: build-faas-awslambda

bson/bson_test.go

@@ -19,6 +19,7 @@ import (
 	"go.mongodb.org/mongo-driver/bson/bsoncodec"
 	"go.mongodb.org/mongo-driver/bson/bsonoptions"
 	"go.mongodb.org/mongo-driver/bson/bsontype"
+	"go.mongodb.org/mongo-driver/bson/primitive"
 	"go.mongodb.org/mongo-driver/internal/assert"
 	"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
 )
@@ -226,11 +227,20 @@ func TestMapCodec(t *testing.T) {
 }
 
 func TestExtJSONEscapeKey(t *testing.T) {
-	doc := D{{Key: "\\usb#", Value: int32(1)}}
+	doc := D{
+		{
+			Key:   "\\usb#",
+			Value: int32(1),
+		},
+		{
+			Key:   "regex",
+			Value: primitive.Regex{Pattern: "ab\\\\\\\"ab", Options: "\""},
+		},
+	}
 	b, err := MarshalExtJSON(&doc, false, false)
 	noerr(t, err)
 
-	want := "{\"\\\\usb#\":1}"
+	want := `{"\\usb#":1,"regex":{"$regularExpression":{"pattern":"ab\\\\\\\"ab","options":"\""}}}`
 	if diff := cmp.Diff(want, string(b)); diff != "" {
 		t.Errorf("Marshaled documents do not match. got %v, want %v", string(b), want)
 	}

bson/bsoncodec/default_value_decoders.go

@@ -1521,6 +1521,18 @@ func (dvd DefaultValueDecoders) ValueUnmarshalerDecodeValue(_ DecodeContext, vr
 		return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}
 	}
 
+	// If BSON value is null and the go value is a pointer, then don't call
+	// UnmarshalBSONValue. Even if the Go pointer is already initialized (i.e.,
+	// non-nil), encountering null in BSON will result in the pointer being
+	// directly set to nil here. Since the pointer is being replaced with nil,
+	// there is no opportunity (or reason) for the custom UnmarshalBSONValue logic
+	// to be called.
+	if vr.Type() == bsontype.Null && val.Kind() == reflect.Ptr {
+		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/bsonrw/extjson_writer.go

@@ -468,12 +468,13 @@ func (ejvw *extJSONValueWriter) WriteRegex(pattern string, options string) error
 		return err
 	}
 
+	options = sortStringAlphebeticAscending(options)
 	var buf bytes.Buffer
 	buf.WriteString(`{"$regularExpression":{"pattern":`)
 	writeStringWithEscapes(pattern, &buf, ejvw.escapeHTML)
-	buf.WriteString(`,"options":"`)
-	buf.WriteString(sortStringAlphebeticAscending(options))
-	buf.WriteString(`"}},`)
+	buf.WriteString(`,"options":`)
+	writeStringWithEscapes(options, &buf, ejvw.escapeHTML)
+	buf.WriteString(`}},`)
 
 	ejvw.buf = append(ejvw.buf, buf.Bytes()...)
 

bson/unmarshal.go

@@ -41,6 +41,9 @@ type ValueUnmarshaler interface {
 // Unmarshal parses the BSON-encoded data and stores the result in the value
 // pointed to by val. If val is nil or not a pointer, Unmarshal returns
 // InvalidUnmarshalError.
+//
+// When unmarshaling BSON, if the BSON value is null and the Go value is a
+// pointer, the pointer is set to nil without calling UnmarshalBSONValue.
 func Unmarshal(data []byte, val interface{}) error {
 	return UnmarshalWithRegistry(DefaultRegistry, data, val)
 }

bson/unmarshal_value_test.go

@@ -14,6 +14,7 @@ import (
 	"go.mongodb.org/mongo-driver/bson/bsoncodec"
 	"go.mongodb.org/mongo-driver/bson/bsontype"
 	"go.mongodb.org/mongo-driver/internal/assert"
+	"go.mongodb.org/mongo-driver/internal/require"
 	"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
 )
 
@@ -93,6 +94,29 @@ func TestUnmarshalValue(t *testing.T) {
 	})
 }
 
+func TestInitializedPointerDataWithBSONNull(t *testing.T) {
+	// Set up the test case with initialized pointers.
+	tc := unmarshalBehaviorTestCase{
+		BSONValuePtrTracker: &unmarshalBSONValueCallTracker{},
+		BSONPtrTracker:      &unmarshalBSONCallTracker{},
+	}
+
+	// Create BSON data where the '*_ptr_tracker' fields are explicitly set to
+	// null.
+	bytes := docToBytes(D{
+		{Key: "bv_ptr_tracker", Value: nil},
+		{Key: "b_ptr_tracker", Value: nil},
+	})
+
+	// Unmarshal the BSON data into the test case struct. This should set the
+	// pointer fields to nil due to the BSON null value.
+	err := Unmarshal(bytes, &tc)
+	require.NoError(t, err)
+
+	assert.Nil(t, tc.BSONValuePtrTracker)
+	assert.Nil(t, tc.BSONPtrTracker)
+}
+
 // tests covering GODRIVER-2779
 func BenchmarkSliceCodecUnmarshal(b *testing.B) {
 	benchmarks := []struct {