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

fix MongoOperationTimeoutError inheritance to not share hierarchy with RuntimeError

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 6.11.0
    • Affects Version/s: None
    • Component/s: None
    • 2
    • Not Needed
    • 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?

      Use Case

      As a Node.js driver user
      I want Runtime errors and any subclasses of that error to represent unrecoverable/surprising errors only
      So that I can differentiate errors that represent a surprising runtime issue versus an expected error possibility

      User Experience

      • What is the desired/expected outcome for the user once this ticket is implemented?
        • MongoOperationTimeoutError aligns with MongoServerSelectionTimeoutError MongoDriverError inheritance
      • If bug: What is the number of impacted customers? How severe is the impact? Is anyone blocked or broken?
        • None, CSOT has not shipped yet

      Dependencies

      • upstream and/or downstream requirements and timelines to bear in mind
        • None

      Risks/Unknowns

      • What could go wrong while implementing this change? (e.g., performance, inadvertent behavioral changes in adjacent functionality, existing tech debt, etc)
        • None
      • Is there an opportunity for better cross-driver alignment or testing in this area?
        • No
      • Is there an opportunity to improve existing documentation on this subject?
        • Yes. we should clarify in the API docs the expected handling of this error

      Acceptance Criteria

      Implementation Requirements

      • Change the inheritance of MongoOperationTimeoutError

      Testing Requirements

      • assert instanceof on parent error classes pass to prevent regression
      • Test expected error handling code snippets

      Documentation Requirements

      • API docs.

      Follow Up Requirements

      • None

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

              Created:
              Updated:
              Resolved: