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

Deprecate and detect CSOT-deprecated options and add logic to prefer timeoutMS

    • 3
    • Not Needed
    • Hide

      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

      Show
      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.
    • Not 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?

      There is a suite of spec tests to cover this for timeoutMS.
      ------------------------

      Use Case

      As a... Node.js driver user
      I want... timeoutMS to be preferred over deprecated options
      So that... I get consistent new behavior if I accidentally specify both the new and the old options.

      User Experience

      Dependencies

      • None

      Risks/Unknowns

      • What could go wrong while implementing this change? (e.g., performance, inadvertent behavioral changes in adjacent functionality, existing tech debt, etc)
        • N/A
      • Is there an opportunity for better cross-driver alignment or testing in this area?
        • Already tested by spec
      • Is there an opportunity to improve existing documentation on this subject?
        • We should double check the node driver mongodb docs to make sure the deprecated options are marked accordingly

      Acceptance Criteria

      Implementation Requirements

      • Deprecate anything that CSOT marks deprecated
      • Add logic to ensure timeoutMS is preferred over the deprecated options

      Testing Requirements

      Documentation Requirements

      • API docs for deprecations
      • Manual docs as needed

      Follow Up Requirements

      • File bug ticket to do this more generally for other options

        There are no Sub-Tasks for this issue.

            Assignee:
            warren.james@mongodb.com Warren James
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: