Unbreak unit tests with Twisted 25.5.0 by add parsePOSTFormSubmission arg to FakeSite
#18577
Conversation
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
Twisted's `Site` exposes `_parsePOSTFormSubmission` which is accessed by `Request` during initialisation (since Twisted 25.5.0). Provide the same attribute so that tests remain compatible across Twisted versions.
Otherwise they end up overrunning Twisted’s AMP protocol message size and raising a `TooLong` error.
anoadragon453
force-pushed
the
anoa/fix_twisted_25_5_0
branch
from
6f26c31 to
b3ddde3
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -226,8 +226,7 @@ | |||
| isLeaf = True | |||
|
|
|||
| def render(self, request: SynapseRequest) -> bytes: | |||
| # Type-ignore: mypy thinks request.path is Optional[Any], not bytes. | |||
| return request.path # type: ignore[return-value] | |||
| return request.path | |||
Check warning
Code scanning / CodeQL
Reflected server-side cross-site scripting Medium test
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 3 days ago
To fix the issue, we need to escape the request.path value before returning it in the render method of the DummyResource class. This ensures that any potentially malicious input is properly sanitized and cannot execute as part of an HTML response. The html.escape() function from Python's standard library is suitable for this purpose, as it escapes special characters like <, >, and &.
The changes will be made in the render method of the DummyResource class in the OptionsResourceTests test case. Specifically:
- Import the
htmlmodule to use thehtml.escape()function. - Modify the
rendermethod to escaperequest.pathbefore returning it.
Suggested changeset
1
tests/test_server.py
| @@ -228,3 +228,4 @@ | ||
| def render(self, request: SynapseRequest) -> bytes: | ||
| return request.path | ||
| from html import escape | ||
| return escape(request.path.decode()).encode() | ||
|
|
Copilot is powered by AI and may make mistakes. Always verify output.
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.
Twisted's
Siteexposes_parsePOSTFormSubmissionwhich is accessed byRequestduring initialisation (since Twisted 25.5.0, https://github.com/twisted/twisted/pull/12413/files#diff-6c8252af78a4a1c3cdfd2474b7349fb479c0e0a308a8336e4ddab729f55df9baR802).Provide the same attribute so that tests remain compatible across Twisted versions.
Fixes #18565.
Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.