Skip to content
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

Jump to bottom

DRIVERS-2870 Fix content of retryable-writes-test readme #1590

Merged
merged 18 commits into from
May 31, 2024
Merged

DRIVERS-2870 Fix content of retryable-writes-test readme #1590

merged 18 commits into from
May 31, 2024

Conversation

blink1073
Copy link
Member

Please complete the following before merging:

  • Update changelog.
  • Make sure there are generated JSON files from the YAML test files.
  • Test changes in at least one language driver.
  • Test these changes against all server versions and topologies (including standalone, replica set, sharded
    clusters, and serverless).

@blink1073 blink1073 requested a review from jmikola May 30, 2024 15:12
@blink1073 blink1073 requested a review from a team as a code owner May 30, 2024 15:12
jmikola
jmikola reviewed May 30, 2024
View reviewed changes
source/retryable-writes/tests/README.md Outdated
@@ -71,7 +71,7 @@ Drivers should also assert that command documents are properly constructed with
on whether the write operation is supported.
[Command Logging and Monitoring](../../command-logging-and-monitoring/command-logging-and-monitoring.rst) may be used to
check for the presence of a `txnNumber` field in the command document. Note that command documents may always include an
`lsid` field per the [Driver Session](../../sessions/driver-sessions.md) specification.
`lsid` field per the [Driver Session](../../sessions/driver-sessions.rst) specification.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The session spec was converted in c6349d1. Shouldn't this remain as .md?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

source/retryable-writes/tests/README.md Outdated Show resolved Hide resolved
source/retryable-writes/tests/README.md Outdated
`serverStatus` response.
> [!NOTE]
> Drivers that rely on `serverStatus` to determine the storage engine in use MAY skip this test for sharded clusters,
> since `mongos` does not report this information in its `serverStatus` response.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These admonitions don't render within other elements, so I think this would be better written as a basic paragraph with no "Note" lead-in. Rendering issues aside, I think that makes more sense since the paragraph is providing direction for the test implementation by use of "MAY".

See this discussion and/or this test file for more info on rendering issues.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're left-aligned now.

source/retryable-writes/tests/README.md Outdated Show resolved Hide resolved
@blink1073 blink1073 requested a review from a team as a code owner May 30, 2024 21:28
@blink1073 blink1073 requested review from dariakp and jmikola and removed request for a team and dariakp May 30, 2024 21:28
@blink1073
Copy link
Member Author

Argh, there is something about this file that mdformat doesn't like, I'll keep trying...

Error: Could not format
"/home/runner/work/specifications/specifications/source/retryable-writes/tests/README.md".

The formatted Markdown renders to different HTML than the input Markdown. This
is likely a bug in mdformat. Please create an issue report here, including the
input Markdown: [https://github.com/executablebooks/mdformat/issues](https://github.com/executablebooks/mdformat/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)

@blink1073 blink1073 requested a review from a team as a code owner May 30, 2024 21:35
@blink1073 blink1073 requested review from a team as code owners May 30, 2024 21:47
@blink1073 blink1073 requested review from durran and stIncMale and removed request for a team May 30, 2024 21:47
@blink1073
Copy link
Member Author

The JSON failure is unrelated (and incorrect). The problem was that the admonition needed to be alone on its line...

@stIncMale
Copy link
Member

I am no longer an SDAM spec maintainer. I have removed myself from https://github.com/orgs/mongodb/teams/dbx-spec-owners-sdam, it wasn't updated when the maintainers changed.

@stIncMale stIncMale removed their request for review May 30, 2024 22:14
@blink1073 blink1073 removed request for a team and durran May 31, 2024 00:53
@blink1073 blink1073 requested a review from jmikola May 31, 2024 14:47
@blink1073 blink1073 requested a review from jmikola May 31, 2024 16:04
jmikola
jmikola approved these changes May 31, 2024
View reviewed changes
Copy link
Member

@jmikola jmikola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with my last commit to add a missing step to the fifth prose test.

@blink1073
Copy link
Member Author

Thanks for the help!

@blink1073 blink1073 merged commit 56a2d83 into mongodb:master May 31, 2024
3 checks passed
@blink1073 blink1073 deleted the DRIVERS-2870-fix-retryable-writes-test-readme branch May 31, 2024 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmikola jmikola jmikola approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@blink1073 @stIncMale @jmikola