Merge branch 'master' into godriver3291

.golangci.yml

@@ -1,12 +1,5 @@
 run:
   timeout: 5m
-  skip-dirs-use-default: false
-  skip-dirs:
-    - (^|/)vendor($|/)
-    - (^|/)testdata($|/)
-    - (^|/)etc($|/)
-    # Disable all linters for "golang.org/x/exp/rand" package in internal/rand.
-    - internal/rand
 
 linters:
   disable-all: true
@@ -35,11 +28,7 @@ linters:
 
 linters-settings:
   errcheck:
-    exclude: .errcheck-excludes
-  gocritic:
-    enabled-checks:
-      # Detects suspicious append result assignments. E.g. "b := append(a, 1, 2, 3)"
-      - appendAssign
+    exclude-functions: .errcheck-excludes
   govet:
     disable:
       - cgocall
@@ -55,6 +44,14 @@ linters-settings:
     ]
 
 issues:
+  exclude-dirs-use-default: false
+  exclude-dirs:
+    - (^|/)testdata($|/)
+    - (^|/)etc($|/)
+    # Disable all linters for copied third-party code.
+    - internal/rand
+    - internal/aws
+    - internal/assert
   exclude-use-default: false
   exclude:
     # Add all default excluded issues except issues related to exported types/functions not having

.pre-commit-config.yaml

@@ -40,8 +40,8 @@ repos:
   rev: "v2.2.6"
   hooks:
   - id: codespell
-    args: ["-L", "te,fo,fle,alo,nin,compres,wil,collone,asess,sav,ot,wll,dne,nulll,hellow"]
-    exclude: ^(vendor/|internal/cmd/benchmark/operation_test.go|bson/testdata/lorem.txt)
+    args: ["-L", "te,fo,fle,alo,nin,compres,wil,collone,asess,sav,ot,wll,dne,nulll,hellow,aks"]
+    exclude: ^(vendor/|internal/cmd/benchmark/operation_test.go|bson/testdata/)
     exclude_types: [json,yaml,pem]
 
 - repo: https://github.com/tcort/markdown-link-check
@@ -51,6 +51,14 @@ repos:
       exclude: ^(vendor)
 
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.55.1
+  rev: v1.59.1
   hooks:
   - id: golangci-lint
+
+- repo: local
+  hooks:
+  - id: executable-shell
+    name: executable-shell
+    entry: chmod +x
+    language: system
+    types: [shell]

Makefile

@@ -48,14 +48,9 @@ install-lll:
 check-fmt: install-lll
 	etc/check_fmt.sh
 
-# check-modules runs "go mod tidy"  and exits with a non-zero exit code if there
-# are any module changes. The intent is to confirm that exactly the required
-# modules are declared as dependencies. We should always be able to run "go mod
-# tidy" and expect that no unrelated changes are made to the "go.mod" file.
 .PHONY: check-modules
 check-modules:
-	go mod tidy -v
-	git diff --exit-code go.mod go.sum
+	etc/check_modules.sh
 
 .PHONY: doc
 doc:
@@ -65,9 +60,11 @@ doc:
 fmt:
 	go fmt ./...
 
+# NOTE: A golangci-lint version is also pinned in .pre-commit-config.yaml. Make
+# sure to change it there to keep it in-sync with what's used here!
 .PHONY: install-golangci-lint
 install-golangci-lint:
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.59.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

README.md

@@ -1,43 +1,42 @@
 <p align="center"><img src="etc/assets/mongo-gopher.png" width="250"></p>
 <p align="center">
