Fix bug for encoding filter_properties query parameter. #402
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
parulbaweja
force-pushed
the
parul--filter-properties-decode-encode
branch
2 times, most recently
from
39a3656 to
5be2877
Compare
parulbaweja
force-pushed
the
parul--filter-properties-decode-encode
branch
from
5be2877 to
7dfc885
Compare
ronovan
approved these changes
May 1, 2023
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.
Problem:
filter_propertiesis a query parameter, which gets URI encoded when a request is made with the JS SDK. A bug report came in that when querying for a specific property in the Query Database endpoint, an error was occurring stating that the collection schema was invalid.When you retrieve a database, the response already includes URI-encoded IDs for properties. This problem occurred because our JS SDK was further encoding the ID. For example:
U:C<was returned in thenotion.databases.retrieve()call asU%3AC%3C(in the JS SDK)U%3AC%3Cis passed tonotion.databases.query()(the JS SDK) which was getting encoded once again toU%253AC%253CU%253AC%253Cbut couldn't find it & returned an error.This PR fixes the JS SDK to not further encode an already encoded
filter_propertiesquery param ID. In this PR, we take the approach of decoding, passing the URL tofetch, so thatfetchcan encode subsequently. This complements Notion API's handling as well, so that a developer can copy/paste or include a property ID directly in a URL.Note: this is isolated to endpoints that have query parameters with array types (currently, this is only
filter_properties). Other query parameters, likepage_sizefor retrieving a page property item are not impacted (I tested retrieve page property item with this change ✅ )