fix: safely encode dynamic URL path segments#35
Merged
Conversation
4 tasks
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
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.
closes #20
Task Summary
Safely encode dynamic URL path segments before they are interpolated into service endpoint paths.
Background / Context
Service methods were building paths with string interpolation, such as
/guilds/${guildId}/rolesand/guilds/${guildId}/members/${walletAddress}/roles. If a dynamic value contained reserved URL characters (like/,#, or spaces), the request path could become malformed. This PR ensures all dynamic path values are encoded withencodeURIComponentbefore being inserted into endpoint paths, while keeping query parameter handling separate and preserving existing input validation.Changes Made
encodePathSegmenthelper utility insrc/utils/formatting.ts.RolesServiceandGuildsServiceto safely encodeguildIdandwalletAddressparameters.tests/services.test.tsto assert that reserved characters like/and spaces are accurately encoded (e.g.%2Fand%20).Acceptance Criteria Met
guildIdvalues used in path segments are URL-encodedwalletAddressvalues used in path segments are URL-encoded/,#, or spaceTesting Requirements
pnpm typecheckpassespnpm lintpassespnpm test:runpasses — new behaviour has test coveragepnpm buildsucceedsSemver Impact
Patch