[DRIVERS-2695] Errata in pseudo code for retryable writes specification Created: 17/Aug/23 Updated: 06/Nov/23 Resolved: 19/Oct/23 |
|
| Status: | Closed |
| Project: | Drivers |
| Component/s: | CSOT |
| Fix Version/s: | None |
| Type: | Task | Priority: | Minor - P4 |
| Reporter: | Kyle Kloberdanz | Assignee: | Qingyang Hu |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | FY23Q4, neweng | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Driver Changes: | Not Needed | ||||||||
| Engineering Lead: | |
||||||||
| Start date: | |||||||||
| Description |
SummaryWhat is the problem or use case, what are we trying to achieve? Multiple errata have been discovered in the pseudo code for the retryable writes specification. 1. originalError is not defined, but it is used in multiple blocks, such as:
2. The following case is not handled in the pseudo code: - CSOT is not enabled and one retry was attempted. 3. Syntax error, specifically a missing parenthesis here:
MotivationWho is the affected end user?Who are the stakeholders? How does this affect the end user?Are they blocked? Are they annoyed? Are they confused? How likely is it that this problem or use case will occur?Main path? Edge case? This problem will only occur for driver developers who are very closely inspecting the specification, perhaps during implementation or when debugging this path in a driver. If the problem does occur, what are the consequences and how severe are they?Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete? Worst case scenario is inconsistencies in how drivers handle retryable writes due to ambiguities in the pseudo code for the specification. Is this issue urgent?Does this ticket have a required timeline? What is it? Not urgent, no timeline. Is this ticket required by a downstream team?Needed by e.g. Atlas, Shell, Compass? No Is this ticket only for tests?Does this ticket have any functional impact, or is it just test improvements? No, just the specification pseudo code. Acceptance CriteriaWhat specific requirements must be met to consider the design phase complete? The prose spec and the pseudo code spec need to logically agree with each other and syntax errors and variable initialization needs to be fixed. |
| Comments |
| Comment by Githook User [ 19/Oct/23 ] |
|
Author: {'name': 'Qingyang Hu', 'email': '103950869+qingyang-hu@users.noreply.github.com', 'username': 'qingyang-hu'}Message: |