Modify API for SimpleHttpClient.get_json and update usages.

Previously, this would only return the HTTP body as JSON, and discard other
response information (e.g. the HTTP response code). This has now been changed
to throw a CodeMessageException on a non-2xx response, with the response code
and body, which can then be parsed as JSON.

Affected modules include:
 - Registration/Login (when using an email for IS auth)

synapse/handlers/login.py

@@ -16,12 +16,13 @@
 from twisted.internet import defer
 
 from ._base import BaseHandler
-from synapse.api.errors import LoginError, Codes
+from synapse.api.errors import LoginError, Codes, CodeMessageException
 from synapse.http.client import SimpleHttpClient
 from synapse.util.emailutils import EmailException
 import synapse.util.emailutils as emailutils
 
 import bcrypt
+import json
 import logging
 
 logger = logging.getLogger(__name__)
@@ -96,8 +97,9 @@ class LoginHandler(BaseHandler):
 
     @defer.inlineCallbacks
     def _query_email(self, email):
-        httpCli = SimpleHttpClient(self.hs)
+        http_client = SimpleHttpClient(self.hs)
-        data = yield httpCli.get_json(
+        try:
+            data = yield http_client.get_json(
                 # TODO FIXME This should be configurable.
                 # XXX: ID servers need to use HTTPS
                 "http://%s%s" % (
@@ -109,3 +111,6 @@ class LoginHandler(BaseHandler):
                 }
             )
             defer.returnValue(data)
+        except CodeMessageException as e:
+            data = json.loads(e.msg)
+            defer.returnValue(data)

synapse/handlers/register.py

@@ -18,7 +18,7 @@ from twisted.internet import defer
 
 from synapse.types import UserID
 from synapse.api.errors import (
-    SynapseError, RegistrationError, InvalidCaptchaError
+    SynapseError, RegistrationError, InvalidCaptchaError, CodeMessageException
 )
 from ._base import BaseHandler
 import synapse.util.stringutils as stringutils
@@ -28,6 +28,7 @@ from synapse.http.client import CaptchaServerHttpClient
 
 import base64
 import bcrypt
+import json
 import logging
 
 logger = logging.getLogger(__name__)
@@ -161,14 +162,17 @@ class RegistrationHandler(BaseHandler):
     def _threepid_from_creds(self, creds):
         # TODO: get this from the homeserver rather than creating a new one for
         # each request
-        httpCli = SimpleHttpClient(self.hs)
+        http_client = SimpleHttpClient(self.hs)
         # XXX: make this configurable!
         trustedIdServers = ['matrix.org:8090', 'matrix.org']
         if not creds['idServer'] in trustedIdServers:
             logger.warn('%s is not a trusted ID server: rejecting 3pid ' +
                         'credentials', creds['idServer'])
             defer.returnValue(None)
-        data = yield httpCli.get_json(
+
+        data = {}
+        try:
+            data = yield http_client.get_json(
                 # XXX: This should be HTTPS
                 "http://%s%s" % (
                     creds['idServer'],
@@ -176,6 +180,8 @@ class RegistrationHandler(BaseHandler):
                 ),
                 {'sid': creds['sid'], 'clientSecret': creds['clientSecret']}
             )
+        except CodeMessageException as e:
+            data = json.loads(e.msg)
 
         if 'medium' in data:
             defer.returnValue(data)
@@ -185,8 +191,10 @@ class RegistrationHandler(BaseHandler):
     def _bind_threepid(self, creds, mxid):
         yield
         logger.debug("binding threepid")
-        httpCli = SimpleHttpClient(self.hs)
+        http_client = SimpleHttpClient(self.hs)
-        data = yield httpCli.post_urlencoded_get_json(
+        data = None
+        try:
+            data = yield http_client.post_urlencoded_get_json(
                 # XXX: Change when ID servers are all HTTPS
                 "http://%s%s" % (
                     creds['idServer'], "/_matrix/identity/api/v1/3pid/bind"
@@ -198,6 +206,8 @@ class RegistrationHandler(BaseHandler):
                 }
             )
             logger.debug("bound threepid")
+        except CodeMessageException as e:
+            data = json.loads(e.msg)
         defer.returnValue(data)
 
     @defer.inlineCallbacks

synapse/http/client.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
+from synapse.api.errors import CodeMessageException
 from synapse.http.agent_name import AGENT_NAME
 from twisted.internet import defer, reactor
 from twisted.web.client import (
@@ -83,7 +83,7 @@ class SimpleHttpClient(object):
 
     @defer.inlineCallbacks
     def get_json(self, uri, args={}):
-        """ Get's some json from the given host and path
+        """ Gets some json from the given host and path
 
         Args:
             uri (str): The URI to request, not including query parameters
@@ -91,15 +91,11 @@ class SimpleHttpClient(object):
                 None.
                 **Note**: The value of each key is assumed to be an iterable
                 and *not* a string.
-
         Returns:
-            Deferred: Succeeds when we get *any* HTTP response.
+            Deferred: Succeeds when we get *any* 2xx HTTP response.
-
+        Raises:
-            The result of the deferred is a tuple of `(code, response)`,
+            On a non-2xx HTTP response.
-            where `response` is a dict representing the decoded JSON body.
         """
-
-        yield
         if len(args):
             query_bytes = urllib.urlencode(args, True)
             uri = "%s?%s" % (uri, query_bytes)
@@ -114,7 +110,10 @@ class SimpleHttpClient(object):
 
         body = yield readBody(response)
 
+        if 200 <= response.code < 300:
             defer.returnValue(json.loads(body))
+        else:
+            raise CodeMessageException(response.code, body)
 
 
 class CaptchaServerHttpClient(SimpleHttpClient):