GODRIVER-2810 Switch to polling monitoring when running within a FaaS environment #1376

prestonvasquez · 2023-09-06T15:10:51Z

Summary

Revert SDAM monitoring process to use the legacy polling mechanism when a FaaS runtime environment is detected.

Background & Motivation

The streaming protocol used by SDAM monitoring when communicating with MongoDB 4.4+ clusters can result in socket timeouts when the underlying runtime environment resumes after being frozen/paused then (ex: Lambda).

… environment

github-actions · 2023-09-07T01:06:31Z

API Change Report

./mongo/options

compatible changes

(*ClientOptions).SetServerMonitoringMode: added
ClientOptions.ServerMonitoringMode: added
ServerMonitoringModeAuto: added
ServerMonitoringModePoll: added
ServerMonitoringModeStream: added

./x/mongo/driver/connstring

compatible changes

ConnString.ServerMonitoringMode: added
IsValidServerMonitoringMode: added
ServerMonitoringModeAuto: added
ServerMonitoringModePoll: added
ServerMonitoringModeStream: added

prestonvasquez · 2023-09-07T22:32:10Z

x/mongo/driver/operation/hello.go

@@ -125,99 +124,6 @@ func (h *Hello) Result(addr address.Address) description.Server {
 	return description.NewServer(addr, bson.Raw(h.res))
 }

