OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Renamed /rooms to /createRoom. Removed ability to PUT raw room IDs, and removed tests which tested that. Updated cmdclient and webclient.

paul/schema_breaking_changes
Kegan Dougal 2014-08-27 11:33:56 +01:00
parent c65885e166
commit dd661769e1
6 changed files with 55 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmdclient/console.py
View File

@ -471,7 +471,7 @@ class SynapseCmd(cmd.Cmd):
room_name = args["vis"] room_name = args["vis"]
body["room_alias_name"] = room_name body["room_alias_name"] = room_name
reactor.callFromThread(self._run_and_pprint, "POST", "/rooms", body) reactor.callFromThread(self._run_and_pprint, "POST", "/createRoom", body)
def do_raw(self, line): def do_raw(self, line):
"""Directly send a JSON object: "raw <method> <path> <data> <notoken>" """Directly send a JSON object: "raw <method> <path> <data> <notoken>"

31
synapse/rest/room.py
View File

@ -34,31 +34,28 @@ class RoomCreateRestServlet(RestServlet):
# No PATTERN; we have custom dispatch rules here # No PATTERN; we have custom dispatch rules here
def register(self, http_server): def register(self, http_server):
# /rooms OR /rooms/<roomid> PATTERN = "/createRoom"
http_server.register_path("POST", register_txn_path(self, PATTERN, http_server)
client_path_pattern("/rooms$"),
self.on_POST)
http_server.register_path("PUT",
client_path_pattern(
"/rooms/(?P<room_id>[^/]*)$"),
self.on_PUT)
# define CORS for all of /rooms in RoomCreateRestServlet for simplicity # define CORS for all of /rooms in RoomCreateRestServlet for simplicity
http_server.register_path("OPTIONS", http_server.register_path("OPTIONS",
client_path_pattern("/rooms(?:/.*)?$"), client_path_pattern("/rooms(?:/.*)?$"),
self.on_OPTIONS) self.on_OPTIONS)
# define CORS for /createRoom[/txnid]
http_server.register_path("OPTIONS",
client_path_pattern("/createRoom(?:/.*)?$"),
self.on_OPTIONS)
@defer.inlineCallbacks @defer.inlineCallbacks
def on_PUT(self, request, room_id): def on_PUT(self, request, txn_id):
room_id = urllib.unquote(room_id) try:
auth_user = yield self.auth.get_user_by_req(request) defer.returnValue(self.txns.get_client_transaction(request, txn_id))
except KeyError:
pass
if not room_id: response = yield self.on_POST(request)
raise SynapseError(400, "PUT must specify a room ID")
room_config = self.get_room_config(request) self.txns.store_client_transaction(request, txn_id, response)
info = yield self.make_room(room_config, auth_user, room_id) defer.returnValue(response)
room_config.update(info)
defer.returnValue((200, info))
@defer.inlineCallbacks @defer.inlineCallbacks
def on_POST(self, request): def on_POST(self, request):

3
tests/rest/test_events.py
View File

@ -178,8 +178,7 @@ class EventStreamPermissionsTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_stream_room_permissions(self): def test_stream_room_permissions(self):
room_id = "!rid1:test" room_id = yield self.create_room_as(self.other_user,
yield self.create_room_as(room_id, self.other_user,
tok=self.other_token) tok=self.other_token)
yield self.send(room_id, tok=self.other_token) yield self.send(room_id, tok=self.other_token)

110
tests/rest/test_rooms.py
View File

