Repository navigation
fix: percent-encode path parameters in sendRequest - #361
Closed
RaphaelFakhri wants to merge 1 commit into
Closed
RaphaelFakhri wants to merge 1 commit into
RaphaelFakhri wants to merge 1 commit into
Conversation
Path parameter values were substituted into the URL as-is, so an id containing '/', '?', '#' or '%' changed the request path or was truncated. Each value is now encoded with encodeURIComponent.
Contributor
Author
|
The failing checks are not caused by this change. The integration tests fail with |
oliverlaz
added a commit
that referenced
this pull request
Nov 13, 2026
## Summary Regenerates the API clients from the latest server-side spec (`GetStream/chat` master `7c7ffabb20`) and includes the path-param encoding fix from #361. ### New endpoints - Common: `searchAll` - Moderation: `listAgentFeedback`, `submitAgentFeedback`, `getAgentReviewStatus`, `countReviewQueue` - Moderation config versioning: `saveConfigVersion`, `listConfigVersions`, `getConfigVersion`, `publishConfigVersion` - `listImports()` now takes an optional request object (backwards compatible) ### Model changes 30 new interfaces/types. All changes to existing types are additive (widened unions or new optional fields), for example: - `ModerationEngineConfig`: `provider` gains `'stream'`, `model` gains new values, new `reasoning_effort` and `strictness` fields - `ActivitySelectorType` gains `'friends_engaged'` - Moderation action types gain `'agent_recommendation'` ### Path params - `getConfigVersion` / `publishConfigVersion` are the first endpoints with a numeric path param (`version`, `int32` in the spec). `ApiClient.sendRequest` now accepts `Record<string, string | number>` for path params. - Path param values are now percent-encoded with `encodeURIComponent` (from #361), so values containing `/`, `?`, `#` or `%` stay within one path segment. Values with `:` (e.g. feed ids) are sent as `%3A`, matching stream-py and getstream-go. - The test from #361 is moved to `__tests__/integration/path-params.test.ts`, since Vitest only collects tests from that folder, and gains a numeric-param case. Supersedes #361. ## Testing - `yarn build`, `yarn lint` and Prettier are clean - `yarn test`: 362 passed, 42 skipped --------- Co-authored-by: Raphael Fakhri <153192858+RaphaelFakhri@users.noreply.github.com>
Member
|
Hi @RaphaelFakhri, thank you for your contribution. |
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.
Summary
ApiClient.sendRequestsubstituted path parameters into the URL without encoding them. A value that contains/,?,#or%changed the request instead of identifying a resource. For example,getMessage({ id: 'a/b' })requested/messages/a/b, and an id containing#or?was cut off at that character.Each value is now encoded with
encodeURIComponentbefore it replaces its{name}token in the path template. Plain ids (letters, digits,-,_) are unchanged. Values with:, such as feed ids, go on the wire as%3A, which is howstream-py(quote(v, safe="")) andgetstream-go(url.QueryEscape) already send path parameters.Testing
__tests__/path-params.test.tsmocksfetchand checks the requested URL for plain values, reserved characters, and several path parameters in one URL. It needs no API credentials.Prettier and ESLint are clean on the changed files.