-  <a href="https://goreportcard.com/report/go.mongodb.org/mongo-driver"><img src="https://goreportcard.com/badge/go.mongodb.org/mongo-driver"></a>
-  <a href="https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo"><img src="etc/assets/godev-mongo-blue.svg" alt="docs"></a>
-  <a href="https://pkg.go.dev/go.mongodb.org/mongo-driver/bson"><img src="etc/assets/godev-bson-blue.svg" alt="docs"></a>
+  <a href="https://goreportcard.com/report/go.mongodb.org/mongo-driver/v2"><img src="https://goreportcard.com/badge/go.mongodb.org/mongo-driver/v2"></a>
+  <a href="https://pkg.go.dev/go.mongodb.org/mongo-driver/v2/mongo"><img src="etc/assets/godev-mongo-blue.svg" alt="docs"></a>
+  <a href="https://pkg.go.dev/go.mongodb.org/mongo-driver/v2/bson"><img src="etc/assets/godev-bson-blue.svg" alt="docs"></a>
   <a href="https://www.mongodb.com/docs/drivers/go/current/"><img src="etc/assets/docs-mongodb-green.svg"></a>
 </p>
 
 # MongoDB Go Driver
 
 The MongoDB supported driver for Go.
 
-______________________________________________________________________
+See the following resources to learn more about upgrading from version 1.x to 2.0.:
+
+- [v2.0 Migration Guide](docs/migration-2.0.md)
+- [v2.0 What's New](https://www.mongodb.com/docs/drivers/go/upcoming/whats-new/#what-s-new-in-2.0)
 
 ## Requirements
 
 - Go 1.18 or higher. We aim to support the latest versions of Go.
-- Go 1.20 or higher is required to run the driver test suite.
+- Go 1.22 or higher is required to run the driver test suite.
 - MongoDB 3.6 and higher.
 
-______________________________________________________________________
-
 ## Installation
 
 The recommended way to get started using the MongoDB Go driver is by using Go modules to install the dependency in
 your project. This can be done either by importing packages from `go.mongodb.org/mongo-driver` and having the build
 step install the dependency or by explicitly running
 
 ```bash
-go get go.mongodb.org/mongo-driver/mongo
+go get go.mongodb.org/mongo-driver/v2/mongo
 ```
 
 When using a version of Go that does not support modules, the driver can be installed using `dep` by running
 
 ```bash
-dep ensure -add "go.mongodb.org/mongo-driver/mongo"
+dep ensure -add "go.mongodb.org/mongo-driver/v2/mongo"
 ```
 
-______________________________________________________________________
-
 ## Usage
 
 To get started with the driver, import the `mongo` package and create a `mongo.Client` with the `Connect` function:
@@ -47,14 +46,12 @@ import (
     "context"
     "time"
 
-    "go.mongodb.org/mongo-driver/mongo"
-    "go.mongodb.org/mongo-driver/mongo/options"
-    "go.mongodb.org/mongo-driver/mongo/readpref"
+    "go.mongodb.org/mongo-driver/v2/mongo"
+    "go.mongodb.org/mongo-driver/v2/mongo/options"
+    "go.mongodb.org/mongo-driver/v2/mongo/readpref"
 )
 
-ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-defer cancel()
-client, err := mongo.Connect(options.Client().ApplyURI("mongodb://localhost:27017"))
+client, _ := mongo.Connect(options.Client().ApplyURI("mongodb://localhost:27017"))
 ```
 
 Make sure to defer a call to `Disconnect` after instantiating your client:
@@ -67,15 +64,16 @@ defer func() {
 }()
 ```
 
-For more advanced configuration and authentication, see the [documentation for mongo.Connect](https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo#Connect).
+For more advanced configuration and authentication, see the [documentation for mongo.Connect](https://pkg.go.dev/go.mongodb.org/mongo-driver/v2/mongo#Connect).
 
 Calling `Connect` does not block for server discovery. If you wish to know if a MongoDB server has been found and connected to,
 use the `Ping` method:
 
 ```go
 ctx, cancel = context.WithTimeout(context.Background(), 2*time.Second)
 defer cancel()
-err = client.Ping(ctx, readpref.Primary())
+
+_ = client.Ping(ctx, readpref.Primary())
 ```
 
 To insert a document into a collection, first retrieve a `Database` and then `Collection` instance from the `Client`:
@@ -89,11 +87,12 @@ The `Collection` instance can then be used to insert documents:
 ```go
 ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
 defer cancel()
-res, err := collection.InsertOne(ctx, bson.D{{"name", "pi"}, {"value", 3.14159}})
+
+res, _ := collection.InsertOne(ctx, bson.D{{"name", "pi"}, {"value", 3.14159}})
 id := res.InsertedID
 ```
 
-To use `bson.D`, you will need to add `"go.mongodb.org/mongo-driver/bson"` to your imports.
+To use `bson.D`, you will need to add `"go.mongodb.org/mongo-driver/v2/bson"` to your imports.
 
 Your import statement should now look like this:
 
@@ -103,10 +102,10 @@ import (
     "log"
     "time"
 
-    "go.mongodb.org/mongo-driver/bson"
-    "go.mongodb.org/mongo-driver/mongo"
-    "go.mongodb.org/mongo-driver/mongo/options"
-    "go.mongodb.org/mongo-driver/mongo/readpref"
+    "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/readpref"
 )
 ```
 
@@ -115,15 +114,22 @@ Several query methods return a cursor, which can be used like this:
 ```go
 ctx, cancel = context.WithTimeout(context.Background(), 30*time.Second)
 defer cancel()
+
 cur, err := collection.Find(ctx, bson.D{})
-if err != nil { log.Fatal(err) }
+if err != nil {
+  log.Fatal(err)
+}
+
 defer cur.Close(ctx)
 for cur.Next(ctx) {
     var result bson.D
-    err := cur.Decode(&result)
-    if err != nil { log.Fatal(err) }
+    if err := cur.Decode(&result); err != nil {
+      log.Fatal(err)
+    }
+
     // do something with result....
 }
+
 if err := cur.Err(); err != nil {
     log.Fatal(err)
 }
@@ -135,16 +141,18 @@ For methods that return a single item, a `SingleResult` instance is returned:
 var result struct {
     Value float64
 }
+
 filter := bson.D{{"name", "pi"}}
 ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
 defer cancel()
+
 err = collection.FindOne(ctx, filter).Decode(&result)
-if err == mongo.ErrNoDocuments {
+if errors.Is(err, mongo.ErrNoDocuments) {
     // Do something when no record was found
-    fmt.Println("record does not exist")
 } else if err != nil {
     log.Fatal(err)
 }
+
 // Do something with result...
 ```
 
@@ -178,41 +186,29 @@ If compressors are set, the Go Driver negotiates with the server to select the f
 
 Messages compress when both parties enable network compression; otherwise, messages remain uncompressed
 
-______________________________________________________________________
-
 ## Feedback
 
 For help with the driver, please post in the [MongoDB Community Forums](https://developer.mongodb.com/community/forums/tag/golang/).
 
 New features and bugs can be reported on jira: https://jira.mongodb.org/browse/GODRIVER
 
-______________________________________________________________________
-
 ## Contribution
 
 Check out the [project page](https://jira.mongodb.org/browse/GODRIVER) for tickets that need completing. See our [contribution guidelines](docs/CONTRIBUTING.md) for details.
 
-______________________________________________________________________
-
 ## Continuous Integration
 
 Commits to master are run automatically on [evergreen](https://evergreen.mongodb.com/waterfall/mongo-go-driver).
 
-______________________________________________________________________
-
 ## Frequently Encountered Issues
 
 See our [common issues](docs/common-issues.md) documentation for troubleshooting frequently encountered issues.
 
-______________________________________________________________________
-
 ## Thanks and Acknowledgement
 
 - The Go Gopher artwork by [@ashleymcnamara](https://github.com/ashleymcnamara)
 - The original Go Gopher was designed by [Renee French](http://reneefrench.blogspot.com/)
 
-______________________________________________________________________
-
 ## License
 
 The MongoDB Go Driver is licensed under the [Apache License](LICENSE).

bson/bsoncodec_test.go

@@ -23,7 +23,7 @@ func ExampleValueEncoder() {
 }
 
 func ExampleValueDecoder() {
-	var _ ValueDecoderFunc = func(dc DecodeContext, vr ValueReader, val reflect.Value) error {
+	var _ ValueDecoderFunc = func(_ DecodeContext, vr ValueReader, val reflect.Value) error {
 		if !val.CanSet() || val.Kind() != reflect.String {
 			return ValueDecoderError{Name: "StringDecodeValue", Kinds: []reflect.Kind{reflect.String}, Received: val}
 		}

bson/decimal.go

@@ -75,13 +75,12 @@ func (d Decimal128) BigInt() (*big.Int, int, error) {
 		// Bits: 1*sign 2*ignored 14*exponent 111*significand.
 		// Implicit 0b100 prefix in significand.
 		exp = int(high >> 47 & (1<<14 - 1))
-		//high = 4<<47 | d.h&(1<<47-1)
 		// Spec says all of these values are out of range.
 		high, low = 0, 0
 	} else {
 		// Bits: 1*sign 14*exponent 113*significand
 		exp = int(high >> 49 & (1<<14 - 1))
-		high = high & (1<<49 - 1)
+		high &= (1<<49 - 1)
 	}
 	exp += MinDecimal128Exp
 
@@ -258,7 +257,7 @@ var (
 
 // ParseDecimal128FromBigInt attempts to parse the given significand and exponent into a valid Decimal128 value.
 func ParseDecimal128FromBigInt(bi *big.Int, exp int) (Decimal128, bool) {
-	//copy
+	// copy
 	bi = new(big.Int).Set(bi)
 
 	q := new(big.Int)

bson/decoder_test.go

@@ -508,7 +508,7 @@ func TestDecoderConfiguration(t *testing.T) {
 		// independent of the top-level Go value type.
 		{
 			description: "DocumentD nested by default",
-			configure:   func(dec *Decoder) {},
+			configure:   func(_ *Decoder) {},
 			input: bsoncore.NewDocumentBuilder().
 				AppendDocument("myDocument", bsoncore.NewDocumentBuilder().
 					AppendString("myString", "test value").

bson/default_value_decoders.go

@@ -1286,7 +1286,8 @@ func decodeDefault(dc DecodeContext, vr ValueReader, val reflect.Value) ([]refle
 		var elem reflect.Value
 		if vDecoder == nil {
 			elem = val.Index(idx).Elem()
-			if elem.Kind() != reflect.Ptr || elem.IsNil() {
+			switch {
+			case elem.Kind() != reflect.Ptr || elem.IsNil():
 				valueDecoder, err := dc.LookupDecoder(elem.Type())
 				if err != nil {
 					return nil, err
@@ -1295,12 +1296,12 @@ func decodeDefault(dc DecodeContext, vr ValueReader, val reflect.Value) ([]refle
 				if err != nil {
 					return nil, newDecodeError(strconv.Itoa(idx), err)
 				}
-			} else if vr.Type() == TypeNull {
+			case vr.Type() == TypeNull:
 				if err = vr.ReadNull(); err != nil {
 					return nil, err
 				}
 				elem = reflect.Zero(val.Index(idx).Type())
-			} else {
+			default:
 				e := elem.Elem()
 				valueDecoder, err := dc.LookupDecoder(e.Type())
 				if err != nil {

bson/default_value_encoders_test.go

@@ -1075,7 +1075,7 @@ func TestDefaultValueEncoders(t *testing.T) {
 				},
 				{
 					"WriteArrayElement Error",
-					bsoncore.Array(buildDocumentArray(func(doc []byte) []byte {
+					bsoncore.Array(buildDocumentArray(func([]byte) []byte {
 						return bsoncore.AppendNullElement(nil, "foo")
 					})),
 					nil,
@@ -1085,7 +1085,7 @@ func TestDefaultValueEncoders(t *testing.T) {
 				},
 				{
 					"encodeValue error",
-					bsoncore.Array(buildDocumentArray(func(doc []byte) []byte {
+					bsoncore.Array(buildDocumentArray(func([]byte) []byte {
 						return bsoncore.AppendNullElement(nil, "foo")
 					})),
 					nil,