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

Commit 514a240

Browse files
authored
Remove unused OPTIONS handlers. (#8621)
The handling of OPTIONS requests was consolidated in #7534, but the endpoint specific handlers were not removed.
1 parent b19b63e commit 514a240

File tree

14 files changed

+2
-64
lines changed

14 files changed

+2
-64
lines changed

changelog.d/8621.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove unused OPTIONS handlers.

synapse/http/servlet.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,6 @@ class attribute containing a pre-compiled regular expression. The automatic
272272
on_PUT
273273
on_POST
274274
on_DELETE
275-
on_OPTIONS
276275
277276
Automatically handles turning CodeMessageExceptions thrown by these methods
278277
into the appropriate HTTP response.
@@ -283,7 +282,7 @@ def register(self, http_server):
283282
if hasattr(self, "PATTERNS"):
284283
patterns = self.PATTERNS
285284

286-
for method in ("GET", "PUT", "POST", "OPTIONS", "DELETE"):
285+
for method in ("GET", "PUT", "POST", "DELETE"):
287286
if hasattr(self, "on_%s" % (method,)):
288287
servlet_classname = self.__class__.__name__
289288
method_handler = getattr(self, "on_%s" % (method,))

synapse/rest/client/v1/events.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,6 @@ async def on_GET(self, request):
6767

6868
return 200, chunk
6969

70-
def on_OPTIONS(self, request):
71-
return 200, {}
72-
7370

7471
class EventRestServlet(RestServlet):
7572
PATTERNS = client_patterns("/events/(?P<event_id>[^/]*)$", v1=True)

synapse/rest/client/v1/login.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,6 @@ def on_GET(self, request: SynapseRequest):
114114

115115
return 200, {"flows": flows}
116116

117-
def on_OPTIONS(self, request: SynapseRequest):
118-
return 200, {}
119-
120117
async def on_POST(self, request: SynapseRequest):
121118
self._address_ratelimiter.ratelimit(request.getClientIP())
122119

synapse/rest/client/v1/logout.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ def __init__(self, hs):
3030
self._auth_handler = hs.get_auth_handler()
3131
self._device_handler = hs.get_device_handler()
3232

33-
def on_OPTIONS(self, request):
34-
return 200, {}
35-
3633
async def on_POST(self, request):
3734
requester = await self.auth.get_user_by_req(request, allow_expired=True)
3835

@@ -58,9 +55,6 @@ def __init__(self, hs):
5855
self._auth_handler = hs.get_auth_handler()
5956
self._device_handler = hs.get_device_handler()
6057

61-
def on_OPTIONS(self, request):
62-
return 200, {}
63-
6458
async def on_POST(self, request):
6559
requester = await self.auth.get_user_by_req(request, allow_expired=True)
6660
user_id = requester.user.to_string()

synapse/rest/client/v1/presence.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,6 @@ async def on_PUT(self, request, user_id):
8686

8787
return 200, {}
8888

89-
def on_OPTIONS(self, request):
90-
return 200, {}
91-
9289

9390
def register_servlets(hs, http_server):
9491
PresenceStatusRestServlet(hs).register(http_server)

synapse/rest/client/v1/profile.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,6 @@ async def on_PUT(self, request, user_id):
6767

6868
return 200, {}
6969

70-
def on_OPTIONS(self, request, user_id):
71-
return 200, {}
72-
7370

7471
class ProfileAvatarURLRestServlet(RestServlet):
7572
PATTERNS = client_patterns("/profile/(?P<user_id>[^/]*)/avatar_url", v1=True)
@@ -118,9 +115,6 @@ async def on_PUT(self, request, user_id):
118115

119116
return 200, {}
120117

121-
def on_OPTIONS(self, request, user_id):
122-
return 200, {}
123-
124118

125119
class ProfileRestServlet(RestServlet):
126120
PATTERNS = client_patterns("/profile/(?P<user_id>[^/]*)", v1=True)

synapse/rest/client/v1/push_rule.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,6 @@ async def on_GET(self, request, path):
155155
else:
156156
raise UnrecognizedRequestError()
157157

158-
def on_OPTIONS(self, request, path):
159-
return 200, {}
160-
161158
def notify_user(self, user_id):
162159
stream_id = self.store.get_max_push_rules_stream_id()
163160
self.notifier.on_new_event("push_rules_key", stream_id, users=[user_id])

synapse/rest/client/v1/pusher.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,6 @@ async def on_GET(self, request):
6060

6161
return 200, {"pushers": filtered_pushers}
6262

63-
def on_OPTIONS(self, _):
64-
return 200, {}
65-
6663

6764
class PushersSetRestServlet(RestServlet):
6865
PATTERNS = client_patterns("/pushers/set$", v1=True)
@@ -140,9 +137,6 @@ async def on_POST(self, request):
140137

141138
return 200, {}
142139

143-
def on_OPTIONS(self, _):
144-
return 200, {}
145-
146140

147141
class PushersRemoveRestServlet(RestServlet):
148142
"""
@@ -182,9 +176,6 @@ async def on_GET(self, request):
182176
)
183177
return None
184178

185-
def on_OPTIONS(self, _):
186-
return 200, {}
187-
188179

189180
def register_servlets(hs, http_server):
190181
PushersRestServlet(hs).register(http_server)

synapse/rest/client/v1/room.py

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,6 @@ def __init__(self, hs):
7272
def register(self, http_server):
7373
PATTERNS = "/createRoom"
7474
register_txn_path(self, PATTERNS, http_server)
75-
# define CORS for all of /rooms in RoomCreateRestServlet for simplicity
76-
http_server.register_paths(
77-
"OPTIONS",
78-
client_patterns("/rooms(?:/.*)?$", v1=True),
79-
self.on_OPTIONS,
80-
self.__class__.__name__,
81-
)
82-
# define CORS for /createRoom[/txnid]
83-
http_server.register_paths(
84-
"OPTIONS",
85-
client_patterns("/createRoom(?:/.*)?$", v1=True),
86-
self.on_OPTIONS,
87-
self.__class__.__name__,
88-
)
8975

9076
def on_PUT(self, request, txn_id):
9177
set_tag("txn_id", txn_id)
@@ -104,9 +90,6 @@ def get_room_config(self, request):
10490
user_supplied_config = parse_json_object_from_request(request)
10591
return user_supplied_config
10692

107-
def on_OPTIONS(self, request):
108-
return 200, {}
109-
11093

11194
# TODO: Needs unit testing for generic events
11295
class RoomStateEventRestServlet(TransactionRestServlet):

synapse/rest/client/v1/voip.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,6 @@ async def on_GET(self, request):
6969
},
7070
)
7171

72-
def on_OPTIONS(self, request):
73-
return 200, {}
74-
7572

7673
def register_servlets(hs, http_server):
7774
VoipRestServlet(hs).register(http_server)

synapse/rest/client/v2_alpha/account.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,6 @@ async def on_POST(self, request):
268268

269269
return 200, {}
270270

271-
def on_OPTIONS(self, _):
272-
return 200, {}
273-
274271

275272
class DeactivateAccountRestServlet(RestServlet):
276273
PATTERNS = client_patterns("/account/deactivate$")

synapse/rest/client/v2_alpha/auth.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,6 @@ async def on_POST(self, request, stagetype):
176176
respond_with_html(request, 200, html)
177177
return None
178178

179-
def on_OPTIONS(self, _):
180-
return 200, {}
181-
182179

183180
def register_servlets(hs, http_server):
184181
AuthRestServlet(hs).register(http_server)

synapse/rest/client/v2_alpha/register.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -642,9 +642,6 @@ async def on_POST(self, request):
642642

643643
return 200, return_dict
644644

645-
def on_OPTIONS(self, _):
646-
return 200, {}
647-
648645
async def _do_appservice_registration(self, username, as_token, body):
649646
user_id = await self.registration_handler.appservice_register(
650647
username, as_token

0 commit comments

Comments
 (0)