-const (


Moved all of this logic to the driverutil internal package so it can be shared across multiple x packages without duplication.

qingyang-hu

👍

prestonvasquez · 2023-10-17T23:29:28Z

mongo/integration/unified/event_verification.go

+	return events[0], events[:1], nil
+}
+
+func verifySDAMEvents(client *clientEntity, expectedEvents *expectedEvents) error {


@qingyang-hu @matthewdale The addition of the 1.17 schema in this ticket and the UTR updates missed in the implementation of mongodb/specifications#1291 require this verification function.

mongo/integration/client_test.go

x/mongo/driver/topology/server.go

matthewdale · 2023-10-20T00:55:21Z

mongo/options/clientoptions.go

@@ -206,6 +226,7 @@ type ClientOptions struct {
 	RetryReads               *bool
 	RetryWrites              *bool
 	ServerAPIOptions         *ServerAPIOptions
+	ServerMonitoringMode     *string


We define the expected values of ServerMonitoringMode, so we should define a string value for "not set" instead of using a pointer. I recommend defining empty string as "not set".

We also define expected values for the read/write concerns. Not using a pointer here deviates from the existing pattern, which seems to intend that data in an options struct be nullable. We don't expect users to construct this data at the struct level:

Each option can be set through setter functions.

Would you mind expanding on this? And what is meant by "we should define a string value for 'not set'"? If we do go the non-pointer route, I don't think we should extend the "ServerMonitoringMode*" constants to include a "ServerMonitoringModeNotSet" case, it's not defined in the specifications and I'm not sure how it would help a user.

I was mostly reacting to the additional logic for handling pointers, which is unnecessary if the zero value can represent "not set". However, you're correct that the strong existing pattern in ClientOptions is to use pointers and nil for "not set". This PR doesn't seem like the right place to change that pattern. Consider my original comment resolved.

matthewdale

Looks good! 👍

matthewdale · 2023-10-21T00:56:09Z

mongo/options/clientoptions.go

@@ -206,6 +226,7 @@ type ClientOptions struct {
 	RetryReads               *bool
 	RetryWrites              *bool
 	ServerAPIOptions         *ServerAPIOptions
+	ServerMonitoringMode     *string


I was mostly reacting to the additional logic for handling pointers, which is unnecessary if the zero value can represent "not set". However, you're correct that the strong existing pattern in ClientOptions is to use pointers and nil for "not set". This PR doesn't seem like the right place to change that pattern. Consider my original comment resolved.

qingyang-hu

👍

prestonvasquez · 2023-10-27T21:05:30Z

Dockerfile

@@ -28,6 +28,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
    tzdata \
    gpg \
    apt-utils \
+    libc6-dev \
+    gcc \


C compiler is required to run a race test on non-darwin, see requirements: https://go.dev/doc/articles/race_detector#Requirements

prestonvasquez · 2023-10-27T21:12:50Z

x/mongo/driver/topology/rtt_monitor.go

+	// connMu guards connecting and disconnecting. This is necessary since
+	// disconnecting will await the cancelation of a started connection. The
+	// use case for rttMonitor.connect needs to be goroutine safe.
+	connMu        sync.Mutex


This PR requires that the rttMonitor's connection be established in a separate thread than the one server.Disconnect() is called in:

Because of this, it's possible that a disconnect could occur before a connection actually takes place, P_0. This would make any call to the shared wait group unsafe. connMu guards this case.

There should be no locking contention with this solution, the P_0 case is extremely difficult to force and there should only be one call to connect per server connection.

@qingyang-hu @matthewdale I just caught a race condition in the logic. Hopefully this is the last review required

matthewdale

Looks good 👍

… environment (mongodb#1376) (cherry picked from commit 99bdb94)

…n a FaaS environment (mongodb#1376)" This reverts commit 99bdb94.

prestonvasquez added 4 commits September 5, 2023 17:59

GODRIVER-2810 Switch to polling monitoring when running within a FaaS…

fbbafce

… environment

GODRIVER-2972 Fix wiremessage RequestID race in operation.Execute

2a88672

Merge branch 'GODRIVER-2972' into GODRIVER-2810

8c6de75

GODRIVER-2810 Correct expected order for test assertion

7a61bdb

prestonvasquez had a problem deploying to api-report September 6, 2023 15:10 — with GitHub Actions Failure

GODRIVER-2810 Fix hello test faas getter reference

d5a6c99

prestonvasquez had a problem deploying to api-report September 6, 2023 15:28 — with GitHub Actions Failure

prestonvasquez added 6 commits September 6, 2023 12:04

GODRIVER-2935 Use OP_QUERY in connection handshakes

8277d88

GODRIVER-2810 restore legacy hello

fb83d15

GODRIVER-2935 Update sent_message logic to include OP_QUERY for hello

728f277

GODRIVER-2935 Add LegacyHandshake operation logic

9fec743

Merge branch 'GODRIVER-2935' into GODRIVER-2810

7c38cd1

GODRIVER-2810 Clean up handshake prose test

fcc4db7

prestonvasquez had a problem deploying to api-report September 6, 2023 22:17 — with GitHub Actions Failure

GODRIVER-2810 Remove debugging tools

fe237bb

prestonvasquez temporarily deployed to api-report September 6, 2023 22:18 — with GitHub Actions Inactive

GODRIVER-2935 Extend legacy check to GetHandshakeInformation

c343f12

prestonvasquez added 4 commits September 7, 2023 09:00

GODRIVER-2935 Add legacy tests back to auth and client

25b7685

Merge branch 'master' into GODRIVER-2935

c0085e1

Merge branch 'GODRIVER-2935' into GODRIVER-2810

a62ad25

GODRIVER-2810 Mege master

0e8a3a9

prestonvasquez temporarily deployed to api-report September 7, 2023 21:33 — with GitHub Actions Inactive

GODRIVER-2810 Add licenses

3672bb4

prestonvasquez had a problem deploying to api-report September 7, 2023 22:04 — with GitHub Actions Failure

prestonvasquez commented Sep 7, 2023

View reviewed changes

GODRIVER-2810 Cleanup code

b8cba73

prestonvasquez had a problem deploying to api-report September 7, 2023 22:35 — with GitHub Actions Failure

GODRIVER-2810 Re-organize rtt monitor

cfb1c66

prestonvasquez temporarily deployed to api-report September 8, 2023 22:25 — with GitHub Actions Inactive

qingyang-hu previously approved these changes Oct 17, 2023

View reviewed changes

prestonvasquez added 2 commits October 17, 2023 15:45

Merge branch 'v1' into GODRIVER-2810

ce91abf

GODRIVER-2810 Bump schema to 1.17

d2798ef

prestonvasquez dismissed stale reviews from qingyang-hu and matthewdale via d2798ef October 17, 2023 23:14

prestonvasquez requested review from matthewdale and qingyang-hu October 17, 2023 23:27

prestonvasquez commented Oct 17, 2023

View reviewed changes

matthewdale reviewed Oct 20, 2023

View reviewed changes

GODRIVER-2810 Remove unecessary bool logic

aaa1b6a

prestonvasquez requested a review from matthewdale October 20, 2023 18:36

matthewdale previously approved these changes Oct 21, 2023

View reviewed changes

qingyang-hu previously approved these changes Oct 23, 2023

View reviewed changes

prestonvasquez added 2 commits October 23, 2023 09:36

Merge branch 'v1' into GODRIVER-2810

20d1b17

GODRIVER-2810 Guard rttMonitor connection

b686f7c

prestonvasquez dismissed stale reviews from qingyang-hu and matthewdale via b686f7c October 27, 2023 20:55

prestonvasquez commented Oct 27, 2023

View reviewed changes

prestonvasquez requested review from matthewdale and qingyang-hu October 27, 2023 21:14

GODRIVER-2810 Remove unused rttMonitor field

34a8970

matthewdale approved these changes Nov 1, 2023

View reviewed changes

qingyang-hu approved these changes Nov 1, 2023

View reviewed changes

prestonvasquez merged commit 99bdb94 into mongodb:v1 Nov 1, 2023
36 checks passed

prestonvasquez deleted the GODRIVER-2810 branch November 1, 2023 19:11

blink1073 pushed a commit to blink1073/mongo-go-driver that referenced this pull request Nov 1, 2023

GODRIVER-2810 Switch to polling monitoring when running within a FaaS…

160deeb

… environment (mongodb#1376) (cherry picked from commit 99bdb94)

blink1073 mentioned this pull request Nov 1, 2023

GODRIVER-2810 [master] Switch to polling monitoring when running within a FaaS environment #1447

Merged

qingyang-hu mentioned this pull request Mar 29, 2024

GODRIVER-3107 Fix leaking rttMonitor.runHellos() routine. #1587

Merged

benjirewis added a commit to benjirewis/mongo-go-driver that referenced this pull request Jul 23, 2024

Revert "GODRIVER-2810 Switch to polling monitoring when running withi…

b1f892b

…n a FaaS environment (mongodb#1376)" This reverts commit 99bdb94.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GODRIVER-2810 Switch to polling monitoring when running within a FaaS environment #1376

GODRIVER-2810 Switch to polling monitoring when running within a FaaS environment #1376

prestonvasquez commented Sep 6, 2023

github-actions bot commented Sep 7, 2023 •

edited

Loading

prestonvasquez Sep 7, 2023

qingyang-hu left a comment

prestonvasquez Oct 17, 2023 •

edited

Loading

matthewdale Oct 20, 2023

prestonvasquez Oct 20, 2023 •

edited

Loading

matthewdale Oct 21, 2023

matthewdale left a comment

matthewdale Oct 21, 2023

qingyang-hu left a comment

prestonvasquez Oct 27, 2023

prestonvasquez Oct 27, 2023 •

edited

Loading

prestonvasquez Oct 27, 2023

matthewdale left a comment

GODRIVER-2810 Switch to polling monitoring when running within a FaaS environment #1376

GODRIVER-2810 Switch to polling monitoring when running within a FaaS environment #1376

Conversation

prestonvasquez commented Sep 6, 2023

Summary

Background & Motivation

github-actions bot commented Sep 7, 2023 • edited Loading

API Change Report

./mongo/options

compatible changes

./x/mongo/driver/connstring

compatible changes

prestonvasquez Sep 7, 2023

Choose a reason for hiding this comment

qingyang-hu left a comment

Choose a reason for hiding this comment

prestonvasquez Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

matthewdale Oct 20, 2023

Choose a reason for hiding this comment

prestonvasquez Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

matthewdale Oct 21, 2023

Choose a reason for hiding this comment

matthewdale left a comment

Choose a reason for hiding this comment

matthewdale Oct 21, 2023

Choose a reason for hiding this comment

qingyang-hu left a comment

Choose a reason for hiding this comment

prestonvasquez Oct 27, 2023

Choose a reason for hiding this comment

prestonvasquez Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

prestonvasquez Oct 27, 2023

Choose a reason for hiding this comment

matthewdale left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 7, 2023 •

edited

Loading

prestonvasquez Oct 17, 2023 •

edited

Loading

prestonvasquez Oct 20, 2023 •

edited

Loading

prestonvasquez Oct 27, 2023 •

edited

Loading