This repository was archived by the owner on Apr 26, 2024. It is now read-only.
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
The Module API docs' DemoResource crashes #10837
Description
Description
The Module API docs include an example module, which is extremely helpful for a new module developer.
However, the DemoResource's render_GET function causes a TypeError during JSON encoding and fails to return the intended response.
Steps to reproduce
- Install the DemoModule.
- I put the example code in
synapse/demo_module/__init__.py - Copy the example config verbatim into
homeserver.yaml
- I put the example code in
- Start Synapse:
$ python3 -m synapse.app.homeserver --config-path homeserver.yaml- Load the demo URL
_synapse/client/demo/hello?name=worldin a browser or use cURL/wget/etc
Expected to see the simple JSON response. Got "Processing Failed" instead.
2021-09-16 11:44:50,905 - twisted - 271 - CRITICAL - sentinel -
Traceback (most recent call last):
File "/home/user/synapse/env/lib/python3.7/site-packages/twisted/web/server.py", line 229, in process
self.render(resrc)
File "/home/user/synapse/synapse/http/site.py", line 241, in render
Request.render(self, resrc)
File "/home/user/synapse/env/lib/python3.7/site-packages/twisted/web/server.py", line 294, in render
body = resrc.render(self)
File "/home/user/synapse/env/lib/python3.7/site-packages/twisted/web/resource.py", line 263, in render
return m(request)
File "/home/user/synapse/demo_module/__init__.py", line 17, in render_GET
return json.dumps({"hello": name})
File "/usr/lib/python3.7/json/__init__.py", line 231, in dumps
return _default_encoder.encode(obj)
File "/usr/lib/python3.7/json/encoder.py", line 199, in encode
chunks = self.iterencode(o, _one_shot=True)
File "/usr/lib/python3.7/json/encoder.py", line 257, in iterencode
return _iterencode(o, 0)
File "/usr/lib/python3.7/json/encoder.py", line 179, in default
raise TypeError(f'Object of type {o.__class__.__name__} '
TypeError: Object of type bytes is not JSON serializableVersion information
- Homeserver: My own development server
If not matrix.org:
-
Version: 1.42.0
-
Install method: Git clone
- Platform: Debian 10, x86, Python 3.7.3
Proposed Fix
Since the problem seems to be with the JSON encoder failing to handle bytes, we can simply decode the string before we put it into the JSON. Also, it seems that we need to encode the JSON string back to bytes before we return.
def render_GET(self, request: Request):
name = request.args.get(b"name")[0].decode()
request.setHeader(b"Content-Type", b"application/json")
return json.dumps({"hello": name}).encode()