[COMPASS-7004] Make `socks` a peer optional dependency Created: 05/Jul/23  Updated: 29/Oct/23  Resolved: 29/Aug/23

Status: Closed
Project: Compass
Component/s: None
Affects Version/s: None
Fix Version/s: No version

Type: Investigation Priority: Major - P3
Reporter: PM Bot Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: node-driver
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on NODE-5409 Make `socks` a peer optional dependency Closed
Epic Link: MONGOSH-1319
Story Points: 2
Documentation Changes: Not Needed
Sprint: Iteration Iguanodon

 Description   

Use Case

As a driver engineer,
I want `socks` to be a peer optional dependency,
So that we do not have required dependencies for optional features.

User Impact

Users will need to install `socks` themselves in order to use `socks`.  This is a breaking change.

Dependencies

  • n/a

Unknowns

  • n/a

Acceptance Criteria

Implementation Requirements

  • `socks` will no longer be a dependency of the driver and instead will be a peer optional dependency
  • any usages of socks in the driver must lazy-load the socks module.

Testing Requirements

  • modify the socks5 driver, socks5 FLE and the socks5 FLE+tls CI variants to install `socks` manually for testing

Documentation Requirements

  • We have no documentation on how to enable socks5 proxy support with the Node driver.  We should add a page to our "Connection" reference that explains how to setup the driver with socks support.  This page should cover the relevant URI/client options and instruct users that `socks` must be installed.

Follow Up Requirements

  • n/a

Generated at Wed Feb 07 22:45:01 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.