DRIVERS-1389 Make ExceededTimeLimit a retryable reads error (#1478)

See C Driver implementation for reference. mongodb/mongo-c-driver#1482 --------- Co-authored-by: Jeremy Mikola <[email protected]> Co-authored-by: Kevin Albertson <[email protected]>
mongodb · Nov 30, 2023 · 5786a46 · 5786a46
1 parent 82da02b
commit 5786a46
Show file tree

Hide file tree

Showing 3 changed files with 218 additions and 0 deletions.
diff --git a/source/retryable-reads/retryable-reads.rst b/source/retryable-reads/retryable-reads.rst
@@ -54,6 +54,7 @@ An error is considered retryable if it meets any of the following criteria:
 =============================== ==============
 **Error Name**                  **Error Code**
 =============================== ==============
+ExceededTimeLimit               262
 InterruptedAtShutdown           11600
 InterruptedDueToReplStateChange 11602
 NotWritablePrimary              10107
@@ -703,6 +704,8 @@ degraded performance can simply disable ``retryableReads``.
 Changelog
 =========
 
+:2023-11-28: Add ExceededTimeLimit to the list of error codes that should
+             be retried.
 :2023-08-26: Require that in a sharded cluster the server on which the
              operation failed MUST be provided to the server selection
              mechanism as a deprioritized server.

diff --git a/source/retryable-reads/tests/unified/exceededTimeLimit.json b/source/retryable-reads/tests/unified/exceededTimeLimit.json
diff --git a/source/retryable-reads/tests/unified/exceededTimeLimit.yml b/source/retryable-reads/tests/unified/exceededTimeLimit.yml
@@ -0,0 +1,68 @@
+description: "ExceededTimeLimit is a retryable read"
+
+schemaVersion: "1.3"
+
+runOnRequirements:
+  - minServerVersion: "4.0"
+    topologies: [single, replicaset]
+  - minServerVersion: "4.1.7"
+    topologies: [sharded, load-balanced]
+
+createEntities:
+  - client:
+      id: &client0 client0
+      # Ensure the `configureFailpoint` and `find` commands are run on the same mongos
+      useMultipleMongoses: false
+      observeEvents: [ commandStartedEvent ]
+  - database:
+      id: &database0 database0
+      client: *client0
+      databaseName: &database0Name "retryable-reads-tests"
+  - collection:
+      id: &collection0 collection0
+      database: *database0
+      collectionName: &collection0Name "exceededtimelimit-test"
+
+initialData:
+  - collectionName: *collection0Name
+    databaseName: *database0Name
+    documents:
+      - { _id: 1, x: 11 }
+      - { _id: 2, x: 22 }
+      - { _id: 3, x: 33 }
+
+tests:
+  - description: "Find succeeds on second attempt after ExceededTimeLimit"
+    operations:
+      - name: failPoint
+        object: testRunner
+        arguments:
+          client: *client0
+          failPoint:
+            configureFailPoint: failCommand
+            mode: { times: 1 }
+            data:
+              failCommands: [ "find" ]
+              errorCode: 262 # ExceededTimeLimit
+      - name: find
+        arguments:
+          filter: { _id: { $gt: 1 } }
+        object: *collection0
+        expectResult:
+          - { _id: 2, x: 22 }
+          - { _id: 3, x: 33 }
+    expectEvents:
+      - client: *client0
+        events:
+          - commandStartedEvent:
+              command:
+                find: *collection0Name
+                filter: { _id: { $gt: 1 } }
+              commandName: find
+              databaseName: *database0Name
+          - commandStartedEvent:
+              command:
+                find: *collection0Name
+                filter: { _id: { $gt: 1 } }
+              commandName: find
+              databaseName: *database0Name