Improve diagnostics on database upgrade failure (#6570)

* commit 'bca30cefe': Improve diagnostics on database upgrade failure (#6570)
matrix-org · Mar 20, 2020 · 22d45b8 · 22d45b8
2 parents 5f231e3 + bca30ce
commit 22d45b8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/changelog.d/6570.misc b/changelog.d/6570.misc
@@ -0,0 +1 @@
+Improve diagnostics on database upgrade failure.
diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py
@@ -342,13 +342,8 @@ def setup(config_options):
         hs.setup()
     except IncorrectDatabaseSetup as e:
         quit_with_error(str(e))
-    except UpgradeDatabaseException:
-        sys.stderr.write(
-            "\nFailed to upgrade database.\n"
-            "Have you checked for version specific instructions in"
-            " UPGRADES.rst?\n"
-        )
-        sys.exit(1)
+    except UpgradeDatabaseException as e:
+        quit_with_error("Failed to upgrade database: %s" % (e,))
 
     hs.setup_master()
 

diff --git a/synapse/storage/prepare_database.py b/synapse/storage/prepare_database.py
@@ -69,7 +69,10 @@ def prepare_database(db_conn, database_engine, config, data_stores=["main"]):
                 if user_version != SCHEMA_VERSION:
                     # If we don't pass in a config file then we are expecting to
                     # have already upgraded the DB.
-                    raise UpgradeDatabaseException("Database needs to be upgraded")
+                    raise UpgradeDatabaseException(
+                        "Expected database schema version %i but got %i"
+                        % (SCHEMA_VERSION, user_version)
+                    )
             else:
                 _upgrade_existing_database(
                     cur,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Improve diagnostics on database upgrade failure.