Skip to content

Commit 5645474

Browse files
isabelatkinsonisabelatkinson
authored
DRIVERS-1385 Always specify error labels at the top level (#1086)
1 parent 11df644 commit 5645474

27 files changed

+112
-111
lines changed

‎source/retryable-writes/retryable-writes.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Retryable Writes
33
================
44

55
:Spec Title: Retryable Writes
6-
:Spec Version: 1.6.1
6+
:Spec Version: 1.7.0
77
:Author: Jeremy Mikola
88
:Lead: \A. Jesse Jiryu Davis
99
:Advisors: Robert Stam, Esha Maharishi, Samantha Ritter, and Kaloian Manassiev
1010
:Status: Accepted
1111
:Type: Standards
1212
:Minimum Server Version: 3.6
13-
:Last Modified: 2021-04-26
13+
:Last Modified: 2021-11-02
1414

1515
.. contents::
1616

@@ -213,8 +213,6 @@ Determining Retryable Errors
213213
When connected to a MongoDB instance that supports retryable writes (versions 3.6+),
214214
the driver MUST treat all errors with the RetryableWriteError label as retryable.
215215
This error label can be found in the top-level "errorLabels" field of the error.
216-
In a server error response with a writeConcernError field the top level document
217-
or the writeConcernError document may contain the RetryableWriteError error label.
218216

219217
RetryableWriteError Labels
220218
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -801,6 +799,9 @@ inconsistent with the server and potentially confusing to developers.
801799
Changes
802800
=======
803801

802+
2021-11-02: Clarify that error labels are only specified in a top-level field of
803+
an error.
804+
804805
2021-04-26: Replaced deprecated terminology
805806

806807
2021-03-24: Require that PoolClearedErrors be retried

‎source/retryable-writes/tests/legacy/bulkWrite-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,12 +119,12 @@
119119
"failCommands": [
120120
"insert"
121121
],
122+
"errorLabels": [
123+
"RetryableWriteError"
124+
],
122125
"writeConcernError": {
123126
"code": 91,
124-
"errmsg": "Replication is being shut down",
125-
"errorLabels": [
126-
"RetryableWriteError"
127-
]
127+
"errmsg": "Replication is being shut down"
128128
}
129129
}
130130
},

‎source/retryable-writes/tests/legacy/bulkWrite-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ tests:
5858
mode: { times: 1 }
5959
data:
6060
failCommands: ["insert"]
61+
errorLabels: ["RetryableWriteError"]
6162
writeConcernError:
6263
code: 91
6364
errmsg: Replication is being shut down
64-
errorLabels: ["RetryableWriteError"]
6565
operation:
6666
name: "bulkWrite"
6767
arguments:

‎source/retryable-writes/tests/legacy/deleteOne-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@
7575
"failCommands": [
7676
"delete"
7777
],
78+
"errorLabels": [
79+
"RetryableWriteError"
80+
],
7881
"writeConcernError": {
7982
"code": 91,
80-
"errmsg": "Replication is being shut down",
81-
"errorLabels": [
82-
"RetryableWriteError"
83-
]
83+
"errmsg": "Replication is being shut down"
8484
}
8585
}
8686
},

‎source/retryable-writes/tests/legacy/deleteOne-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ tests:
3737
mode: { times: 1 }
3838
data:
3939
failCommands: ["delete"]
40+
errorLabels: ["RetryableWriteError"]
4041
writeConcernError:
4142
code: 91
4243
errmsg: Replication is being shut down
43-
errorLabels: ["RetryableWriteError"]
4444
operation:
4545
name: "deleteOne"
4646
arguments:

‎source/retryable-writes/tests/legacy/findOneAndDelete-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@
8181
"failCommands": [
8282
"findAndModify"
8383
],
84+
"errorLabels": [
85+
"RetryableWriteError"
86+
],
8487
"writeConcernError": {
8588
"code": 91,
86-
"errmsg": "Replication is being shut down",
87-
"errorLabels": [
88-
"RetryableWriteError"
89-
]
89+
"errmsg": "Replication is being shut down"
9090
}
9191
}
9292
},

