feat(NODE-5409)!: allow socks to be installed optionally #3782
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nbbeeken
force-pushed
the
NODE-5409-socks-optional
branch
from
b123d76 to
1c6fdcb
Compare
baileympearson
added
the
Primary Review
|
|
||
| /** @type {import('../deps').SocksLib | null} */ | ||
| let socks = null; | ||
| function loadSocks() { |
Contributor
There was a problem hiding this comment.
Why is this necessary? makeModuleError returns a proxy that throws whenever a key that isn't kModuleError is accessed. So I'd expect we would just do the following (where it's used):
const socks = loadSocks();
await socks.SocksClient(...)
Contributor
Author
There was a problem hiding this comment.
I'm alinging with the approach taken for kerberos, zstd, snappy. The goal is to not invoke the import operation more than once, determined by the nullishness of the socks variable.
| let socks: SocksLib | null = null; | ||
| function loadSocks() { | ||
| if (socks == null) { | ||
| const socksImport = getSocks(); |
Contributor
There was a problem hiding this comment.
same comment as in stateMachine.js.
baileympearson
requested changes
Jul 25, 2023
Contributor
baileympearson
left a comment
baileympearson
left a comment
There was a problem hiding this comment.
questions about how we're importing socks
nbbeeken
force-pushed
the
NODE-5409-socks-optional
branch
from
410510a to
ac1316e
Compare
baileympearson
approved these changes
Jul 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is changing?
Is there new documentation needed for these changes?
No
What is the motivation for this change?
See highlight
Release Highlight
Allow socks to be installed optionally
The driver uses the
socksdependency to connect tomongodormongosthrough a SOCKS5 proxy.socksused to be a required dependency of the driver and was installed automatically. Now,socksis apeerDependencythat must be installed to enablesocksproxy support.Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript