Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add GET media/v1/config #3184

Merged
merged 18 commits into from
Aug 16, 2018
Merged

Add GET media/v1/config #3184

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
53385e8
Add GET media/v1/limits
Half-Shot May 3, 2018
3976352
size > upload_size as per spec feedback
Half-Shot May 3, 2018
f8b06fc
Make MediaLimitsResource Leafy
Half-Shot May 8, 2018
fee0450
Restructure __init__
Half-Shot May 8, 2018
c06b1cb
Update and rename limits_resource.py to config_resource.py
Half-Shot Jun 20, 2018
b1d8777
media limits => config
Half-Shot Jun 20, 2018
1d53129
upload_size => m.upload.size
Half-Shot Jun 21, 2018
0aa14e4
/limits => /config
Half-Shot Jun 21, 2018
a7f4ebb
Merge branch 'develop' into hs/upload-limits
Half-Shot Jul 9, 2018
87fe4f2
Add import for MediaConfigResource
Half-Shot Jul 9, 2018
48251dc
Create 3184.feature
Half-Shot Jul 9, 2018
3f520b2
wrapped
Half-Shot Jul 18, 2018
8cc46ed
wrap_json_request_handlering
Half-Shot Jul 27, 2018
bf13c18
linting
Half-Shot Jul 27, 2018
bf30fd8
Auth media/r0/config
Half-Shot Jul 27, 2018
46afacc
Merge remote-tracking branch 'upstream/develop' into hs/upload-limits
Half-Shot Jul 27, 2018
0f6e583
isorted this mess
Half-Shot Jul 27, 2018
b3e005d
Merge remote-tracking branch 'upstream/develop' into hs/upload-limits
Half-Shot Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/3184.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add /_media/r0/config
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this won't mean much to the average reader of the synapse changelog. You probably need to say it's a new endpoint for clients. A link to the proposal might help.

38 changes: 38 additions & 0 deletions synapse/rest/media/v1/config_resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Will Hunt <will@half-shot.uk>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from twisted.web.server import NOT_DONE_YET
from twisted.web.resource import Resource
from synapse.http.server import respond_with_json, respond_with_json_bytes, wrap_json_request_handler


class MediaConfigResource(Resource):
isLeaf = True

def __init__(self, hs):
Resource.__init__(self)
config = hs.get_config()
self.limits_dict = {
"m.upload.size": config.max_upload_size,
}

@wrap_json_request_handler
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hum; does this actually work?

the docstring on wrap_json_request_handler says:

The handler method must have a signature of "handle_foo(self, request)",
where "self" must have a "clock" attribute (and "request" must be a
SynapseRequest).

I don't think the first is true. You might need a self.clock = hs.get_clock() in the constructor.

def render_GET(self, request):
respond_with_json(request, 200, self.limits_dict, send_cors=True)
return NOT_DONE_YET
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Presumably we shouldn't be returning NOT_DONE_YET if we have actually finished the request.

@hawkowl how is this meant to work in twisted?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this is correct. Your options for returning from a render_* method are:

  • return a bytes, which twisted will then render as the body and call request.finish()
  • return NOT_DONE_YET, which skips the above two.

the implication is that if you have rendered the body and called finish() yourself, you should call NOT_DONE_YET.

Note that this is exactly what happens with a whole bunch of our handlers that look like they are asynchronous, but actually complete synchronously.

HOWEVER. There is a problem here, in that wrap_json_request_handler does important things (1: adds exception handling, though that may be moot here; 2: adds logging). So, can haz wrap_json_request_handler please?


def render_OPTIONS(self, request):
respond_with_json_bytes(request, 200, {}, send_cors=True)
return NOT_DONE_YET
3 changes: 2 additions & 1 deletion synapse/rest/media/v1/media_repository.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
from .thumbnail_resource import ThumbnailResource
from .thumbnailer import Thumbnailer
from .upload_resource import UploadResource
from .config_resource import MediaConfigResource

logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -748,7 +749,6 @@ def __init__(self, hs):
Resource.__init__(self)

media_repo = hs.get_media_repository()

self.putChild("upload", UploadResource(hs, media_repo))
self.putChild("download", DownloadResource(hs, media_repo))
self.putChild("thumbnail", ThumbnailResource(
Expand All @@ -759,3 +759,4 @@ def __init__(self, hs):
self.putChild("preview_url", PreviewUrlResource(
hs, media_repo, media_repo.media_storage,
))
self.putChild("config", MediaConfigResource(hs))