@ -74,12 +74,10 @@ class RoomPermissionsTestCase(RestTestCase):
# create some rooms under the name rmcreator_id # create some rooms under the name rmcreator_id
self.uncreated_rmid = "!aa:test" self.uncreated_rmid = "!aa:test"
self.created_rmid = "!abc:test" self.created_rmid = yield self.create_room_as(self.rmcreator_id,
yield self.create_room_as(self.created_rmid, self.rmcreator_id,
is_public=False) is_public=False)
self.created_public_rmid = "!def1234ghi:test" self.created_public_rmid = yield self.create_room_as(self.rmcreator_id,
yield self.create_room_as(self.created_public_rmid, self.rmcreator_id,
is_public=True) is_public=True)
# send a message in one of the rooms # send a message in one of the rooms
@ -423,8 +421,7 @@ class RoomsMemberListTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_get_member_list(self): def test_get_member_list(self):
room_id = "!aa:test" room_id = yield self.create_room_as(self.user_id)
yield self.create_room_as(room_id, self.user_id)
(code, response) = yield self.mock_resource.trigger_get( (code, response) = yield self.mock_resource.trigger_get(
"/rooms/%s/members" % room_id) "/rooms/%s/members" % room_id)
self.assertEquals(200, code, msg=str(response)) self.assertEquals(200, code, msg=str(response))
@ -437,18 +434,16 @@ class RoomsMemberListTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_get_member_list_no_permission(self): def test_get_member_list_no_permission(self):
room_id = "!bb:test" room_id = yield self.create_room_as("@some_other_guy:red")
yield self.create_room_as(room_id, "@some_other_guy:red")
(code, response) = yield self.mock_resource.trigger_get( (code, response) = yield self.mock_resource.trigger_get(
"/rooms/%s/members" % room_id) "/rooms/%s/members" % room_id)
self.assertEquals(403, code, msg=str(response)) self.assertEquals(403, code, msg=str(response))
@defer.inlineCallbacks @defer.inlineCallbacks
def test_get_member_list_mixed_memberships(self): def test_get_member_list_mixed_memberships(self):
room_id = "!bb:test"
room_creator = "@some_other_guy:blue" room_creator = "@some_other_guy:blue"
room_id = yield self.create_room_as(room_creator)
room_path = "/rooms/%s/members" % room_id room_path = "/rooms/%s/members" % room_id
yield self.create_room_as(room_id, room_creator)
yield self.invite(room=room_id, src=room_creator, yield self.invite(room=room_id, src=room_creator,
targ=self.user_id) targ=self.user_id)
# can't see list if you're just invited. # can't see list if you're just invited.
@ -503,7 +498,8 @@ class RoomsCreateTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_post_room_no_keys(self): def test_post_room_no_keys(self):
# POST with no config keys, expect new room id # POST with no config keys, expect new room id
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger("POST",
"/createRoom",
"{}") "{}")
self.assertEquals(200, code, response) self.assertEquals(200, code, response)
self.assertTrue("room_id" in response) self.assertTrue("room_id" in response)
@ -511,7 +507,9 @@ class RoomsCreateTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_post_room_visibility_key(self): def test_post_room_visibility_key(self):
# POST with visibility config key, expect new room id # POST with visibility config key, expect new room id
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger(
"POST",
"/createRoom",
'{"visibility":"private"}') '{"visibility":"private"}')
self.assertEquals(200, code) self.assertEquals(200, code)
self.assertTrue("room_id" in response) self.assertTrue("room_id" in response)
@ -519,7 +517,9 @@ class RoomsCreateTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_post_room_custom_key(self): def test_post_room_custom_key(self):
# POST with custom config keys, expect new room id # POST with custom config keys, expect new room id
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger(
"POST",
"/createRoom",
'{"custom":"stuff"}') '{"custom":"stuff"}')
self.assertEquals(200, code) self.assertEquals(200, code)
self.assertTrue("room_id" in response) self.assertTrue("room_id" in response)
@ -527,7 +527,9 @@ class RoomsCreateTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_post_room_known_and_unknown_keys(self): def test_post_room_known_and_unknown_keys(self):
# POST with custom + known config keys, expect new room id # POST with custom + known config keys, expect new room id
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger(
"POST",
"/createRoom",
'{"visibility":"private","custom":"things"}') '{"visibility":"private","custom":"things"}')
self.assertEquals(200, code) self.assertEquals(200, code)
self.assertTrue("room_id" in response) self.assertTrue("room_id" in response)
@ -535,75 +537,18 @@ class RoomsCreateTestCase(RestTestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def test_post_room_invalid_content(self): def test_post_room_invalid_content(self):
# POST with invalid content / paths, expect 400 # POST with invalid content / paths, expect 400
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger(
"POST",
"/createRoom",
'{"visibili') '{"visibili')
self.assertEquals(400, code) self.assertEquals(400, code)
(code, response) = yield self.mock_resource.trigger("POST", "/rooms", (code, response) = yield self.mock_resource.trigger(
"POST",
"/createRoom",
'["hello"]') '["hello"]')
self.assertEquals(400, code) self.assertEquals(400, code)
@defer.inlineCallbacks
def test_put_room_no_keys(self):
# PUT with no config keys, expect new room id
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/%21aa%3Atest", "{}"
)
self.assertEquals(200, code)
self.assertTrue("room_id" in response)
@defer.inlineCallbacks
def test_put_room_visibility_key(self):
# PUT with known config keys, expect new room id
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/%21bb%3Atest", '{"visibility":"private"}'
)
self.assertEquals(200, code)
self.assertTrue("room_id" in response)
@defer.inlineCallbacks
def test_put_room_custom_key(self):
# PUT with custom config keys, expect new room id
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/%21cc%3Atest", '{"custom":"stuff"}'
)
self.assertEquals(200, code)
self.assertTrue("room_id" in response)
@defer.inlineCallbacks
def test_put_room_known_and_unknown_keys(self):
# PUT with custom + known config keys, expect new room id
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/%21dd%3Atest",
'{"visibility":"private","custom":"things"}'
)
self.assertEquals(200, code)
self.assertTrue("room_id" in response)
@defer.inlineCallbacks
def test_put_room_invalid_content(self):
# PUT with invalid content / room names, expect 400
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/ee", '{"sdf"'
)
self.assertEquals(400, code)
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/ee", '["hello"]'
)
self.assertEquals(400, code)
@defer.inlineCallbacks
def test_put_room_conflict(self):
yield self.create_room_as("!aa:test", self.user_id)
# PUT with conflicting room ID, expect 409
(code, response) = yield self.mock_resource.trigger(
"PUT", "/rooms/%21aa%3Atest", "{}"
)
self.assertEquals(409, code)
class RoomTopicTestCase(RestTestCase): class RoomTopicTestCase(RestTestCase):
""" Tests /rooms/$room_id/topic REST events. """ """ Tests /rooms/$room_id/topic REST events. """
@ -613,8 +558,6 @@ class RoomTopicTestCase(RestTestCase):
def setUp(self): def setUp(self):
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX) self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
self.auth_user_id = self.user_id self.auth_user_id = self.user_id
self.room_id = "!rid1:test"
self.path = "/rooms/%s/state/m.room.topic" % self.room_id
state_handler = Mock(spec=["handle_new_event"]) state_handler = Mock(spec=["handle_new_event"])
state_handler.handle_new_event.return_value = True state_handler.handle_new_event.return_value = True
@ -640,7 +583,8 @@ class RoomTopicTestCase(RestTestCase):
synapse.rest.room.register_servlets(hs, self.mock_resource) synapse.rest.room.register_servlets(hs, self.mock_resource)
# create the room # create the room
yield self.create_room_as(self.room_id, self.user_id) self.room_id = yield self.create_room_as(self.user_id)
self.path = "/rooms/%s/state/m.room.topic" % self.room_id
def tearDown(self): def tearDown(self):
pass pass
@ -717,7 +661,6 @@ class RoomMemberStateTestCase(RestTestCase):
def setUp(self): def setUp(self):
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX) self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
self.auth_user_id = self.user_id self.auth_user_id = self.user_id
self.room_id = "!rid1:test"
state_handler = Mock(spec=["handle_new_event"]) state_handler = Mock(spec=["handle_new_event"])
state_handler.handle_new_event.return_value = True state_handler.handle_new_event.return_value = True
@ -742,7 +685,7 @@ class RoomMemberStateTestCase(RestTestCase):
synapse.rest.room.register_servlets(hs, self.mock_resource) synapse.rest.room.register_servlets(hs, self.mock_resource)
yield self.create_room_as(self.room_id, self.user_id) self.room_id = yield self.create_room_as(self.user_id)
def tearDown(self): def tearDown(self):
pass pass
@ -843,7 +786,6 @@ class RoomMessagesTestCase(RestTestCase):
def setUp(self): def setUp(self):
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX) self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
self.auth_user_id = self.user_id self.auth_user_id = self.user_id
self.room_id = "!rid1:test"
state_handler = Mock(spec=["handle_new_event"]) state_handler = Mock(spec=["handle_new_event"])
state_handler.handle_new_event.return_value = True state_handler.handle_new_event.return_value = True
@ -868,7 +810,7 @@ class RoomMessagesTestCase(RestTestCase):
synapse.rest.room.register_servlets(hs, self.mock_resource) synapse.rest.room.register_servlets(hs, self.mock_resource)
yield self.create_room_as(self.room_id, self.user_id) self.room_id = yield self.create_room_as(self.user_id)
def tearDown(self): def tearDown(self):
pass pass

