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

Make snappy an optional peerDependency 7.x+

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • 5.0.0
    • Affects Version/s: None
    • Component/s: None
    • 3
    • Not Needed
    • Not Needed

      Use Case

      We want to drop support for snappy 6 and remove the logic that handles working across either major version. To help signal this change we should add snappy as an optional peerDep, with the version set to 7 or later

      User Impact

      • Users may have to upgrade their version of snappy

      Dependencies

      • Snappy

      Acceptance Criteria

      Implementation Requirements

      • Remove version parsing logic for snappy
      • Remove logic that handles promise or callback style API
      • Add optional peer dep requirement for snappy version
      • Import snappy lazily

      Testing Requirements

      • test lazy importing
      • remove snappy version tests

      Documentation Requirements

      • our current docs for how to get started with snappy are still correct. Double check this incase any salient info is discovered during ticket implementation
      • Migration guide note - none for existing snappy 7+ users, upgrade for others, none for nonsnappy users

            Assignee:
            neal.beeken@mongodb.com Neal Beeken
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Durran Jordan
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: