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

Add timeoutMS support for explain helpers

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • csot-1.0, 6.10.0
    • Affects Version/s: None
    • Component/s: None
    • Not Needed

      Use Case

      Add support for timeoutMS to `explain` commands:

      When timeoutMS is specified, drivers MUST provide a way to specify timeoutMS that results in maxTimeMS being set on the explain command

      https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md#explain

      Users will be able to provide a timeoutMS value for explain specifically.

      • `timeoutMS` will not be inherited from the parent command to the child command.
      • If both `timeoutMS` and `maxTimeMS` is set, `timeoutMS` takes priority.

      User Experience

      n/a

      Dependencies

      n/a

      Risks/Unknowns

      n/a

      Acceptance Criteria

      Implementation Requirements

      • functional reqs, potential snafus to avoid, performance targets, etc

      Testing Requirements

      • unit test, spec test sync, etc

      Documentation Requirements

      • DOCSP ticket, API docs, etc

      Follow Up Requirements

      • additional tickets to file, required releases, etc
      • if node behavior differs/will differ from other drivers, confirm with dbx devs what standard to aim for and what plan, if any, exists to reconcile the diverging behavior moving forward

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: