Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2868

Clarify maxAwaitTimeMS adjustment by timeoutMS and RTT

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: CSOT
    • Needed
    • Hide

      Summary of necessary driver changes

      •  

      Commits for syncing spec/prose tests
      (and/or refer to an existing language POC if needed)

      •  

      Context for other referenced/linked tickets

      •  
      Show
      Summary of necessary driver changes   Commits for syncing spec/prose tests (and/or refer to an existing language POC if needed)   Context for other referenced/linked tickets  

      Summary

      There was a discussion in the CSOT channel regarding maxAwaitTimeMS adjustment by remaining timeout with RTT. 

      The current spec elaborates on incorporating the server's min RTT into the calculation of maxTimeMS for commands to prevent operations from being sent to the server if they're likely to fail due to timeout constraints, which aims to reduce connection churn. However, this part of the document is focused on the calculation of maxTimeMS for general command execution rather than specifically adjusting maxAwaitTimeMS for cursor operations.

      Specifically, there is a lack of clarity in the current specification on whether maxAwaitTimeMS should be adjusted by the remaining timeoutMS - RTT in command execution scenarios, particularly affecting tailable awaitData cursors. This omission could lead to connection churn in drivers.

      For example, if maxAwaitTimeMS is set to 9ms, timeoutMS to 10ms, and RTT is 2ms, this configuration might result in getMore command timing out when no data is available, leading to connection closure on the driver's side. Moreover, the next() method on a tailable cursor executes getMore in a loop until data becomes available or the timeout expires. When the remaining timeoutMS -  RTT becomes less than maxAwaitTimeMS, sending the original maxAwaitTimeMS becomes not necessary. Instead, sending the remaining timeoutMS -  RTT should be considered as maxAwaitTimeMS, allowing the server an opportunity to respond with an empty batch. In the subsequent next iteration, the timeout is likely to expire before sending another request, thus avoiding connection closure. 

      This ticket seeks to address and clarify the specification to ensure consistent behaviour within drivers.

      Motivation

      Who is the affected end user?

      Drivers engineers implementing CSOT, users who may see encounter connection closures when no data available for a tailableAwait cursor. 

      How does this affect the end user?

      Lack of clarity may cause discrepancies across driver implementations.

      How likely is it that this problem or use case will occur?

      Likely in scenarios involving tailable await cursors.

      If the problem does occur, what are the consequences and how severe are they?

      Potential for increased connection churn, impacting users' application performance and reliability.

      Is this issue urgent?

      Moderate urgency.

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      No

      Acceptance Criteria

      • The specification has to explicitly state whether and how maxAwaitTimeMS should be adjusted in relation to timeoutMS - RTT for tailable awaitData cursors.

            Assignee:
            preston.vasquez@mongodb.com Preston Vasquez
            Reporter:
            slav.babanin@mongodb.com Slav Babanin
            Shane Harvey Shane Harvey
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated: