Skip to content

The Unified and Autonomous Development Platform

Fix issue #1000 - Restore database with backup data in case of a failed upgrade

Robin Shen1dc9cb415b2b
diff --git a/server-core/src/main/java/io/onedev/server/commandhandler/CleanDatabase.java b/server-core/src/main/java/io/onedev/server/commandhandler/CleanDatabase.java
index 87722b800f..2a8d3a08a7 100644
--- a/server-core/src/main/java/io/onedev/server/commandhandler/CleanDatabase.java
+++ b/server-core/src/main/java/io/onedev/server/commandhandler/CleanDatabase.java
@@ -49,6 +49,10 @@ public class CleanDatabase extends AbstractPlugin {
sessionFactoryManager.start();
+ // Run this in autocommit mode as some sqls in the clean script may fail
+ // when drop non-existent constraints, and we want to ignore them and
+ // continue to execute other sql statements without rolling back whole
+ // transaction
dataManager.callWithConnection(new ConnectionCallable<Void>() {
@Override
@@ -58,7 +62,7 @@ public class CleanDatabase extends AbstractPlugin {
return null;
}
- });
+ }, true);
if (hibernateConfig.isHSQLDialect()) {
try {
diff --git a/server-core/src/main/java/io/onedev/server/commandhandler/RestoreDatabase.java b/server-core/src/main/java/io/onedev/server/commandhandler/RestoreDatabase.java
index 727b4aa44e..6e490864d4 100644
--- a/server-core/src/main/java/io/onedev/server/commandhandler/RestoreDatabase.java
+++ b/server-core/src/main/java/io/onedev/server/commandhandler/RestoreDatabase.java
@@ -59,6 +59,10 @@ public class RestoreDatabase extends AbstractPlugin {
System.exit(1);
}
+ boolean validateData = true;
+ if (Bootstrap.command.getArgs().length >= 2)
+ validateData = Boolean.parseBoolean(Bootstrap.command.getArgs()[1]);
+
logger.info("Restoring database from {}...", backupFile.getAbsolutePath());
if (OneDev.isServerRunning(Bootstrap.installDir)) {
@@ -72,12 +76,12 @@ public class RestoreDatabase extends AbstractPlugin {
File dataDir = FileUtils.createTempDir("restore");
try {
FileUtils.unzip(backupFile, dataDir);
- doRestore(dataDir);
+ doRestore(dataDir, validateData);
} finally {
FileUtils.deleteDir(dataDir);
}
} else {
- doRestore(backupFile);
+ doRestore(backupFile, validateData);
}
if (hibernateConfig.isHSQLDialect()) {
@@ -92,9 +96,11 @@ public class RestoreDatabase extends AbstractPlugin {
System.exit(0);
}
- private void doRestore(File dataDir) {
+ private void doRestore(File dataDir, boolean validateData) {
dataManager.migrateData(dataDir);
- dataManager.validateData(dataDir);
+
+ if (validateData)
+ dataManager.validateData(dataDir);
dataManager.callWithConnection(new ConnectionCallable<Void>() {
@@ -117,7 +123,7 @@ public class RestoreDatabase extends AbstractPlugin {
logger.info("Importing data into database...");
dataManager.importData(dataDir);
-
+
dataManager.callWithConnection(new ConnectionCallable<Void>() {
@Override
diff --git a/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java b/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
index 5821b6bccb..79a3374c16 100644
--- a/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
+++ b/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
@@ -104,12 +104,16 @@ public class Upgrade extends AbstractPlugin {
Commandline cmdline= new Commandline(System.getProperty("java.home") + "/bin/java");
cmdline.addArgs(
"-Xmx" + Runtime.getRuntime().maxMemory()/1024/1024 + "m",
- "-XX:+IgnoreUnrecognizedVMOptions",
+ "--add-opens=java.base/sun.nio.ch=ALL-UNNAMED",
"--add-opens=java.base/java.lang=ALL-UNNAMED",
+ "--add-opens=java.base/java.lang.reflect=ALL-UNNAMED",
+ "--add-opens=java.base/java.lang.invoke=ALL-UNNAMED",
"--add-opens=java.base/java.util=ALL-UNNAMED",
"--add-opens=java.base/java.text=ALL-UNNAMED",
"--add-opens=java.desktop/java.awt.font=ALL-UNNAMED",
- "--add-opens=java.xml/com.sun.org.apache.xerces.internal.parsers=ALL-UNNAMED",
+ "--add-modules=java.se",
+ "--add-exports=java.base/jdk.internal.ref=ALL-UNNAMED",
+ "--add-opens=java.management/sun.management=ALL-UNNAMED",
"--add-opens=jdk.management/com.sun.management.internal=ALL-UNNAMED",
"-classpath", "*", bootstrapClass,
command);
@@ -155,6 +159,9 @@ public class Upgrade extends AbstractPlugin {
if (!upgradeDir.exists()) {
logger.error("Unable to find directory: {}", upgradeDir.getAbsolutePath());
System.exit(1);
+ } else if (!upgradeDir.isDirectory()) {
+ logger.error("A directory is expected: {}", upgradeDir.getAbsolutePath());
+ System.exit(1);
}
boolean isEmpty = true;
@@ -255,11 +262,12 @@ public class Upgrade extends AbstractPlugin {
}
restoreExecutables(programBackup);
- File dbBackupFile = null;
+ File dbBackupFile = new File(upgradeDir, "site/" + DB_BACKUP_DIR + "/" + timestamp + ".zip");
boolean failed = false;
+ boolean dbChanged = false;
+ boolean dbCleaned = false;
try {
if (oldDataVersion.get() != newDataVersion) {
- dbBackupFile = new File(upgradeDir, "site/" + DB_BACKUP_DIR + "/" + timestamp + ".zip");
logger.info("Backing up database as {}...", dbBackupFile.getAbsolutePath());
FileUtils.createDir(dbBackupFile.getParentFile());
@@ -281,6 +289,7 @@ public class Upgrade extends AbstractPlugin {
}).getReturnCode();
if (ret == 0) {
+ dbChanged = true;
if (HibernateConfig.isHSQLDialect(getDialect(upgradeDir))) {
FileUtils.deleteDir(new File(upgradeDir, "sampledb"), 3);
} else {
@@ -302,12 +311,15 @@ public class Upgrade extends AbstractPlugin {
}).getReturnCode();
}
+ if (ret == 0)
+ dbCleaned = true;
}
if (ret == 0) {
logger.info("Updating program files...");
updateProgramFiles(upgradeDir, oldDataVersion.get());
+ dbCleaned = false;
logger.info("Restoring database with new program...");
ret = buildCommandline(upgradeDir, "restore-db", dbBackupFile.getAbsolutePath()).execute(new LineConsumer() {
@@ -330,7 +342,6 @@ public class Upgrade extends AbstractPlugin {
logger.error("Failed to upgrade {}", upgradeDir.getAbsolutePath());
failed = true;
}
-
} else {
logger.info("Copying new program files into {}...", upgradeDir.getAbsolutePath());
updateProgramFiles(upgradeDir, oldDataVersion.get());
@@ -341,7 +352,33 @@ public class Upgrade extends AbstractPlugin {
}
if (failed) {
- logger.info("Restoring old program files due to upgrade failure...");
+ if (dbChanged && !dbCleaned) {
+ logger.info("Cleaning database with new program...");
+ try {
+ buildCommandline(upgradeDir, "clean-db").execute(new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.info(prefixUpgradeTargetLog(line));
+ }
+
+ }, new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.error(prefixUpgradeTargetLog(line));
+ }
+
+ }).checkReturnCode();
+
+ dbCleaned = true;
+ } catch (Exception e) {
+ logger.error("Error cleaning database", e);
+ }
+ }
+
+ boolean programRestored = false;
+ logger.info("Restoring old program files...");
try {
for (File child: programBackup.listFiles()) {
if (!child.getName().equals("site")) {
@@ -359,15 +396,44 @@ public class Upgrade extends AbstractPlugin {
FileUtils.createDir(new File(upgradeDir, "site/assets/root"));
restoreExecutables(upgradeDir);
- logger.info("Old program files restored");
FileUtils.deleteDir(programBackup);
+
+ logger.info("Old program files restored");
+ programRestored = true;
} catch (Exception e) {
logger.error("Error restoring old program files", e);
logger.warn("Please restore manually from \"{}\"", programBackup.getAbsolutePath());
}
- if (dbBackupFile != null) {
- logger.warn("The database might be in inconsistent state due to upgrade failure. In that case, "
- + "you need to restore the database by first cleaning it, and then running below command:");
+
+ if (programRestored && dbChanged && dbCleaned) {
+ logger.info("Restoring old database...");
+ try {
+ buildCommandline(upgradeDir, "restore-db", dbBackupFile.getAbsolutePath(), "false").execute(new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.info(prefixUpgradeTargetLog(line));
+ }
+
+ }, new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.error(prefixUpgradeTargetLog(line));
+ }
+
+ }).checkReturnCode();
+
+ logger.info("Old database restored");
+ dbChanged = false;
+ } catch (Exception e) {
+ logger.error("Error restoring old database", e);
+ }
+ }
+
+ logger.error("!!!!!!!!! Failed to upgrade {} !!!!!!!!!!!", upgradeDir.getAbsolutePath());
+ if (dbChanged) {
+ logger.warn("OneDev is unable to restore old database, please do it manually by first resetting it (delete and create), and then running below command:");
if (SystemUtils.IS_OS_WINDOWS) {
logger.info(upgradeDir.getAbsolutePath() + File.separator + "bin" + File.separator + "restore-db.bat " + dbBackupFile.getAbsolutePath());
} else {
@@ -376,7 +442,7 @@ public class Upgrade extends AbstractPlugin {
}
System.exit(1);
} else {
- logger.info("Successfully upgraded {}", upgradeDir.getAbsolutePath());
+ logger.info("********** Successfully upgraded {} **********", upgradeDir.getAbsolutePath());
if (oldDataVersion.get() <= 5) {
logger.warn("\n"
@@ -392,7 +458,7 @@ public class Upgrade extends AbstractPlugin {
System.exit(0);
}
} else {
- logger.info("Successfully checked {}", upgradeDir.getAbsolutePath());
+ logger.info("*********** Successfully checked {} ************", upgradeDir.getAbsolutePath());
System.exit(0);
}
} else {
@@ -407,10 +473,10 @@ public class Upgrade extends AbstractPlugin {
FileUtils.copyDirectory(Bootstrap.installDir, upgradeDir);
FileUtils.cleanDir(new File(upgradeDir, "logs"));
restoreExecutables(upgradeDir);
- logger.info("Successfully populated {}", upgradeDir.getAbsolutePath());
+ logger.info("*********** Successfully populated {} ************", upgradeDir.getAbsolutePath());
System.exit(0);
} catch (Exception e) {
- logger.error("Error populating " + upgradeDir.getAbsolutePath(), e);
+ logger.error("!!!!!!! Error populating " + upgradeDir.getAbsolutePath() + " !!!!!!!!", e);
FileUtils.cleanDir(upgradeDir);
System.exit(1);
}
diff --git a/server-core/src/main/java/io/onedev/server/persistence/DataManager.java b/server-core/src/main/java/io/onedev/server/persistence/DataManager.java
index ab06b525fa..a0e52da357 100644
--- a/server-core/src/main/java/io/onedev/server/persistence/DataManager.java
+++ b/server-core/src/main/java/io/onedev/server/persistence/DataManager.java
@@ -42,6 +42,8 @@ public interface DataManager {
String getColumnName(String fieldName);
+ <T> T callWithConnection(ConnectionCallable<T> callable, boolean autoCommit);
+
<T> T callWithConnection(ConnectionCallable<T> callable);
}
diff --git a/server-core/src/main/java/io/onedev/server/persistence/DefaultDataManager.java b/server-core/src/main/java/io/onedev/server/persistence/DefaultDataManager.java
index e93eb6aa8d..6873ef1d93 100644
--- a/server-core/src/main/java/io/onedev/server/persistence/DefaultDataManager.java
+++ b/server-core/src/main/java/io/onedev/server/persistence/DefaultDataManager.java
@@ -188,23 +188,33 @@ public class DefaultDataManager implements DataManager, Serializable {
}
@Override
- public <T> T callWithConnection(ConnectionCallable<T> callable) {
+ public <T> T callWithConnection(ConnectionCallable<T> callable, boolean autoCommit) {
try (Connection conn = openConnection()) {
- conn.setAutoCommit(false);
- conn.setTransactionIsolation(Connection.TRANSACTION_READ_COMMITTED);
- try {
- T result = callable.call(conn);
- conn.commit();
- return result;
- } catch (Exception e) {
- conn.rollback();
- throw ExceptionUtils.unchecked(e);
+ if (autoCommit) {
+ conn.setAutoCommit(true);
+ return callable.call(conn);
+ } else {
+ conn.setAutoCommit(false);
+ conn.setTransactionIsolation(Connection.TRANSACTION_READ_COMMITTED);
+ try {
+ T result = callable.call(conn);
+ conn.commit();
+ return result;
+ } catch (Exception e) {
+ conn.rollback();
+ throw ExceptionUtils.unchecked(e);
+ }
}
} catch (SQLException e) {
throw new RuntimeException(e);
}
}
+ @Override
+ public <T> T callWithConnection(ConnectionCallable<T> callable) {
+ return callWithConnection(callable, false);
+ }
+
private Metadata getMetadata() {
return sessionFactoryManager.getMetadata();
}
@@ -215,7 +225,10 @@ public class DefaultDataManager implements DataManager, Serializable {
try {
stmt.execute(sql);
} catch (Exception e) {
- logger.error("Error executing sql: " + sql, e);
+ if (sql.contains(" drop ") && e.getMessage() != null)
+ logger.warn(e.getMessage());
+ else
+ logger.error("Error executing sql: " + sql, e);
if (failOnError)
throw e;
}