element-hq · clokep · Nov 9, 2023 · Nov 15, 2023 · Nov 9, 2023 · Nov 9, 2023
@@ -56,23 +56,38 @@ def set_output(key: str, value: str):
         for version in ("3.9", "3.10", "3.11", "3.12", "3.13")
     )
 
+# Run with both psycopg2 and psycopg.
 trial_postgres_tests = [
     {
         "python-version": "3.8",
         "database": "postgres",
         "postgres-version": "11",
         "extras": "all",
-    }
+    },
+    {
+        "python-version": "3.8",
+        "database": "psycopg",
+        "postgres-version": "11",
+        "extras": "all",
+    },
 ]
 
 if not IS_PR:
-    trial_postgres_tests.append(
-        {
-            "python-version": "3.13",
-            "database": "postgres",
-            "postgres-version": "17",
-            "extras": "all",
-        }
+    trial_postgres_tests.extend(
+        [
+            {
+                "python-version": "3.13",
+                "database": "postgres",
+                "postgres-version": "17",
+                "extras": "all",
+            },
+            {
+                "python-version": "3.13",
+                "database": "psycopg",
+                "postgres-version": "17",
+                "extras": "all",
+            },
+        ]
     )
 
 trial_no_extra_tests = [

@@ -374,7 +374,9 @@ jobs:
         run: until pg_isready -h localhost; do sleep 1; done
       - run: poetry run trial --jobs=6 tests
         env:
-          SYNAPSE_POSTGRES: ${{ matrix.job.database == 'postgres' || '' }}
+          # If matrix.job.database is 'psycopg' set SYNAPSE_POSTGRES to that string;
+          # otherwise if it is 'postgres' set it to true. Otherwise, empty.
+          SYNAPSE_POSTGRES: ${{ matrix.job.database == 'psycopg' && 'psycopg' || matrix.job.database == 'postgres' || '' }}
           SYNAPSE_POSTGRES_HOST: /var/run/postgresql
           SYNAPSE_POSTGRES_USER: postgres
           SYNAPSE_POSTGRES_PASSWORD: postgres
@@ -654,6 +656,9 @@ jobs:
           - arrangement: workers
             database: Postgres
 
+          - arrangement: workers
+            database: Psycopg
+
     steps:
       - name: Run actions/checkout@v4 for synapse
         uses: actions/checkout@v4
@@ -678,7 +683,7 @@ jobs:
           COMPLEMENT_DIR=`pwd`/complement synapse/scripts-dev/complement.sh -p 1 -json 2>&1 | synapse/.ci/scripts/gotestfmt
         shell: bash
         env:
-          POSTGRES: ${{ (matrix.database == 'Postgres') && 1 || '' }}
+          POSTGRES: ${{ (matrix.database == 'Postgres' || matrix.database == 'Psycopg') && matrix.database || '' }}
           WORKERS: ${{ (matrix.arrangement == 'workers') && 1 || '' }}
         name: Run Complement Tests
 

@@ -23,6 +23,18 @@ export SYNAPSE_REPORT_STATS=no
 case "$SYNAPSE_COMPLEMENT_DATABASE" in
   postgres)
     # Set postgres authentication details which will be placed in the homeserver config file
+    export POSTGRES_DRIVER=psycopg2
+    export POSTGRES_PASSWORD=somesecret
+    export POSTGRES_USER=postgres
+    export POSTGRES_HOST=localhost
+
+    # configure supervisord to start postgres
+    export START_POSTGRES=true
+    ;;
+
+  psycopg)
+    # Set postgres authentication details which will be placed in the homeserver config file
+    export POSTGRES_DRIVER=psycopg
     export POSTGRES_PASSWORD=somesecret
     export POSTGRES_USER=postgres
     export POSTGRES_HOST=localhost

@@ -57,11 +57,11 @@ listeners:
 
 {% if POSTGRES_PASSWORD %}
 database:
-  name: "psycopg2"
+  name: "{{ POSTGRES_DRIVER or "psycopg2" }}"
   args:
     user: "{{ POSTGRES_USER or "synapse" }}"
     password: "{{ POSTGRES_PASSWORD }}"