‎source/retryable-writes/tests/legacy/findOneAndDelete-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ tests:
3737
mode: { times: 1 }
3838
data:
3939
failCommands: ["findAndModify"]
40+
errorLabels: ["RetryableWriteError"]
4041
writeConcernError:
4142
code: 91
4243
errmsg: Replication is being shut down
43-
errorLabels: ["RetryableWriteError"]
4444
operation:
4545
name: "findOneAndDelete"
4646
arguments:

‎source/retryable-writes/tests/legacy/findOneAndReplace-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,12 @@
8585
"failCommands": [
8686
"findAndModify"
8787
],
88+
"errorLabels": [
89+
"RetryableWriteError"
90+
],
8891
"writeConcernError": {
8992
"code": 91,
90-
"errmsg": "Replication is being shut down",
91-
"errorLabels": [
92-
"RetryableWriteError"
93-
]
93+
"errmsg": "Replication is being shut down"
9494
}
9595
}
9696
},

‎source/retryable-writes/tests/legacy/findOneAndReplace-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ tests:
3939
mode: { times: 1 }
4040
data:
4141
failCommands: ["findAndModify"]
42+
errorLabels: ["RetryableWriteError"]
4243
writeConcernError:
4344
code: 91
4445
errmsg: Replication is being shut down
45-
errorLabels: ["RetryableWriteError"]
4646
operation:
4747
name: "findOneAndReplace"
4848
arguments:

‎source/retryable-writes/tests/legacy/findOneAndUpdate-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@
8686
"failCommands": [
8787
"findAndModify"
8888
],
89+
"errorLabels": [
90+
"RetryableWriteError"
91+
],
8992
"writeConcernError": {
9093
"code": 91,
91-
"errmsg": "Replication is being shut down",
92-
"errorLabels": [
93-
"RetryableWriteError"
94-
]
94+
"errmsg": "Replication is being shut down"
9595
}
9696
}
9797
},

‎source/retryable-writes/tests/legacy/findOneAndUpdate-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ tests:
3939
mode: { times: 1 }
4040
data:
4141
failCommands: ["findAndModify"]
42+
errorLabels: ["RetryableWriteError"]
4243
writeConcernError:
4344
code: 91
4445
errmsg: Replication is being shut down
45-
errorLabels: ["RetryableWriteError"]
4646
operation:
4747
name: "findOneAndUpdate"
4848
arguments:

‎source/retryable-writes/tests/legacy/insertMany-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@
9292
"failCommands": [
9393
"insert"
9494
],
95+
"errorLabels": [
96+
"RetryableWriteError"
97+
],
9598
"writeConcernError": {
9699
"code": 91,
97-
"errmsg": "Replication is being shut down",
98-
"errorLabels": [
99-
"RetryableWriteError"
100-
]
100+
"errmsg": "Replication is being shut down"
101101
}
102102
}
103103
},

‎source/retryable-writes/tests/legacy/insertMany-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ tests:
4141
mode: { times: 1 }
4242
data:
4343
failCommands: ["insert"]
44+
errorLabels: ["RetryableWriteError"]
4445
writeConcernError:
4546
code: 91
4647
errmsg: Replication is being shut down
47-
errorLabels: ["RetryableWriteError"]
4848
operation:
4949
name: "insertMany"
5050
arguments:

