Update invokeRun*QueryRpc functions to support paths with special characters #7402
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
🦋 Changeset detectedLatest commit: 1ce5e4c 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 |
MarkDuckworth
commented
Jun 28, 2023
MarkDuckworth
commented
Jun 28, 2023
Size Report 1Affected Products
Test Logs |
…kduckworth/run-rpc-path-special-chars
…:firebase/firebase-js-sdk into markduckworth/run-rpc-path-special-chars
Size Analysis Report 1This report is too large (359,718 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 |
…pc-path-special-chars_PR7402
dconeybe
requested changes
Jun 30, 2023
egilmorez
approved these changes
Jun 30, 2023
…kduckworth/run-rpc-path-special-chars
dconeybe
approved these changes
Dec 18, 2023
…nnection implementation, because the encoding is Connection specific.
dconeybe
reviewed
Dec 19, 2023
dconeybe
reviewed
Dec 20, 2023
| * where each path segment has been encoded with | ||
| * `encodeURIComponent`. | ||
| */ | ||
| toUriEncodedString(): string { |
There was a problem hiding this comment.
IMO, toUriEncodedString() shouldn't be on ResourcePath since it's an implementation detail specific to RestConnection, especially since it's only called once in the entire SDK. Consider moving this logic into RestConnection.
There was a problem hiding this comment.
I considered that, but I felt more strongly that the structure of the path and how to URI encode the path should be the responsibility of the Path class. IMO, the connection shouldn't be responsible for knowing how to break up a path and encode its parts.
dconeybe
approved these changes
Dec 20, 2023
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
getDocs(...)(lite API) andgetCount(...)(lite API) andgetCountFromServer(...)were returning incorrect data when the query path included special characters, like "+". This PR fixes that issue.Fundamentally the issue is with special characters in the path segments when invoking
RestConnection.invokeStreamingRPC(...). If these special characters are not escaped, then the server will interpret the path different from what the client intended.For example, this unencoded path will not be treated by the server as expected by the client:
"projects/myproject/databases/(default)/documents/doc+with+plus/collection+with+plus/"
But if we encode the segments it will. This is how it would look encoded:
"projects/myproject/databases/(default)/documents/doc%2bwith%2bplus/collection%2bwith%2bplus/"