GODRIVER-3544, GODRIVER-3653 Allow Client to Send Client Metadata On-Demand #2197

prestonvasquez · 2025-09-12T05:04:04Z

Summary

Extend the mongo.Client stable API to allow appending handshake client metadata on demand.

Background & Motivation

NA

Copilot

Pull Request Overview

This PR extends the mongo.Client API to support appending client metadata on-demand for handshake requests. The implementation allows drivers to dynamically update metadata information (name, version, platform) that is sent to servers during connection establishment.

Replaces static driver info configuration with atomic pointer-based dynamic metadata management
Adds AppendDriverInfo method to Client for runtime metadata updates
Refactors topology configuration to use functional options pattern with atomic driver info handling

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
mongo/client.go	Adds `AppendDriverInfo` method and atomic driver info management to Client
x/mongo/driver/topology/topology_options.go	Refactors config creation with functional options and atomic driver info
x/mongo/driver/topology/server_options.go	Replaces individual driver info fields with atomic pointer
x/mongo/driver/topology/server.go	Updates connection creation to use atomic driver info
internal/integration/handshake_test.go	Comprehensive test coverage for dynamic metadata appending
internal/integration/unified/operation.go	Adds `appendMetadata` operation support
internal/integration/unified/client_operation_execution.go	Implements unified test operation execution
internal/test/client_metadata.go	Test utility for encoding client metadata
internal/integration/mtest/proxy_*.go	Enhanced proxy message capture for testing
internal/handshake/handshake.go	Utility for parsing client metadata from wire messages
internal/assert/assertbsoncore/assertions_bsoncore.go	Assertion helpers for comparing client metadata

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

mongo/client.go

internal/integration/sdam_prose_test.go

x/mongo/driver/topology/topology_options.go

Copilot · 2025-09-12T05:05:14Z

x/mongo/driver/topology/server.go

+			if s.cfg.driverInfo != nil {
+				driverInfo := s.cfg.driverInfo.Load()
+				if driverInfo != nil {
+					handshaker = handshaker.OuterLibraryName(driverInfo.Name).OuterLibraryVersion(driverInfo.Version).
+						OuterLibraryPlatform(driverInfo.Platform)
+				}
+			}


[nitpick] The nested nil checks for s.cfg.driverInfo and driverInfo.Load() could be simplified using a helper function or by consolidating the logic, improving code readability.

mongodb-drivers-pr-bot · 2025-09-12T05:08:14Z

🧪 Performance Results

Commit SHA: 11797dc

The following benchmark tests for version 68f1ad4b2b4b620007210534 had statistically significant changes (i.e., |z-score| > 1.96):

Benchmark	Measurement	% Change	Patch Value	Stable Region	H-Score	Z-Score
BenchmarkBSONFullDocumentDecoding	ops_per_second_min	-20.1461	1709.1446	Avg: 2140.3402 Med: 2136.4062 Stdev: 23.9214	0.9743	-18.0256
BenchmarkMultiInsertSmallDocument	total_mem_allocs	15.5366	2619568.0000	Avg: 2267306.4954 Med: 2237567.0000 Stdev: 118540.4234	0.8327	2.9717
BenchmarkSingleFindOneByID	ns_per_op	13.0492	275931.0000	Avg: 244080.3636 Med: 242896.0000 Stdev: 6493.7038	0.8947	4.9048
BenchmarkMultiInsertSmallDocument	total_bytes_allocated	11.2526	496632688.0000	Avg: 446401016.4651 Med: 445093368.0000 Stdev: 14612366.5998	0.8471	3.4376
BenchmarkSingleRunCommand	ops_per_second_max	-10.9222	7944.4524	Avg: 8918.5561 Med: 8902.2255 Stdev: 61.4542	0.9710	-15.8509
BenchmarkMultiInsertSmallDocument	total_time_seconds	10.7537	1.1755	Avg: 1.0614 Med: 1.0474 Stdev: 0.0462	0.8051	2.4711
BenchmarkSingleFindOneByID	ops_per_second_med	-10.2860	3737.7728	Avg: 4166.3226 Med: 4188.7448 Stdev: 126.0224	0.8483	-3.4006
BenchmarkSmallDocInsertOne	ops_per_second_max	-10.0982	5641.1124	Avg: 6274.7515 Med: 6255.1605 Stdev: 137.0257	0.8869	-4.6242
BenchmarkBSONDeepDocumentEncoding	total_mem_allocs	9.9822	244728.0000	Avg: 222515.9237 Med: 222826.5000 Stdev: 7422.7298	0.8354	2.9924
BenchmarkBSONDeepDocumentDecoding	ops_per_second_max	2.9719	17805.3167	Avg: 17291.4307 Med: 17213.7779 Stdev: 220.1727	0.8141	2.3340
BenchmarkSmallDocInsertOne	allocated_bytes_per_op	0.6042	5693.0000	Avg: 5658.8108 Med: 5660.0000 Stdev: 8.0237	0.8757	4.2610
BenchmarkLargeDocInsertOne	allocated_bytes_per_op	0.5711	5692.0000	Avg: 5659.6757 Med: 5660.0000 Stdev: 7.6160	0.8825	4.2443
BenchmarkBSONFullDocumentEncoding	allocated_bytes_per_op	0.0632	5200.0000	Avg: 5196.7143 Med: 5196.0000 Stdev: 1.3801	0.7888	2.3807

For a comprehensive view of all microbenchmark results for this PR's commit, please check out the Evergreen perf task for this patch.

mongodb-drivers-pr-bot · 2025-09-12T05:21:44Z

API Change Report

./v2/mongo

compatible changes

(*Client).AppendDriverInfo: added

./v2/x/mongo/driver/topology

