MongoDB connector now includes SOCKS5 proxy settings #11731

Kumar-Kishan · 2025-10-20T19:25:23Z

Description of change

Add socks proxy configuration options

Pull-Request Checklist

Code is up-to-date with the master branch
This pull request links relevant issues as 10529
There are new or updated unit tests validating the change (N/A)
Documentation has been updated to reflect this change (N/A), Since MongoClient already has the options

Summary by CodeRabbit

New Features
- Added SOCKS5 proxy configuration support for MongoDB connections with optional proxy host, port, username, and password settings, allowing connections to route through a SOCKS5 proxy.
Tests
- Added functional tests to verify proxy options are passed through when establishing MongoDB connections.

feat(mongodb): add Socks5 proxy configuration options

Copilot

Pull Request Overview

This PR adds SOCKS5 proxy configuration support to the MongoDB driver, enabling TypeORM users to connect to MongoDB through a SOCKS5 proxy server.

Key Changes:

Added four new connection options for SOCKS5 proxy configuration: proxyHost, proxyPort, proxyUsername, and proxyPassword
Updated the MongoDB driver to recognize and pass through these proxy options to the underlying MongoDB client

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/driver/mongodb/MongoConnectionOptions.ts	Defines the new SOCKS5 proxy configuration options as part of the MongoDB connection interface
src/driver/mongodb/MongoDriver.ts	Registers the new proxy options in the allowed MongoDB options list for pass-through to MongoClient

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

coderabbitai · 2025-10-20T19:25:46Z

Walkthrough

Adds four optional Socks5 proxy configuration fields to MongoDB connection options and accepts them in the driver's option validation; adds a test asserting the proxy fields are forwarded to MongoClient.connect.

Changes

Cohort / File(s)	Summary
MongoDB Proxy Configuration Fields `src/driver/mongodb/MongoConnectionOptions.ts`	Added four optional readonly fields to the connection options interface: `proxyHost?: string`, `proxyPort?: number`, `proxyUsername?: string`, and `proxyPassword?: string`.
MongoDB Driver Option Registration `src/driver/mongodb/MongoDriver.ts`	Added the proxy option names (`proxyHost`, `proxyPort`, `proxyUsername`, `proxyPassword`) to the list of accepted/registered MongoDB connection options so they are passed through to the client.
Tests — Driver proxy forwarding `test/functional/driver/MongoDriver.ts`	Added test group "proxy options" that fakes `MongoClient.connect`, calls `driver.connect()`, and asserts the second argument passed to `connect` contains the proxy configuration fields.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Test
    participant Driver as MongoDriver
    participant Client as MongoClient.connect

    Test->>Driver: create driver with options { ..., proxyHost, proxyPort, proxyUsername, proxyPassword }
    Test->>Client: (fake) replace MongoClient.connect -> Promise.resolve()
    Driver->>Client: connect(uri, options)
    note right of Client #E8F3FF: options include proxyHost,\nproxyPort, proxyUsername, proxyPassword
    Client-->>Driver: Promise resolves
    Driver-->>Test: connect() resolves

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I sniff a new tunnel, soft and spry,
Four little keys to send bytes by,
Socks5 whiskers, quiet and bright,
Hop—connections tucked out of sight. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "MongoDB connector now includes SOCKS5 proxy settings" is fully related to the changeset. All three files modified in this PR directly support this claim: MongoConnectionOptions.ts adds four new optional proxy configuration fields (proxyHost, proxyPort, proxyUsername, proxyPassword), MongoDriver.ts extends option validation to accept these proxy options, and the test file adds a test case group verifying proxy option handling. The title is clear, specific, concise, and avoids vague terminology, making it easy for teammates scanning the history to understand that this PR adds SOCKS5 proxy configuration support to the MongoDB connector.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

pkg-pr-new · 2025-10-20T19:29:30Z

typeorm-sql-js-example

npm i https://pkg.pr.new/typeorm/typeorm@11731

commit: 36c57e1

gioboa

May I ask you to add a test to validate these new settings?

Kumar-Kishan · 2025-10-20T19:32:15Z

@gioboa i am fine with adding tests. But one small problem. I wasn't able to find any tests for mongodb at all? Do you want me to add them as well?

