docs(NewWithTime): note 4-byte timestamp can't hold post-2106 times#116
Open
c-tonneslan wants to merge 1 commit into
Open
docs(NewWithTime): note 4-byte timestamp can't hold post-2106 times#116c-tonneslan wants to merge 1 commit into
c-tonneslan wants to merge 1 commit into
Conversation
The xid format reserves 4 bytes for the timestamp, so any time whose Unix seconds don't fit in a uint32 (anything before 1970 or after 2106-02-07 06:28:15 UTC) silently wraps when encoded. The current NewWithTime godoc doesn't mention this, so callers who feed in arbitrary user-supplied times can quietly end up with IDs whose Time() returns nonsense. Document the bounds so callers know to clamp/reject themselves. For rs#107 Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
For #107.
The xid format reserves 4 bytes for the timestamp, so any time whose Unix seconds don't fit in `uint32` (anything before 1970 or after 2106-02-07 06:28:15 UTC) silently wraps when encoded. The current NewWithTime godoc doesn't mention this, so callers who feed arbitrary user-supplied times can quietly end up with IDs whose `Time()` returns 1970.
Documents the bounds so callers know to clamp/reject themselves. Not changing behaviour, since the encoding format is fixed.