Merge branch 'master' into godriver3175-oidc-k8s

Author: matthewdale

.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

bson/bsoncodec.go

@@ -88,6 +88,7 @@ type EncodeContext struct {
 	nilSliceAsEmpty         bool
 	nilByteSliceAsEmpty     bool
 	omitZeroStruct          bool
+	omitEmpty               bool
 	useJSONStructTags       bool
 }
 

bson/encoder.go

@@ -108,14 +108,21 @@ func (e *Encoder) NilByteSliceAsEmpty() {
 // TODO struct fields once the logic is updated to also inspect private struct fields.
 
 // OmitZeroStruct causes the Encoder to consider the zero value for a struct (e.g. MyStruct{})
-// as empty and omit it from the marshaled BSON when the "omitempty" struct tag option is set.
+// as empty and omit it from the marshaled BSON when the "omitempty" struct tag option is set
+// or the OmitEmpty() method is called.
 //
 // Note that the Encoder only examines exported struct fields when determining if a struct is the
 // zero value. It considers pointers to a zero struct value (e.g. &MyStruct{}) not empty.
 func (e *Encoder) OmitZeroStruct() {
 	e.ec.omitZeroStruct = true
 }
 
+// OmitEmpty causes the Encoder to omit empty values from the marshaled BSON as the "omitempty"
+// struct tag option is set.
+func (e *Encoder) OmitEmpty() {
+	e.ec.omitEmpty = true
+}
+
 // UseJSONStructTags causes the Encoder to fall back to using the "json" struct tag if a "bson"
 // struct tag is not specified.
 func (e *Encoder) UseJSONStructTags() {

bson/encoder_test.go

@@ -11,6 +11,7 @@ import (
 	"errors"
 	"reflect"
 	"testing"
+	"time"
 
 	"go.mongodb.org/mongo-driver/v2/internal/assert"
 	"go.mongodb.org/mongo-driver/v2/internal/require"
@@ -248,6 +249,42 @@ func TestEncoderConfiguration(t *testing.T) {
 			}{},
 			want: bsoncore.NewDocumentBuilder().Build(),
 		},
+		// Test that OmitZeroStruct omits empty structs from the marshaled document if
+		// OmitEmpty is also set.
+		{
+			description: "OmitEmpty with non-zeroer struct",
+			configure: func(enc *Encoder) {
+				enc.OmitZeroStruct()
+				enc.OmitEmpty()
+			},
+			input: struct {
+				Zero zeroStruct
+			}{},
+			want: bsoncore.NewDocumentBuilder().Build(),
+		},
+		// Test that OmitEmpty omits empty values from the marshaled document.
+		{
+			description: "OmitEmpty",
+			configure: func(enc *Encoder) {
+				enc.OmitEmpty()
+			},
+			input: struct {
+				Zero    zeroTest
+				I64     int64
+				F64     float64
+				String  string
+				Boolean bool
+				Slice   []int
+				Array   [0]int
+				Map     map[string]int
+				Bytes   []byte
+				Time    time.Time
+				Pointer *int
+			}{
+				Zero: zeroTest{true},
+			},
+			want: bsoncore.NewDocumentBuilder().Build(),
+		},
 		// Test that UseJSONStructTags causes the Encoder to fall back to "json" struct tags if
 		// "bson" struct tags are not available.
 		{

bson/primitive_codecs_test.go

@@ -1094,6 +1094,8 @@ type zeroTest struct {
 
 func (z zeroTest) IsZero() bool { return z.reportZero }
 
+var _ Zeroer = zeroTest{}
+
 func compareZeroTest(_, _ zeroTest) bool { return true }
 
 func compareDecimal128(d1, d2 Decimal128) bool {

bson/struct_codec.go

@@ -118,6 +118,10 @@ func (sc *structCodec) EncodeValue(ec EncodeContext, vw ValueWriter, val reflect
 			}
 		}
 
+		if ec.omitEmpty {
+			desc.omitEmpty = true
+		}
+
 		desc.encoder, rv, err = lookupElementEncoder(ec, desc.encoder, rv)
 
 		if err != nil && !errors.Is(err, errInvalidValue) {

bson/struct_codec_test.go

@@ -14,16 +14,6 @@ import (
 	"go.mongodb.org/mongo-driver/v2/internal/assert"
 )
 
-var _ Zeroer = testZeroer{}
-
-type testZeroer struct {
-	val int
-}
-
-func (z testZeroer) IsZero() bool {
-	return z.val != 0
-}
-
 func TestIsZero(t *testing.T) {
 	t.Parallel()
 	testCases := []struct {
@@ -84,22 +74,22 @@ func TestIsZero(t *testing.T) {
 		},
 		{
 			description: "zero struct that implements Zeroer",
-			value:       testZeroer{},
+			value:       zeroTest{},
 			want:        false,
 		},
 		{
 			description: "non-zero struct that implements Zeroer",
-			value:       &testZeroer{val: 1},
+			value:       zeroTest{reportZero: true},
 			want:        true,
 		},
 		{
 			description: "pointer to zero struct that implements Zeroer",
-			value:       &testZeroer{},
+			value:       &zeroTest{},
 			want:        false,
 		},
 		{
 			description: "pointer to non-zero struct that implements Zeroer",
-			value:       testZeroer{val: 1},
+			value:       &zeroTest{reportZero: true},
 			want:        true,
 		},
 		{

internal/integration/client_test.go

@@ -956,6 +956,19 @@ func TestClient_BSONOptions(t *testing.T) {
 			want:       &bson.D{},
 			wantRaw:    bson.Raw(bsoncore.NewDocumentBuilder().Build()),
 		},
+		{
+			name: "OmitEmpty with non-zeroer struct",
+			bsonOpts: &options.BSONOptions{
+				OmitZeroStruct: true,
+				OmitEmpty:      true,
+			},
+			doc: struct {
+				X jsonTagsTest `bson:"x"`
+			}{},
+			decodeInto: func() interface{} { return &bson.D{} },
+			want:       &bson.D{},
+			wantRaw:    bson.Raw(bsoncore.NewDocumentBuilder().Build()),
+		},
 		{
 			name: "StringifyMapKeysWithFmt",
 			bsonOpts: &options.BSONOptions{

mongo/mongo.go

@@ -83,6 +83,9 @@ func getEncoder(
 		if opts.OmitZeroStruct {
 			enc.OmitZeroStruct()
 		}
+		if opts.OmitEmpty {
+			enc.OmitEmpty()
+		}
 		if opts.StringifyMapKeysWithFmt {
 			enc.StringifyMapKeysWithFmt()
 		}

mongo/options/clientoptions.go

@@ -182,9 +182,12 @@ type BSONOptions struct {
 
 	// OmitZeroStruct causes the driver to consider the zero value for a struct
 	// (e.g. MyStruct{}) as empty and omit it from the marshaled BSON when the
-	// "omitempty" struct tag option is set.
+	// "omitempty" struct tag option or the "OmitEmpty" field is set.
 	OmitZeroStruct bool
 
+	// OmitEmpty causes the driver to omit empty values from the marshaled BSON.
+	OmitEmpty bool
+
 	// StringifyMapKeysWithFmt causes the driver to convert Go map keys to BSON
 	// document field name strings using fmt.Sprint instead of the default
 	// string conversion logic.