incompatible changes

NewConfigFromOptionsWithAuthenticator: removed
WithOuterLibraryName: removed
WithOuterLibraryPlatform: removed
WithOuterLibraryVersion: removed

compatible changes

AuthConfigOption: added
NewAuthenticatorConfig: added
WithAuthConfigClientOptions: added
WithAuthConfigClock: added
WithAuthConfigDriverInfo: added
WithDriverInfo: added

internal/integration/client_test.go

mongo/client.go

x/mongo/driver/topology/topology_options.go

… assertbsoncore.

matthewdale

Looks good! 👍

internal/assert/assertbson/assertbson_test.go

qingyang-hu · 2025-10-15T22:10:43Z

internal/integration/handshake_test.go

+			assert.True(mt, initialClientMetadata.IsHandshake(), "expected first message to be a handshake")
+
+			// Wait 5ms for the connection to become idle.
+			time.Sleep(20 * time.Millisecond)


Suggested change

time.Sleep(20 * time.Millisecond)

time.Sleep(5 * time.Millisecond)

Is 5ms enough here? Otherwise, we'd better to match the comment to the code. The following cases also have the mismatches.

I'll check if the tests are reliable with 5ms sleeps. If they are, I'll set them all to 5ms.

One of the tests had a 20ms sleep set, and I wanted to make them consistent so I set them all to 20ms. However, I don't think the sleep duration was the main source of test failures.

Updated all to 5ms and the tests seem to pass consistently.

internal/integration/handshake_test.go

qingyang-hu

LGTM, just with some nitpicky comments.

Co-authored-by: Qingyang Hu <[email protected]>

prestonvasquez added 2 commits September 10, 2025 14:09

Allow appending client metadata

6590f6e

Finish prose tests

751104f

prestonvasquez requested a review from a team as a code owner September 12, 2025 05:04

prestonvasquez requested review from Copilot and qingyang-hu September 12, 2025 05:04

Copilot AI reviewed Sep 12, 2025

View reviewed changes

prestonvasquez mentioned this pull request Sep 12, 2025

DRIVERS-3262: appendMetadata() does not append duplicate metdata mongodb/specifications#1833

Merged

3 tasks

alcaeus requested review from matthewdale and removed request for qingyang-hu September 15, 2025 17:54

matthewdale reviewed Sep 15, 2025

View reviewed changes

internal/integration/client_test.go Outdated Show resolved Hide resolved

mongo/client.go Show resolved Hide resolved

x/mongo/driver/topology/topology_options.go Outdated Show resolved Hide resolved

matthewdale added 2 commits October 14, 2025 09:21

Use BSON document literals to define the expected metadata documents.

9373c48

Use statically-defined expected metadata documents for all tests.

8d6b75d

matthewdale added review-priority-normal Medium Priority PR for Review: within 1 business day feature labels Oct 14, 2025

matthewdale added 3 commits October 14, 2025 10:40

Merge branch 'master' into feature/godriver-3544-metadata-on-demand

f0bc695

Fix TestAuthenticateToAnything and reduce calls to atomic.Pointer.Load

bc9a413

Move assert.EqualBSON to the assertbson package and use it instead of…

74be46f

… assertbsoncore.

matthewdale requested a review from qingyang-hu October 14, 2025 23:59

matthewdale previously approved these changes Oct 14, 2025

View reviewed changes

qingyang-hu reviewed Oct 15, 2025

View reviewed changes

internal/assert/assertbson/assertbson_test.go Outdated Show resolved Hide resolved

qingyang-hu reviewed Oct 15, 2025

View reviewed changes

internal/integration/handshake_test.go Show resolved Hide resolved

qingyang-hu previously approved these changes Oct 15, 2025

View reviewed changes

Fix appending client metadata for authenticated handshakes.

8b483fd

matthewdale dismissed stale reviews from qingyang-hu and themself via 8b483fd October 16, 2025 05:08

matthewdale added 2 commits October 15, 2025 22:11

Merge branch 'master' into feature/godriver-3544-metadata-on-demand

b9d57dd

Fix app name test.

2cce6d6

Fix LB handshake test and PR feedback.

551ff2e

matthewdale requested a review from qingyang-hu October 16, 2025 23:21

matthewdale and others added 4 commits October 16, 2025 16:24

Fix AppendDriverInfo comment.

9fa6096

Fix non-LB handshake test.

0785b0d

Update internal/assert/assertbson/assertbson_test.go

11282cd

Co-authored-by: Qingyang Hu <[email protected]>

Add test cases for assertbson.EqualValue

11797dc

qingyang-hu approved these changes Oct 17, 2025

View reviewed changes

matthewdale approved these changes Oct 17, 2025

View reviewed changes

matthewdale merged commit 4bc4835 into mongodb:master Oct 17, 2025
34 checks passed

	time.Sleep(20 * time.Millisecond)
	time.Sleep(5 * time.Millisecond)

GODRIVER-3544, GODRIVER-3653 Allow Client to Send Client Metadata On-Demand #2197

GODRIVER-3544, GODRIVER-3653 Allow Client to Send Client Metadata On-Demand #2197

Uh oh!

Conversation

prestonvasquez commented Sep 12, 2025

Summary

Background & Motivation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

mongodb-drivers-pr-bot bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Performance Results

Uh oh!

mongodb-drivers-pr-bot bot commented Sep 12, 2025

API Change Report

./v2/mongo

compatible changes

./v2/x/mongo/driver/topology

incompatible changes

compatible changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthewdale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qingyang-hu Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthewdale Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

matthewdale Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qingyang-hu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mongodb-drivers-pr-bot bot commented Sep 12, 2025 •

edited

Loading

qingyang-hu Oct 15, 2025 •

edited

Loading