Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-5409

Make `socks` a peer optional dependency

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 6.0.0
    • Affects Version/s: None
    • Component/s: None
    • 3
    • Needed
    • Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?

      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

            Assignee:
            neal.beeken@mongodb.com Neal Beeken
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: