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

Investigate making socks an optional peer dependency

    • 3
    • Not Needed

      Use Case

      Support for socks5 proxy is an enhancement not needed by all users of the driver. We could consider moving socks to an optional peer dependency improving total package install size, code import time and memory usage.

      User Impact

      • Users of socks proxies would need to install this dependency themselves, this would be a significant behavior change, so we would want to confine this change to a major version bump.

      Dependencies

      • N/A

      Unknowns

      • Is this a breaking change we should do as part of v6?
      • Do we document working with socks 5 outside of API docs? – No
        • How should we make this visible to users?

      Acceptance Criteria

      Implementation Requirements

      • Document outlining pros and cons of making the peer optional dependency, with recommended path forward.
        • Address the unknowns in the doc.
      • Team agreement on path forward.

      Testing Requirements

      • To be addressed in follow-up ticket.

      Documentation Requirements

      • TBD, dependent on related open question.

      Follow Up Requirements

      • File a separate ticket for implementation if we decide to make it optional.
      • Mark new ticket as DevTools changes needed when it is determined whether we would do this or not.

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

              Created:
              Updated:
              Resolved: