Merge pull request #3 from matrix-org/babolivier/password-reset-templ…

…ate-unicode

Ensure the password reset template is correctly converted to binary

changelog.d/3.bugfix

@@ -0,0 +1 @@
+Fix encoding on password reset HTML responses in Python 2.

synapse/config/_base.py

@@ -16,6 +16,7 @@
 import argparse
 import errno
 import os
+from io import open as io_open
 from textwrap import dedent
 
 from six import integer_types
@@ -131,7 +132,7 @@ def ensure_directory(cls, dir_path):
     @classmethod
     def read_file(cls, file_path, config_name):
         cls.check_file(file_path, config_name)
-        with open(file_path) as file_stream:
+        with io_open(file_path, encoding="utf-8") as file_stream:
             return file_stream.read()
 
     @staticmethod

synapse/python_dependencies.py

@@ -67,7 +67,7 @@
     "pymacaroons>=0.13.0",
     "msgpack>=0.5.0",
     "phonenumbers>=8.2.0",
-    "six>=1.12",
+    "six>=1.10",
     # prometheus_client 0.4.0 changed the format of counter metrics
     # (cf https://github.com/matrix-org/synapse/issues/4001)
     "prometheus_client>=0.0.18,<0.4.0",

synapse/rest/client/v2_alpha/account_validity.py

@@ -15,8 +15,6 @@
 
 import logging
 
-from six import ensure_binary
-
 from twisted.internet import defer
 
 from synapse.api.errors import AuthError, SynapseError
@@ -65,7 +63,7 @@ def on_GET(self, request):
         request.setResponseCode(status_code)
         request.setHeader(b"Content-Type", b"text/html; charset=utf-8")
         request.setHeader(b"Content-Length", b"%d" % (len(response),))
-        request.write(ensure_binary(response))
+        request.write(response.encode("utf8"))
         finish_request(request)
         defer.returnValue(None)
 

tests/rest/client/v2_alpha/test_register.py

@@ -20,7 +20,6 @@
 import os
 
 from mock import Mock
-from six import ensure_binary
 
 import pkg_resources
 
@@ -438,7 +437,7 @@ def test_renewal_email(self):
         # Check that the HTML we're getting is the one we expect on a successful renewal.
         expected_html = self.hs.config.account_validity.account_renewed_html_content
         self.assertEqual(
-            channel.result["body"], ensure_binary(expected_html), channel.result
+            channel.result["body"], expected_html.encode("utf8"), channel.result
         )
 
         # Move 3 days forward. If the renewal failed, every authed request with
@@ -468,7 +467,7 @@ def test_renewal_invalid_token(self):
         # invalid/unknown token.
         expected_html = self.hs.config.account_validity.invalid_token_html_content
         self.assertEqual(
-            channel.result["body"], ensure_binary(expected_html), channel.result
+            channel.result["body"], expected_html.encode("utf8"), channel.result
         )
 
     def test_manual_email_send(self):