-    database: "{{ POSTGRES_DB or "synapse" }}"
+    dbname: "{{ POSTGRES_DB or "synapse" }}"
 {% if not SYNAPSE_USE_UNIX_SOCKET %}
 {# Synapse will use a default unix socket for Postgres when host/port is not specified (behavior from `psycopg2`). #}
     host: "{{ POSTGRES_HOST or "db" }}"

@@ -234,6 +234,7 @@ matrix-synapse-ldap3 = { version = ">=0.1", optional = true }
 psycopg2 = { version = ">=2.8", markers = "platform_python_implementation != 'PyPy'", optional = true }
 psycopg2cffi = { version = ">=2.8", markers = "platform_python_implementation == 'PyPy'", optional = true }
 psycopg2cffi-compat = { version = "==1.1", markers = "platform_python_implementation == 'PyPy'", optional = true }
+psycopg = { version = "^3.1", optional = true }
 pysaml2 = { version = ">=4.5.0", optional = true }
 authlib = { version = ">=0.15.1", optional = true }
 # systemd-python is necessary for logging to the systemd journal via
@@ -257,6 +258,7 @@ pyicu = { version = ">=2.10.2", optional = true }
 # twice: once here, and once in the `all` extra.
 matrix-synapse-ldap3 = ["matrix-synapse-ldap3"]
 postgres = ["psycopg2", "psycopg2cffi", "psycopg2cffi-compat"]
+psycopg = ["psycopg"]
 saml2 = ["pysaml2"]
 oidc = ["authlib"]
 # systemd-python is necessary for logging to the systemd journal via
@@ -293,7 +295,7 @@ all = [
     # matrix-synapse-ldap3
     "matrix-synapse-ldap3",
     # postgres
-    "psycopg2", "psycopg2cffi", "psycopg2cffi-compat",
+    "psycopg2", "psycopg2cffi", "psycopg2cffi-compat", "psycopg",
     # saml2
     "pysaml2",
     # oidc and jwt

@@ -246,7 +246,11 @@ if [[ -n "$WORKERS" ]]; then
   export PASS_SYNAPSE_WORKER_TYPES="$WORKER_TYPES"
 
   # Workers can only use Postgres as a database.
-  export PASS_SYNAPSE_COMPLEMENT_DATABASE=postgres
+  if [[ "$POSTGRES" = "psycopg" ]]; then
+    export PASS_SYNAPSE_COMPLEMENT_DATABASE=psycopg
+  else
+    export PASS_SYNAPSE_COMPLEMENT_DATABASE=postgres
+  fi
 
   # And provide some more configuration to complement.
 
@@ -256,7 +260,9 @@ if [[ -n "$WORKERS" ]]; then
   export COMPLEMENT_SPAWN_HS_TIMEOUT_SECS=120
 else
   export PASS_SYNAPSE_COMPLEMENT_USE_WORKERS=
-  if [[ -n "$POSTGRES" ]]; then
+  if [[ "$POSTGRES" = "psycopg" ]]; then
+    export PASS_SYNAPSE_COMPLEMENT_DATABASE=psycopg
+  elif [[ -n "$POSTGRES" ]]; then
     export PASS_SYNAPSE_COMPLEMENT_DATABASE=postgres
   else
     export PASS_SYNAPSE_COMPLEMENT_DATABASE=sqlite

@@ -1448,7 +1448,7 @@ def main() -> None:
     if "name" not in postgres_config:
         sys.stderr.write("Malformed database config: no 'name'\n")
         sys.exit(2)
-    if postgres_config["name"] != "psycopg2":
+    if postgres_config["name"] not in ("psycopg", "psycopg2"):
         sys.stderr.write("Database must use the 'psycopg2' connector.\n")
         sys.exit(3)
 

@@ -57,7 +57,7 @@ class DatabaseConnectionConfig:
     def __init__(self, name: str, db_config: dict):
         db_engine = db_config.get("name", "sqlite3")
 
-        if db_engine not in ("sqlite3", "psycopg2"):
+        if db_engine not in ("sqlite3", "psycopg2", "psycopg"):
             raise ConfigError("Unsupported database type %r" % (db_engine,))
 
         if db_engine == "sqlite3":

@@ -782,6 +782,8 @@ def create_index_psql(conn: "LoggingDatabaseConnection") -> None:
             # postgres insists on autocommit for the index
             conn.engine.attempt_to_set_autocommit(conn.conn, True)
 
+            assert isinstance(self.db_pool.engine, PostgresEngine)
+
             try:
                 c = conn.cursor()
 
@@ -795,8 +797,7 @@ def create_index_psql(conn: "LoggingDatabaseConnection") -> None:
 
                 # override the global statement timeout to avoid accidentally squashing
                 # a long-running index creation process
-                timeout_sql = "SET SESSION statement_timeout = 0"
-                c.execute(timeout_sql)
+                self.db_pool.engine.set_statement_timeout(c, 0)
 
                 sql = (
                     "CREATE %(unique)s INDEX CONCURRENTLY %(name)s"
@@ -818,11 +819,11 @@ def create_index_psql(conn: "LoggingDatabaseConnection") -> None:
                     logger.debug("[SQL] %s", sql)
                     c.execute(sql)
             finally:
-                # mypy ignore - `statement_timeout` is defined on PostgresEngine
                 # reset the global timeout to the default
-                default_timeout = self.db_pool.engine.statement_timeout  # type: ignore[attr-defined]
-                undo_timeout_sql = f"SET statement_timeout = {default_timeout}"
-                conn.cursor().execute(undo_timeout_sql)
+                if self.db_pool.engine.statement_timeout is not None:
+                    self.db_pool.engine.set_statement_timeout(
+                        conn.cursor(), self.db_pool.engine.statement_timeout
+                    )
 
                 conn.engine.attempt_to_set_autocommit(conn.conn, False)