-
Type: Task
-
Resolution: Fixed
-
Priority: Major - P3
-
Affects Version/s: None
-
Component/s: None
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
MongoServerSelectionTimeoutErrorMongoDriverError inheritance
- MongoOperationTimeoutError aligns with
- 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