gioboa · 2025-10-20T19:40:16Z

@gioboa i am fine with adding tests. But one small problem. I wasn't able to find any tests for mongodb at all? Do you want me to add them as well?

Here there are MondoDB tests.

Kumar-Kishan · 2025-10-20T20:39:29Z

@gioboa added test cases. Weren't able to test them locally due to better-sqlite3 build issues on my machine. is there any active work on updating it or moving away from it? I saw some issues pointing to move away from it? Will wait for CI test runners, to see if all fine.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

test/functional/driver/MongoDriver.ts (1)

62-98: Test correctly verifies proxy options are passed to MongoClient.

The test properly mocks MongoClient.connect, calls driver.connect(), and asserts that all four proxy configuration fields are present in the options passed to the underlying MongoDB driver. The use of sinon.fake.resolves({}) is appropriate for this async mock.

Consider adding edge-case tests to improve coverage:

Test with partial proxy configuration (e.g., only proxyHost and proxyPort)

Test that proxy options coexist correctly with other MongoDB connection options

Test behavior with missing optional proxy credentials (proxyUsername, proxyPassword)

These additions would strengthen the test suite but are not critical for the current implementation.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2dedf23 and 36c57e1.

📒 Files selected for processing (1)

test/functional/driver/MongoDriver.ts (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

test/functional/driver/MongoDriver.ts (1)

src/driver/mongodb/MongoDriver.ts (2)

MongoDriver (32-575)

connect (246-258)

gioboa

Thanks @Kumar-Kishan for your help 👍

Kumar-Kishan added 2 commits October 20, 2025 17:48

feat(mongodb): add Socks5 proxy configuration options

6357a1c

Merge pull request #1 from Kumar-Kishan/mongodb-socks

2dedf23

feat(mongodb): add Socks5 proxy configuration options

Copilot AI review requested due to automatic review settings October 20, 2025 19:25

Copilot AI reviewed Oct 20, 2025

View reviewed changes

Kumar-Kishan mentioned this pull request Oct 20, 2025

MongoDB connector ignores SOCKS5 proxy settings #10529

Closed

18 tasks

gioboa reviewed Oct 20, 2025

View reviewed changes

test(mongodb): add proxy options test for MongoClient.connect

36c57e1

coderabbitai bot reviewed Oct 20, 2025

View reviewed changes

naorpeled approved these changes Oct 20, 2025

View reviewed changes

gioboa approved these changes Oct 20, 2025

View reviewed changes

gioboa linked an issue Oct 20, 2025 that may be closed by this pull request

MongoDB connector ignores SOCKS5 proxy settings #10529

Closed

18 tasks

gioboa merged commit d7867eb into typeorm:master Oct 20, 2025
61 checks passed

coderabbitai bot mentioned this pull request Nov 8, 2025

docs: collect all migrations documentation in one place #11674

Merged

4 tasks

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025

feat: manage MongoDB SOCKS5 proxy settings (typeorm#11731)

fd2a452

mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026

feat: manage MongoDB SOCKS5 proxy settings (typeorm#11731)

fb778f3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

MongoDB connector now includes SOCKS5 proxy settings #11731

MongoDB connector now includes SOCKS5 proxy settings #11731

Kumar-Kishan commented Oct 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai bot commented Oct 20, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 20, 2025 •

edited

Loading

Uh oh!

gioboa left a comment

Uh oh!

Kumar-Kishan commented Oct 20, 2025

Uh oh!

gioboa commented Oct 20, 2025

Uh oh!

Kumar-Kishan commented Oct 20, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

gioboa left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

MongoDB connector now includes SOCKS5 proxy settings #11731

MongoDB connector now includes SOCKS5 proxy settings #11731

Conversation

Kumar-Kishan commented Oct 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of change

Pull-Request Checklist

Summary by CodeRabbit

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

coderabbitai bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gioboa left a comment

Choose a reason for hiding this comment

Uh oh!

Kumar-Kishan commented Oct 20, 2025

Uh oh!

gioboa commented Oct 20, 2025

Uh oh!

Kumar-Kishan commented Oct 20, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

gioboa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Kumar-Kishan commented Oct 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 20, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 20, 2025 •

edited

Loading