Fix: sort strings in UTF-8 encoded byte order with lazy encoding #8787
+546
−12
Conversation
This file contains 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
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (575,697 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
milaGGL
changed the title
🦋 Changeset detectedLatest commit: 9174b34 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This was referenced Feb 14, 2025
Closed
dconeybe
reviewed
Feb 19, 2025
ehsannas
requested changes
Feb 26, 2025
packages/firestore/src/util/misc.ts
Outdated
Comment on lines
96
to
105
| for ( | ||
| let j = 0; | ||
| j < Math.min(leftBytes.length, rightBytes.length); | ||
| j++ | ||
| ) { | ||
| const comp = primitiveComparator(leftBytes[j], rightBytes[j]); | ||
| if (comp !== 0) { | ||
| return comp; | ||
| } | ||
| } |
There was a problem hiding this comment.
IIUC we're having this loop because we can't use Buffer.from(...) in the browser (outside of Node). If leftBytes.length is not equal to rightBytes.length and the first Math.min(...) bytes do match, then this loop won't return a comparison. So the code falls through to the primitiveComparator (line 112) way more often than it should.
- can we use the
compareBlobsfunction? - if not, can you take this loop out of here and make a helper function that compares 2 Uint8Arrays byte by byte and also considers the length of them?
There was a problem hiding this comment.
we cannot import compareBlobs as it would create circular dependency due to the ByteString.
ehsannas
reviewed
Feb 27, 2025
ehsannas
reviewed
Feb 27, 2025
ehsannas
approved these changes
Mar 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Strings should be sorted in UTF-8 encoded byte order. Public document: https://cloud.google.com/firestore/docs/concepts/data-types#data_types
SDK sorts strings using built in comparator method, which sorts lexicographically, and leads to mismatch between server and sdk when special characters are present. This PR fixes the string order mismatches on document field, map key, and document key.
The previous fix added created a performance issue due to expensive UTF-8 encoding and reverted, #8774, #8778.
compareUtf8Stringsis updated to use lazy encoding instead.b/329441702