Merge pull request #9766 from matrix-org/rav/drop_py35

Require py36, Postgres 9.6, and sqlite 3.22
pull/9776/head
Richard van der Hoff 2021-04-08 19:29:03 +01:00 committed by GitHub
commit 64f4f506c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 24 additions and 111 deletions

View File

@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# this script is run by buildkite in a plain `xenial` container; it installs the # this script is run by buildkite in a plain `bionic` container; it installs the
# minimal requirements for tox and hands over to the py3-old tox environment. # minimal requirements for tox and hands over to the py3-old tox environment.
set -ex set -ex

1
changelog.d/9766.feature Normal file
View File

@ -0,0 +1 @@
Synapse now requires Python 3.6 or later. It also requires Postgres 9.6 or later or SQLite 3.22 or later.

View File

@ -18,11 +18,9 @@ import threading
from concurrent.futures import ThreadPoolExecutor from concurrent.futures import ThreadPoolExecutor
DISTS = ( DISTS = (
"debian:stretch",
"debian:buster", "debian:buster",
"debian:bullseye", "debian:bullseye",
"debian:sid", "debian:sid",
"ubuntu:xenial",
"ubuntu:bionic", "ubuntu:bionic",
"ubuntu:focal", "ubuntu:focal",
"ubuntu:groovy", "ubuntu:groovy",

View File

@ -123,7 +123,7 @@ setup(
zip_safe=False, zip_safe=False,
long_description=long_description, long_description=long_description,
long_description_content_type="text/x-rst", long_description_content_type="text/x-rst",
python_requires="~=3.5", python_requires="~=3.6",
classifiers=[ classifiers=[
"Development Status :: 5 - Production/Stable", "Development Status :: 5 - Production/Stable",
"Topic :: Communications :: Chat", "Topic :: Communications :: Chat",

View File

@ -2059,69 +2059,18 @@ def make_in_list_sql_clause(
KV = TypeVar("KV") KV = TypeVar("KV")
def make_tuple_comparison_clause( def make_tuple_comparison_clause(keys: List[Tuple[str, KV]]) -> Tuple[str, List[KV]]:
database_engine: BaseDatabaseEngine, keys: List[Tuple[str, KV]]
) -> Tuple[str, List[KV]]:
"""Returns a tuple comparison SQL clause """Returns a tuple comparison SQL clause
Depending what the SQL engine supports, builds a SQL clause that looks like either Builds a SQL clause that looks like "(a, b) > (?, ?)"
"(a, b) > (?, ?)", or "(a > ?) OR (a == ? AND b > ?)".
Args: Args:
database_engine
keys: A set of (column, value) pairs to be compared. keys: A set of (column, value) pairs to be compared.
Returns: Returns:
A tuple of SQL query and the args A tuple of SQL query and the args
""" """
if database_engine.supports_tuple_comparison: return (
return ( "(%s) > (%s)" % (",".join(k[0] for k in keys), ",".join("?" for _ in keys)),
"(%s) > (%s)" % (",".join(k[0] for k in keys), ",".join("?" for _ in keys)), [k[1] for k in keys],
[k[1] for k in keys], )
)
# we want to build a clause
# (a > ?) OR
# (a == ? AND b > ?) OR
# (a == ? AND b == ? AND c > ?)
# ...
# (a == ? AND b == ? AND ... AND z > ?)
#
# or, equivalently:
#
# (a > ? OR (a == ? AND
# (b > ? OR (b == ? AND
# ...
# (y > ? OR (y == ? AND
# z > ?
# ))
# ...
# ))
# ))
#
# which itself is equivalent to (and apparently easier for the query optimiser):
#
# (a >= ? AND (a > ? OR
# (b >= ? AND (b > ? OR
# ...
# (y >= ? AND (y > ? OR
# z > ?
# ))
# ...
# ))
# ))
#
#
clause = ""
args = [] # type: List[KV]
for k, v in keys[:-1]:
clause = clause + "(%s >= ? AND (%s > ? OR " % (k, k)
args.extend([v, v])
(k, v) = keys[-1]
clause += "%s > ?" % (k,)
args.append(v)
clause += "))" * (len(keys) - 1)
return clause, args

View File

@ -298,7 +298,6 @@ class ClientIpBackgroundUpdateStore(SQLBaseStore):
# times, which is fine. # times, which is fine.
where_clause, where_args = make_tuple_comparison_clause( where_clause, where_args = make_tuple_comparison_clause(
self.database_engine,
[("user_id", last_user_id), ("device_id", last_device_id)], [("user_id", last_user_id), ("device_id", last_device_id)],
) )

View File

@ -985,7 +985,7 @@ class DeviceBackgroundUpdateStore(SQLBaseStore):
def _txn(txn): def _txn(txn):
clause, args = make_tuple_comparison_clause( clause, args = make_tuple_comparison_clause(
self.db_pool.engine, [(x, last_row[x]) for x in KEY_COLS] [(x, last_row[x]) for x in KEY_COLS]
) )
sql = """ sql = """
SELECT stream_id, destination, user_id, device_id, MAX(ts) AS ts SELECT stream_id, destination, user_id, device_id, MAX(ts) AS ts

View File

@ -838,7 +838,6 @@ class EventsBackgroundUpdatesStore(SQLBaseStore):
# We want to do a `(topological_ordering, stream_ordering) > (?,?)` # We want to do a `(topological_ordering, stream_ordering) > (?,?)`
# comparison, but that is not supported on older SQLite versions # comparison, but that is not supported on older SQLite versions
tuple_clause, tuple_args = make_tuple_comparison_clause( tuple_clause, tuple_args = make_tuple_comparison_clause(
self.database_engine,
[ [
("events.room_id", last_room_id), ("events.room_id", last_room_id),
("topological_ordering", last_depth), ("topological_ordering", last_depth),

View File

@ -42,14 +42,6 @@ class BaseDatabaseEngine(Generic[ConnectionType], metaclass=abc.ABCMeta):
""" """
... ...
@property
@abc.abstractmethod
def supports_tuple_comparison(self) -> bool:
"""
Do we support comparing tuples, i.e. `(a, b) > (c, d)`?
"""
...
@property @property
@abc.abstractmethod @abc.abstractmethod
def supports_using_any_list(self) -> bool: def supports_using_any_list(self) -> bool:

View File

@ -47,8 +47,8 @@ class PostgresEngine(BaseDatabaseEngine):
self._version = db_conn.server_version self._version = db_conn.server_version
# Are we on a supported PostgreSQL version? # Are we on a supported PostgreSQL version?
if not allow_outdated_version and self._version < 90500: if not allow_outdated_version and self._version < 90600:
raise RuntimeError("Synapse requires PostgreSQL 9.5+ or above.") raise RuntimeError("Synapse requires PostgreSQL 9.6 or above.")
with db_conn.cursor() as txn: with db_conn.cursor() as txn:
txn.execute("SHOW SERVER_ENCODING") txn.execute("SHOW SERVER_ENCODING")
@ -129,13 +129,6 @@ class PostgresEngine(BaseDatabaseEngine):
""" """
return True return True
@property
def supports_tuple_comparison(self):
"""
Do we support comparing tuples, i.e. `(a, b) > (c, d)`?
"""
return True
@property @property
def supports_using_any_list(self): def supports_using_any_list(self):
"""Do we support using `a = ANY(?)` and passing a list""" """Do we support using `a = ANY(?)` and passing a list"""

View File

@ -56,14 +56,6 @@ class Sqlite3Engine(BaseDatabaseEngine["sqlite3.Connection"]):
""" """
return self.module.sqlite_version_info >= (3, 24, 0) return self.module.sqlite_version_info >= (3, 24, 0)
@property
def supports_tuple_comparison(self):
"""
Do we support comparing tuples, i.e. `(a, b) > (c, d)`? This requires
SQLite 3.15+.
"""
return self.module.sqlite_version_info >= (3, 15, 0)
@property @property
def supports_using_any_list(self): def supports_using_any_list(self):
"""Do we support using `a = ANY(?)` and passing a list""" """Do we support using `a = ANY(?)` and passing a list"""
@ -72,8 +64,11 @@ class Sqlite3Engine(BaseDatabaseEngine["sqlite3.Connection"]):
def check_database(self, db_conn, allow_outdated_version: bool = False): def check_database(self, db_conn, allow_outdated_version: bool = False):
if not allow_outdated_version: if not allow_outdated_version:
version = self.module.sqlite_version_info version = self.module.sqlite_version_info
if version < (3, 11, 0): # Synapse is untested against older SQLite versions, and we don't want
raise RuntimeError("Synapse requires sqlite 3.11 or above.") # to let users upgrade to a version of Synapse with broken support for their
# sqlite version, because it risks leaving them with a half-upgraded db.
if version < (3, 22, 0):
raise RuntimeError("Synapse requires sqlite 3.22 or above.")
def check_new_database(self, txn): def check_new_database(self, txn):
"""Gets called when setting up a brand new database. This allows us to """Gets called when setting up a brand new database. This allows us to

View File

@ -36,17 +36,6 @@ def _stub_db_engine(**kwargs) -> BaseDatabaseEngine:
class TupleComparisonClauseTestCase(unittest.TestCase): class TupleComparisonClauseTestCase(unittest.TestCase):
def test_native_tuple_comparison(self): def test_native_tuple_comparison(self):
db_engine = _stub_db_engine(supports_tuple_comparison=True) clause, args = make_tuple_comparison_clause([("a", 1), ("b", 2)])
clause, args = make_tuple_comparison_clause(db_engine, [("a", 1), ("b", 2)])
self.assertEqual(clause, "(a,b) > (?,?)") self.assertEqual(clause, "(a,b) > (?,?)")
self.assertEqual(args, [1, 2]) self.assertEqual(args, [1, 2])
def test_emulated_tuple_comparison(self):
db_engine = _stub_db_engine(supports_tuple_comparison=False)
clause, args = make_tuple_comparison_clause(
db_engine, [("a", 1), ("b", 2), ("c", 3)]
)
self.assertEqual(
clause, "(a >= ? AND (a > ? OR (b >= ? AND (b > ? OR c > ?))))"
)
self.assertEqual(args, [1, 1, 2, 2, 3])

14
tox.ini
View File

@ -1,5 +1,8 @@
[tox] [tox]
envlist = packaging, py35, py36, py37, py38, py39, check_codestyle, check_isort envlist = packaging, py36, py37, py38, py39, check_codestyle, check_isort
# we require tox>=2.3.2 for the fix to https://github.com/tox-dev/tox/issues/208
minversion = 2.3.2
[base] [base]
deps = deps =
@ -48,6 +51,7 @@ deps =
extras = extras =
# install the optional dependendencies for tox environments without # install the optional dependendencies for tox environments without
# '-noextras' in their name # '-noextras' in their name
# (this requires tox 3)
!noextras: all !noextras: all
test test
@ -74,8 +78,6 @@ commands =
# we use "env" rather than putting a value in `setenv` so that it is not # we use "env" rather than putting a value in `setenv` so that it is not
# inherited by other tox environments. # inherited by other tox environments.
# #
# keep this in sync with the copy in `testenv:py3-old`.
#
/usr/bin/env COVERAGE_PROCESS_START={toxinidir}/.coveragerc "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:} /usr/bin/env COVERAGE_PROCESS_START={toxinidir}/.coveragerc "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:}
# As of twisted 16.4, trial tries to import the tests as a package (previously # As of twisted 16.4, trial tries to import the tests as a package (previously
@ -121,11 +123,7 @@ commands =
# Install Synapse itself. This won't update any libraries. # Install Synapse itself. This won't update any libraries.
pip install -e ".[test]" pip install -e ".[test]"
# we have to duplicate the command from `testenv` rather than refer to it {[testenv]commands}
# as `{[testenv]commands}`, because we run on ubuntu xenial, which has
# tox 2.3.1, and https://github.com/tox-dev/tox/issues/208.
#
/usr/bin/env COVERAGE_PROCESS_START={toxinidir}/.coveragerc "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:}
[testenv:benchmark] [testenv:benchmark]
deps = deps =