[DRIVERS-2059] Update retryable writes test documentation for failCommand failpoint Created: 16/Nov/18  Updated: 31/Mar/22

Status: Backlog
Project: Drivers
Component/s: Retryability
Fix Version/s: None

Type: Spec Change Priority: Major - P3
Reporter: Shane Harvey Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Driver Changes: Needed

 Description   

In SPEC-1071 I updated the retryable write spec tests to use the failCommand fail point but only onPrimaryTransactionalWrite is documented in the test readme.

For example this section is no longer accurate:

After each test that configures a fail point, drivers should disable the
``onPrimaryTransactionalWrite`` fail point to avoid spurious failures in
subsequent tests. The fail point may be disabled like so::
 
    db.runCommand({
        configureFailPoint: "onPrimaryTransactionalWrite",
        mode: "off"
    });

Each test needs to disable the fail point that it set which could be "failCommand" or "onPrimaryTransactionalWrite".


Generated at Thu Feb 08 08:24:37 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.