Finish including Beam version details in MongoDB handshake

[NoahStapp]

(Follow-up reversion for 36949)

This PR finishes incorporating MongoDB's wrapping client library specification for the connection handshake to allow library details to be included in the metadata written to mongos or mongod logs.

For example, this change would allow server-side logs such as the following:

{
"t":{"$date":"2025-01-27T23:10:40.108Z"},"s":"I","c":"NETWORK","id":51800,"ctx":"conn16235","msg":"client metadata","attr":{"remote":"127.0.0.1:1094","client":"conn16235",
"doc":{"driver":{"name":"python|Apache Beam","version":"4.15.0|BEAM_VERSION"},"platform":"Python 3.13.7",
"os":{"name":"linux","architecture":"x64","version":"5.15.133+","type":"Linux"}}}
}

For anyone hosting clusters with connections coming from different applications this can help differentiate connections and facilitate log analysis.

---

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

• Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
• Update CHANGES.md with noteworthy changes.
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

[gemini-code-assist]

Summary of Changes

Hello @NoahStapp, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request finalizes the integration of MongoDB's wrapping client library specification within Apache Beam's MongoDB I/O connector. The core purpose is to ensure that Beam's version information is consistently transmitted during the MongoDB connection handshake, which significantly enhances server-side logging capabilities for better operational insights. Additionally, the changes include refactoring the _MongoSource class to manage client connections more efficiently by reusing a single MongoClient instance across operations.

Highlights

• MongoDB Handshake Metadata: This pull request completes the implementation of MongoDB's wrapping client library specification, ensuring that Apache Beam's version details are consistently included in the MongoDB connection handshake. This enhancement allows server-side logs to capture valuable metadata about the connecting Beam application, facilitating better log analysis and differentiation of connections from various applications.
• Refactoring MongoDB Client Usage in _MongoSource: The _MongoSource class has been refactored to optimize its interaction with MongoDB. Instead of creating a new MongoClient instance for each operation (such as estimate_size, read, or _get_split_keys), it now consistently utilizes a single self.client instance, improving efficiency and resource management.
• Consistent DriverInfo for _MongoSink: The _MongoSink class now explicitly passes DriverInfo("Apache Beam", beam.__version__) during the initialization of its MongoClient instance within both its write method and __enter__ context manager. This ensures that the Beam version information is correctly propagated to MongoDB for write operations as well.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

[Abacn]

this changed timing of client, made if from transient and auto-closing to persistent.

I would prefer a fix not changing current behavior. Consider the following

1. Revert Include Beam version details in MongoDB handshake #36949
2. In __init__, update self.spec such that, if it does not contain a key named "driver", set self.spec["driver"] = DriverInfo("Apache Beam", beam.__version__)

[NoahStapp]

Totally understand not wanting to make an implementation change on client management, but I would offer a strong motivation to do so: performance. Creating a new client for every operation has a much larger overhead than using a single persistent client across all operations. Can you share the current motivation for transient per-operation MongoClients?

[Abacn]

Performance could be another topic for separate changes.

also (**self.spec, driver=...) call will crash if self.spec has "driver" key (TypeError: ... get multiple valued for keyword argument driver)

[NoahStapp]

Fair enough. I'll update this PR to revert the earlier change and apply your self.spec suggestion.

[Abacn]

Thanks. Shall we also port this change to Sink?

beam/sdks/python/apache_beam/io/mongodbio.py

Line 779 in 7564e9e

def __init__(self, uri=None, db=None, coll=None, extra_params=None):

[github-actions]

Assigning reviewers:

R: @jrmccluskey for label python.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

• stop reviewer notifications - opt out of the automated review tooling
• remind me after tests pass - tag the comment author after tests pass
• waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).