Skip to content

DRIVERS-1815 Add TransientTransactionError label to PoolClearedError #1707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2024
Merged

DRIVERS-1815 Add TransientTransactionError label to PoolClearedError #1707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/transactions/tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,12 @@ driver, use command monitoring instead.
assert len(addresses) > 1
```

3. Test that `PoolClearedError` has `TransientTransactionError` label. Since there is no simple way to trigger
`PoolClearedError`, this test should be implemented in a way that suites each driver the best.

## Changelog

- 2024-10-31: Add test for PoolClearedError.
- 2024-02-15: Migrated from reStructuredText to Markdown.
- 2024-02-07: Converted legacy transaction tests to unified format and moved the legacy test format docs to a separate
file.
18 changes: 10 additions & 8 deletions source/transactions/transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ string error labels. Drivers may also add error labels to errors that they retur

#### Transient Transaction Error

Any command or network error that includes the "TransientTransactionError" error label in the "errorLabels" field.
Any command, network, or driver error that includes the "TransientTransactionError" error label in the "errorLabels"
field.

### **Naming variations**

Expand Down Expand Up @@ -673,12 +674,13 @@ string error labels.

### Transient Transaction Error

Any command error that includes the "TransientTransactionError" error label in the "errorLabels" field. Any network
error or server selection error encountered running any command besides commitTransaction in a transaction. In the case
of command errors, the server adds the label; in the case of network errors or server selection errors where the client
receives no server reply, the client MUST add the label. If a network error occurs while running the commitTransaction
command then it is not known whether the transaction committed or not, and thus the "TransientTransactionError" label
MUST NOT be added.
- Any command error that includes the "TransientTransactionError" error label in the "errorLabels" field. In the case of
command errors, the server adds the label.
- Any network error or server selection error encountered running any command besides commitTransaction in a
transaction. In the case of network errors or server selection errors where the client receives no server reply, the
client MUST add the label. If a network error occurs while running the commitTransaction command then it is not
known whether the transaction committed or not, and thus the "TransientTransactionError" label MUST NOT be added.
- `PoolClearedError`. Driver MUST add the label to this error.

#### Retrying transactions that fail with TransientTransactionError

Expand Down Expand Up @@ -1071,7 +1073,7 @@ objective of avoiding duplicate commits.

## **Changelog**

- 2024-10-28: Clarify when drivers must add TransientTransactionError label.
- 2024-10-31: Clarify when drivers must add TransientTransactionError label.

- 2024-10-28: Note read preference must always be primary in a transaction.

Expand Down
Loading