8
tests/rest/utils.py
View File

@ -24,6 +24,7 @@ from synapse.api.constants import Membership
import json import json
import time import time
class RestTestCase(unittest.TestCase): class RestTestCase(unittest.TestCase):
"""Contains extra helper functions to quickly and clearly perform a given """Contains extra helper functions to quickly and clearly perform a given
REST action, which isn't the focus of the test. REST action, which isn't the focus of the test.
@ -40,18 +41,19 @@ class RestTestCase(unittest.TestCase):
return self.auth_user_id return self.auth_user_id
@defer.inlineCallbacks @defer.inlineCallbacks
def create_room_as(self, room_id, room_creator, is_public=True, tok=None): def create_room_as(self, room_creator, is_public=True, tok=None):
temp_id = self.auth_user_id temp_id = self.auth_user_id
self.auth_user_id = room_creator self.auth_user_id = room_creator
path = "/rooms/%s" % room_id path = "/createRoom"
content = "{}" content = "{}"
if not is_public: if not is_public:
content = '{"visibility":"private"}' content = '{"visibility":"private"}'
if tok: if tok:
path = path + "?access_token=%s" % tok path = path + "?access_token=%s" % tok
(code, response) = yield self.mock_resource.trigger("PUT", path, content) (code, response) = yield self.mock_resource.trigger("POST", path, content)
self.assertEquals(200, code, msg=str(response)) self.assertEquals(200, code, msg=str(response))
self.auth_user_id = temp_id self.auth_user_id = temp_id
defer.returnValue(response["room_id"])
@defer.inlineCallbacks @defer.inlineCallbacks
def invite(self, room=None, src=None, targ=None, expect_code=200, tok=None): def invite(self, room=None, src=None, targ=None, expect_code=200, tok=None):

2
webclient/components/matrix/matrix-service.js
View File

@ -97,7 +97,7 @@ angular.module('matrixService', [])
// Create a room // Create a room
create: function(room_id, visibility) { create: function(room_id, visibility) {
// The REST path spec // The REST path spec
var path = "/rooms"; var path = "/createRoom";
return doRequest("POST", path, undefined, { return doRequest("POST", path, undefined, {
visibility: visibility, visibility: visibility,