-
Notifications
You must be signed in to change notification settings - Fork 43
DOCS-15368 - Clarify UUID changes #402
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, a couple suggestions to make the implications of the change more clear.
source/upgrade.txt
Outdated
decodes UUIDs. For example, if you specify any of the ``LEGACY`` UUID | ||
representations, the driver decodes only binary objects of subtype 3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
Link to the API documentation of UuidRepresentation enum since it may not be clear what the various LEGACY UUID representations are. For example, here's the API docs for v4.0 of the driver:
http://mongodb.github.io/mongo-java-driver/4.0/apidocs/bson/org/bson/UuidRepresentation.html
Alternatively, if the intention is to present a concrete example, use the JAVA_LEGACY representation as the example.
source/upgrade.txt
Outdated
as UUIDs. If you specify the ``STANDARD`` UUID representation, the | ||
driver decodes only binary objects of subtype 4 as UUIDs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
While I read that it "strictly controls how the driver decodes UUIDs", and it may currently be implied, I think is important to explicitly call out that the prior version disregarded the setting. Perhaps something like:
"Previous versions disregarded the value of this setting setting when decoding UUIDs."
Also, I think it could be helpful to mention what would happen if they had been using the wrong encoding. Does it throw an exception and if so, what type? Users searching for the symptom could identify the issue more easily and correct the problem.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My testing may have been incomplete, but I wasn't able to get an exception thrown. Leaving as is for now.
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
(cherry picked from commit b30dc6e)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCS-15368
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/java/docsworker-xlarge/docs-15368-clarify-uuid/upgrade/
Self-Review Checklist