‎source/retryable-writes/tests/legacy/insertOne-serverErrors.json

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -761,12 +761,12 @@
761761
"failCommands": [
762762
"insert"
763763
],
764+
"errorLabels": [
765+
"RetryableWriteError"
766+
],
764767
"writeConcernError": {
765768
"code": 11600,
766-
"errmsg": "Replication is being shut down",
767-
"errorLabels": [
768-
"RetryableWriteError"
769-
]
769+
"errmsg": "Replication is being shut down"
770770
}
771771
}
772772
},
@@ -812,12 +812,12 @@
812812
"failCommands": [
813813
"insert"
814814
],
815+
"errorLabels": [
816+
"RetryableWriteError"
817+
],
815818
"writeConcernError": {
816819
"code": 11602,
817-
"errmsg": "Replication is being shut down",
818-
"errorLabels": [
819-
"RetryableWriteError"
820-
]
820+
"errmsg": "Replication is being shut down"
821821
}
822822
}
823823
},
@@ -863,12 +863,12 @@
863863
"failCommands": [
864864
"insert"
865865
],
866+
"errorLabels": [
867+
"RetryableWriteError"
868+
],
866869
"writeConcernError": {
867870
"code": 189,
868-
"errmsg": "Replication is being shut down",
869-
"errorLabels": [
870-
"RetryableWriteError"
871-
]
871+
"errmsg": "Replication is being shut down"
872872
}
873873
}
874874
},
@@ -914,12 +914,12 @@
914914
"failCommands": [
915915
"insert"
916916
],
917+
"errorLabels": [
918+
"RetryableWriteError"
919+
],
917920
"writeConcernError": {
918921
"code": 91,
919-
"errmsg": "Replication is being shut down",
920-
"errorLabels": [
921-
"RetryableWriteError"
922-
]
922+
"errmsg": "Replication is being shut down"
923923
}
924924
}
925925
},
@@ -965,12 +965,12 @@
965965
"failCommands": [
966966
"insert"
967967
],
968+
"errorLabels": [
969+
"RetryableWriteError"
970+
],
968971
"writeConcernError": {
969972
"code": 91,
970-
"errmsg": "Replication is being shut down",
971-
"errorLabels": [
972-
"RetryableWriteError"
973-
]
973+
"errmsg": "Replication is being shut down"
974974
}
975975
}
976976
},

‎source/retryable-writes/tests/legacy/insertOne-serverErrors.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -347,10 +347,10 @@ tests:
347347
mode: { times: 1 }
348348
data:
349349
failCommands: ["insert"]
350+
errorLabels: ["RetryableWriteError"]
350351
writeConcernError:
351352
code: 11600
352353
errmsg: Replication is being shut down
353-
errorLabels: ["RetryableWriteError"]
354354
operation:
355355
name: "insertOne"
356356
arguments:
@@ -370,10 +370,10 @@ tests:
370370
mode: { times: 1 }
371371
data:
372372
failCommands: ["insert"]
373+
errorLabels: ["RetryableWriteError"]
373374
writeConcernError:
374375
code: 11602
375376
errmsg: Replication is being shut down
376-
errorLabels: ["RetryableWriteError"]
377377
operation:
378378
name: "insertOne"
379379
arguments:
@@ -393,10 +393,10 @@ tests:
393393
mode: { times: 1 }
394394
data:
395395
failCommands: ["insert"]
396+
errorLabels: ["RetryableWriteError"]
396397
writeConcernError:
397398
code: 189
398399
errmsg: Replication is being shut down
399-
errorLabels: ["RetryableWriteError"]
400400
operation:
401401
name: "insertOne"
402402
arguments:
@@ -416,10 +416,10 @@ tests:
416416
mode: { times: 1 }
417417
data:
418418
failCommands: ["insert"]
419+
errorLabels: ["RetryableWriteError"]
419420
writeConcernError:
420421
code: 91
421422
errmsg: Replication is being shut down
422-
errorLabels: ["RetryableWriteError"]
423423
operation:
424424
name: "insertOne"
425425
arguments:
@@ -439,10 +439,10 @@ tests:
439439
mode: { times: 2 }
440440
data:
441441
failCommands: ["insert"]
442+
errorLabels: ["RetryableWriteError"]
442443
writeConcernError:
443444
code: 91
444445
errmsg: Replication is being shut down
445-
errorLabels: ["RetryableWriteError"]
446446
operation:
447447
name: "insertOne"
448448
arguments:

‎source/retryable-writes/tests/legacy/replaceOne-serverErrors.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,12 @@
8585
"failCommands": [
8686
"update"
8787
],
88+
"errorLabels": [
89+
"RetryableWriteError"
90+
],
8891
"writeConcernError": {
8992
"code": 91,
90-
"errmsg": "Replication is being shut down",
91-
"errorLabels": [
92-
"RetryableWriteError"
93-
]
93+
"errmsg": "Replication is being shut down"
9494
}
9595
}
9696
},

‎source/retryable-writes/tests/legacy/replaceOne-serverErrors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ tests:
4141
mode: { times: 1 }
4242
data:
4343
failCommands: ["update"]
44+
errorLabels: ["RetryableWriteError"]
4445
writeConcernError:
4546
code: 91
4647
errmsg: Replication is being shut down
47-
errorLabels: ["RetryableWriteError"]
4848
operation:
4949
name: "replaceOne"
5050
arguments:

0 commit comments

Comments
 (0)