GODRIVER-3370 Add bypassEmptyTsReplacement option. #1927

New issue

Jump to bottom

Merged

qingyang-hu merged 4 commits into mongodb:v1 from qingyang-hu:godriver3370

Feb 7, 2025

+461 −0

Collaborator

qingyang-hu commented Jan 31, 2025

Summary

Add bypassEmptyTsReplacement option to:

insertOne
insertMany
updateOne
updateMany
replaceOne
findOneAndUpdate
findOneAndReplace
collection.bulkWrite

Background & Motivation

Correlated server ticket: SERVER-88750

qingyang-hu force-pushed the godriver3370 branch from c20f657 to d676317 Compare

January 31, 2025 20:20

mongodb-drivers-pr-bot bot added the priority-3-low label

Contributor

mongodb-drivers-pr-bot bot commented Jan 31, 2025 •

edited

Loading

API Change Report

./mongo/options

compatible changes

BulkWriteOptions.BypassEmptyTsReplacement: added
FindOneAndReplaceOptions.BypassEmptyTsReplacement: added
FindOneAndUpdateOptions.BypassEmptyTsReplacement: added
InsertManyOptions.BypassEmptyTsReplacement: added
InsertOneOptions.BypassEmptyTsReplacement: added
ReplaceOptions.BypassEmptyTsReplacement: added
UpdateOptions.BypassEmptyTsReplacement: added

./x/mongo/driver/operation

compatible changes

(*FindAndModify).BypassEmptyTsReplacement: added
(*Insert).BypassEmptyTsReplacement: added
(*Update).BypassEmptyTsReplacement: added


          GODRIVER-3370 Add bypassEmptyTsReplacement option.

27f8fbe

qingyang-hu force-pushed the godriver3370 branch from d676317 to 27f8fbe Compare

January 31, 2025 20:33


          update min server version

1324c47

qingyang-hu marked this pull request as ready for review

February 3, 2025 16:26

qingyang-hu added priority-2-medium and removed priority-3-low labels

qingyang-hu requested review from matthewdale and prestonvasquez

February 3, 2025 16:26

matthewdale reviewed

View reviewed changes

mongo/options/findoptions.go Outdated

               	return f
               }
+              // SetBypassEmptyTsReplacement sets the value for the BypassEmptyTsReplacement field.
+              func (f *FindOneAndReplaceOptions) SetBypassEmptyTsReplacement(b bool) *FindOneAndReplaceOptions {

Collaborator

matthewdale Feb 3, 2025

This should be marked as deprecated with the same deprecation note as the corresponding field.

mongo/options/bulkwriteoptions.go Outdated

               	return b
               }
+              // SetBypassEmptyTsReplacement sets the value for the BypassEmptyTsReplacement field.
+              func (b *BulkWriteOptions) SetBypassEmptyTsReplacement(bypassEmptyTsReplacement bool) *BulkWriteOptions {

Collaborator

matthewdale Feb 3, 2025

All of the public setters should be marked as deprecated with the same deprecation note as the corresponding field.

Also applies to SetBypassEmptyTsReplacement on:

FindOneAndReplaceOptions
InsertOneOptions
ReplaceOptions
UpdateOptions

Collaborator Author

qingyang-hu Feb 5, 2025

After re-reading the existing code, I noticed the Go driver doesn't provide setters for internal options. Going to remove these methods.


          remove options setters

5b10515

qingyang-hu requested a review from matthewdale

February 5, 2025 21:24

prestonvasquez added priority-1-high and removed priority-2-medium labels

matthewdale previously approved these changes

View reviewed changes

Collaborator

matthewdale left a comment

Looks good! 👍

prestonvasquez previously approved these changes

View reviewed changes

Member

prestonvasquez left a comment

LGTM with some minor test updates

mongo/integration/collection_test.go Outdated

+              		t.Helper()
+              		valType, data, err := bson.MarshalValue(val)
+              		assert.Nil(t, err, "MarshalValue error: %v", err)

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            		assert.Nil(t, err, "MarshalValue error: %v", err)
          
            		require.NoError(t, err, "MarshalValue error: %v", err)

Suggest stopping test execution when we get an unexpected error.

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "InsertOne error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Suggest not stoping the test if we get an unexpected result we are testing for.

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "InsertMany error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Suggest not stoping the test if we get an unexpected result we are testing for.

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "UpdateOne error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Suggest not stoping the test if we get an unexpected result we are testing for.

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "UpdateMany error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Suggest not stoping the test if we get an unexpected result we are testing for.

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "ReplaceOne error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "FindOneAndUpdate error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

mongo/integration/collection_test.go Outdated

+              				require.NoError(mt, err, "FindOneAndReplace error: %v", err)
+              				evt := mt.GetStartedEvent()
+              				val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            				require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            				assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

mongo/integration/collection_test.go Outdated

+              					require.NoError(mt, err, "BulkWrite error: %v", err)
+              					evt := mt.GetStartedEvent()
+              					val := evt.Command.Lookup("bypassEmptyTsReplacement")
+              					require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())

Member

prestonvasquez Feb 6, 2025

Suggested change

      
            					require.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())
          
            					assert.Equal(mt, tc.expected, val, "expected bypassEmptyTsReplacement to be %s", tc.expected.String())


          update tests

86b4f5a

qingyang-hu dismissed stale reviews from prestonvasquez and matthewdale via

86b4f5a

February 7, 2025 15:50

qingyang-hu requested a review from prestonvasquez

February 7, 2025 16:04

matthewdale approved these changes

View reviewed changes

qingyang-hu merged commit e796c82 into mongodb:v1

30 of 34 checks passed

Collaborator

matthewdale commented Feb 20, 2025

drivers-pr-bot please backport to release/1.17

mongodb-drivers-pr-bot bot pushed a commit that referenced this pull request


          GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927)

b75dbff

(cherry picked from commit e796c82)

matthewdale pushed a commit that referenced this pull request


          GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927) [release/1…

4aeff60

….17] (#1954)

Co-authored-by: Qingyang Hu <103950869+qingyang-hu@users.noreply.github.com>

mongodb-drivers-pr-bot bot mentioned this pull request

Merge release/1.17 into v1 #1970

Merged

alcaeus added a commit that referenced this pull request


          Mark release/1.17 as fully merged into v1

2fbd242

* release/1.17:
  Use different credentials for merge-up PRs (#1968)
  Add GitHub Actions workflow for merge ups (#1962)
  BUMP v1.17.3
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943) [release/1.17] (#1957)
  Update reviewers.txt (#1855) [v1] (#1883) [release/1.17] (#1958)
  Cherry pick 1.17.2 work to release/1.17 (#1956)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924) (#1955)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927) [release/1.17] (#1954)
  GODRIVER-3340 Bump github.com/klauspost/compress from 1.13.6 to 1.16.7 [release/1.17] (#1880)
  GODRIVER-3374 Add ReadCompressedCompressedMessage back to wiremessage API (#1870)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  Bump golangci-lint for 1.23 compatibility [v1] (#1875)
  BUMP v1.17.1
  GODRIVER-3156 Detect and discard closed idle connections. (#1815) [release/1.17] (#1841)
  GODRIVER-3313 [release/1.17] Skip CSOT spec tests on Windows and macOS. (#1838)
  GODRIVER-3358 [release/1.17] Do not override authSource from TXT record (#1840)
  GODRIVER-2589 [release/1.17] Clarify `*Cursor.All()` behavior in comment. (#1839)
  DEVPROD-10453 Use assume_role for s3 uploads [release/1.17] (#1824) (#1837)
  update repo metadata

alcaeus added a commit that referenced this pull request


          Mark release/1.17 as fully merged into v1

969166c

* commit '9c485751':
  BUMP v1.17.3
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943) [release/1.17] (#1957)
  Update reviewers.txt (#1855) [v1] (#1883) [release/1.17] (#1958)
  Cherry pick 1.17.2 work to release/1.17 (#1956)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924) (#1955)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927) [release/1.17] (#1954)
  GODRIVER-3340 Bump github.com/klauspost/compress from 1.13.6 to 1.16.7 [release/1.17] (#1880)
  GODRIVER-3374 Add ReadCompressedCompressedMessage back to wiremessage API (#1870)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  Bump golangci-lint for 1.23 compatibility [v1] (#1875)
  BUMP v1.17.1
  GODRIVER-3156 Detect and discard closed idle connections. (#1815) [release/1.17] (#1841)
  GODRIVER-3313 [release/1.17] Skip CSOT spec tests on Windows and macOS. (#1838)
  GODRIVER-3358 [release/1.17] Do not override authSource from TXT record (#1840)
  GODRIVER-2589 [release/1.17] Clarify `*Cursor.All()` behavior in comment. (#1839)
  DEVPROD-10453 Use assume_role for s3 uploads [release/1.17] (#1824) (#1837)
  update repo metadata

mongodb-drivers-pr-bot bot mentioned this pull request

Merge v1 into release/2.0 #1971

Merged

alcaeus added a commit that referenced this pull request


          Mark v1 as fully merged into release/2.0

f74a8dc

* commit '0dc2e05e': (184 commits)
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927)
  BUMP v1.17.2
  GODRIVER-3436 Avoid initializing null data given custom decoder (#1902)
  GODRIVER-3340 Add a test for goroutine leaks. (#1874)
  Update reviewers.txt (#1855) [v1] (#1883)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  Bump golangci-lint for 1.23 compatibility [v1] (#1875)
  GODRIVER-3340 Bump github.com/klauspost/compress from 1.13.6 to 1.16.7 [v1] (#1869)
  GODRIVER-3374 Add ReadCompressedCompressedMessage back to wiremessage API (#1870)
  GODRIVER-3156 Detect and discard closed idle connections. (#1815)
  GODRIVER-3358 Do not override authSource from TXT record (#1830)
  DEVPROD-10453 Use assume_role for s3 uploads [v1] (#1824)
  GODRIVER-2589 Clarify `*Cursor.All()` behavior in comment. (#1804)
  GODRIVER-3313 Skip CSOT spec tests on Windows and macOS. (#1818)
  BUMP v1.17.0
  GODRIVER-3302 Handle malformatted message length properly. (#1758)
  GODRIVER-3312 Use remaining test secrets from the vault [v1] (#1811)
  Remove GCP from supplied callback example (#1809)
  ...

alcaeus added a commit that referenced this pull request


          Merge branch 'v1' into merge-v1-into-release/2.0-1741093165191

81d33e6

* v1:
  Use different credentials for merge-up PRs (#1968)
  Add GitHub Actions workflow for merge ups (#1962)
  BUMP v1.17.3
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943) [release/1.17] (#1957)
  Update reviewers.txt (#1855) [v1] (#1883) [release/1.17] (#1958)
  Cherry pick 1.17.2 work to release/1.17 (#1956)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924) (#1955)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927) [release/1.17] (#1954)
  GODRIVER-3340 Bump github.com/klauspost/compress from 1.13.6 to 1.16.7 [release/1.17] (#1880)
  GODRIVER-3374 Add ReadCompressedCompressedMessage back to wiremessage API (#1870)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  Bump golangci-lint for 1.23 compatibility [v1] (#1875)
  BUMP v1.17.1
  GODRIVER-3156 Detect and discard closed idle connections. (#1815) [release/1.17] (#1841)
  GODRIVER-3313 [release/1.17] Skip CSOT spec tests on Windows and macOS. (#1838)
  GODRIVER-3358 [release/1.17] Do not override authSource from TXT record (#1840)
  GODRIVER-2589 [release/1.17] Clarify `*Cursor.All()` behavior in comment. (#1839)
  DEVPROD-10453 Use assume_role for s3 uploads [release/1.17] (#1824) (#1837)
  update repo metadata

mongodb-drivers-pr-bot bot mentioned this pull request

Merge release/2.0 into release/2.1 #1972

Merged

alcaeus added a commit that referenced this pull request


          Merge branch 'release/2.0' into merge-release/2.0-into-release/2.1-17…

8ea0039

…41094483929

* release/2.0: (203 commits)
  Use different credentials for merge-up PRs (#1968)
  Add GitHub Actions workflow for merge ups (#1962)
  BUMP v1.17.3
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943) [release/1.17] (#1957)
  Update reviewers.txt (#1855) [v1] (#1883) [release/1.17] (#1958)
  Cherry pick 1.17.2 work to release/1.17 (#1956)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924) (#1955)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927) [release/1.17] (#1954)
  GODRIVER-3448 Limit GOMAXPROCS for fuzz tests (#1939) [v1] (#1943)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924)
  GODRIVER-3370 Add bypassEmptyTsReplacement option. (#1927)
  BUMP v1.17.2
  GODRIVER-3436 Avoid initializing null data given custom decoder (#1902)
  GODRIVER-3340 Add a test for goroutine leaks. (#1874)
  Update reviewers.txt (#1855) [v1] (#1883)
  GODRIVER-3340 Bump github.com/klauspost/compress from 1.13.6 to 1.16.7 [release/1.17] (#1880)
  GODRIVER-3374 Add ReadCompressedCompressedMessage back to wiremessage API (#1870)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  Bump golangci-lint for 1.23 compatibility [v1] (#1875)
  Fix data race in 'discard connections' pool test. [v1] (#1877)
  ...

mongodb-drivers-pr-bot bot mentioned this pull request

Merge release/2.1 into master #1973

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority-1-high