Merge pull request bisq-network#2976 from alvasw/migration_Dont_keep_…

…MigrationService_in_memory migration: Don't keep MigrationService in memory
alvasw · Nov 5, 2024 · 57fa30b · 57fa30b
2 parents 31b7f39 + e1b4e49
commit 57fa30b
Show file tree

Hide file tree

Showing 15 changed files with 93 additions and 58 deletions.
diff --git a/application/src/main/java/bisq/application/ApplicationService.java b/application/src/main/java/bisq/application/ApplicationService.java
@@ -29,6 +29,7 @@
 import bisq.common.logging.AsciiLogo;
 import bisq.common.logging.LogSetup;
 import bisq.common.util.ExceptionUtil;
+import bisq.application.migration.MigrationService;
 import bisq.i18n.Res;
 import bisq.persistence.PersistenceService;
 import com.typesafe.config.ConfigFactory;
@@ -122,6 +123,7 @@ public Config(Path baseDir,
     protected final Config config;
     @Getter
     protected final PersistenceService persistenceService;
+    private Optional<MigrationService> migrationService;
     private FileLock instanceLock;
 
     public ApplicationService(String configFileName, String[] args, Path userDataDir) {
@@ -178,6 +180,7 @@ public ApplicationService(String configFileName, String[] args, Path userDataDir
 
         String absoluteDataDirPath = dataDir.toAbsolutePath().toString();
         persistenceService = new PersistenceService(absoluteDataDirPath);
+        migrationService = Optional.of(new MigrationService(dataDir));
     }
 
     private void checkInstanceLock() {
@@ -204,7 +207,11 @@ public CompletableFuture<Boolean> readAllPersisted() {
         return persistenceService.readAllPersisted();
     }
 
-    public abstract CompletableFuture<Boolean> initialize();
+    public CompletableFuture<Boolean> initialize() {
+        CompletableFuture<Boolean> completableFuture = migrationService.orElseThrow().initialize();
+        migrationService = Optional.empty();
+        return completableFuture;
+    }
 
     public abstract CompletableFuture<Boolean> shutdown();
 

diff --git a/...evolution/migration/MigrationService.java → ...plication/migration/MigrationService.java b/...evolution/migration/MigrationService.java → ...plication/migration/MigrationService.java
@@ -1,5 +1,7 @@
-package bisq.evolution.migration;
+package bisq.application.migration;
 
+import bisq.application.migration.migrations.Migration;
+import bisq.application.migration.migrations.MigrationsForV2_1_2;
 import bisq.common.application.ApplicationVersion;
 import bisq.common.application.Service;
 import bisq.common.platform.Version;
@@ -8,6 +10,7 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
 public class MigrationService implements Service {
@@ -26,7 +29,8 @@ public CompletableFuture<Boolean> initialize() {
         Version appVersion = ApplicationVersion.getVersion();
 
         if (dataDirVersion.below(appVersion)) {
-            Migrator migrator = new Migrator(appVersion, dataDir);
+            List<Migration> allMigrations = List.of(new MigrationsForV2_1_2());
+            Migrator migrator = new Migrator(appVersion, dataDir, allMigrations);
             migrator.migrate();
         }
 

diff --git a/...va/bisq/evolution/migration/Migrator.java → .../bisq/application/migration/Migrator.java b/...va/bisq/evolution/migration/Migrator.java → .../bisq/application/migration/Migrator.java
@@ -1,10 +1,9 @@
-package bisq.evolution.migration;
+package bisq.application.migration;
 
 import bisq.common.application.ApplicationVersion;
 import bisq.common.platform.Version;
-import bisq.evolution.migration.migrations.Migration;
-import bisq.evolution.migration.migrations.MigrationFailedException;
-import bisq.evolution.migration.migrations.MigrationsForV2_1_2;
+import bisq.application.migration.migrations.Migration;
+import bisq.application.migration.migrations.MigrationFailedException;
 import lombok.extern.slf4j.Slf4j;
 
 import java.io.IOException;
@@ -18,10 +17,10 @@ public class Migrator {
     private final Path dataDir;
     private final List<Migration> allMigrations;
 
-    public Migrator(Version appVersion, Path dataDir) {
+    public Migrator(Version appVersion, Path dataDir, List<Migration> allMigrations) {
         this.appVersion = appVersion;
         this.dataDir = dataDir;
-        this.allMigrations = List.of(new MigrationsForV2_1_2());
+        this.allMigrations = allMigrations;
     }
 
     public void migrate() {

diff --git a/...ution/migration/migrations/Migration.java → ...ation/migration/migrations/Migration.java b/...ution/migration/migrations/Migration.java → ...ation/migration/migrations/Migration.java
@@ -1,4 +1,4 @@
-package bisq.evolution.migration.migrations;
+package bisq.application.migration.migrations;
 
 import bisq.common.platform.Version;
 

diff --git a/.../migrations/MigrationFailedException.java → .../migrations/MigrationFailedException.java b/.../migrations/MigrationFailedException.java → .../migrations/MigrationFailedException.java
@@ -1,6 +1,10 @@
-package bisq.evolution.migration.migrations;
+package bisq.application.migration.migrations;
 
 public class MigrationFailedException extends RuntimeException {
+    public MigrationFailedException(String message) {
+        super(message);
+    }
+
     public MigrationFailedException(Throwable cause) {
         super(cause);
     }

diff --git a/...ation/migrations/MigrationsForV2_1_2.java → ...ation/migrations/MigrationsForV2_1_2.java b/...ation/migrations/MigrationsForV2_1_2.java → ...ation/migrations/MigrationsForV2_1_2.java
@@ -1,4 +1,4 @@
-package bisq.evolution.migration.migrations;
+package bisq.application.migration.migrations;
 
 import bisq.common.file.FileUtils;
 import bisq.common.platform.OS;

diff --git a/...tion/migration/MigrationServiceTests.java → ...tion/migration/MigrationServiceTests.java b/...tion/migration/MigrationServiceTests.java → ...tion/migration/MigrationServiceTests.java
@@ -1,5 +1,6 @@
-package bisq.evolution.migration;
+package bisq.application.migration;
 
+import bisq.application.migration.MigrationService;
 import bisq.common.platform.InvalidVersionException;
 import bisq.common.platform.Version;
 import org.junit.jupiter.api.Test;

diff --git a/application/src/test/java/bisq/application/migration/MigratorTest.java b/application/src/test/java/bisq/application/migration/MigratorTest.java
@@ -0,0 +1,59 @@
+package bisq.application.migration;
+
+import bisq.application.migration.migrations.Migration;
+import bisq.application.migration.migrations.MigrationFailedException;
+import bisq.common.application.ApplicationVersion;
+import bisq.common.platform.Version;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class MigratorTest {
+    @Test
+    void migrationSuccess(@TempDir Path dataDir) throws IOException {
+        Path versionFilePath = dataDir.resolve("version");
+        Version dataDirVersion = new Version("2.1.0");
+        Files.writeString(versionFilePath, dataDirVersion.toString());
+
+        Version appVersion = ApplicationVersion.getVersion();
+        Migrator migrator = new Migrator(appVersion, dataDir, Collections.emptyList());
+
+        migrator.migrate();
+
+        String readVersion = Files.readString(dataDir.resolve("version"));
+        assertThat(readVersion).isEqualTo(appVersion.toString());
+    }
+
+    @Test
+    void migrationFailure(@TempDir Path dataDir) throws IOException {
+        Path versionFilePath = dataDir.resolve("version");
+        Version dataDirVersion = new Version("2.1.0");
+        Files.writeString(versionFilePath, dataDirVersion.toString());
+
+        Version appVersion = ApplicationVersion.getVersion();
+        var migration = new Migration() {
+            @Override
+            public void run(Path dataDir) {
+                throw new MigrationFailedException("Migration failed.");
+            }
+
+            @Override
+            public Version getVersion() {
+                return new Version("2.1.1");
+            }
+        };
+
+        Migrator migrator = new Migrator(appVersion, dataDir, List.of(migration, migration));
+        migrator.migrate();
+
+        String readVersion = Files.readString(dataDir.resolve("version"));
+        assertThat(readVersion).isEqualTo(dataDirVersion.toString());
+    }
+}
diff --git a/.../migrations/MigrationsForV2_1_2Tests.java → .../migrations/MigrationsForV2_1_2Tests.java b/.../migrations/MigrationsForV2_1_2Tests.java → .../migrations/MigrationsForV2_1_2Tests.java
@@ -1,5 +1,6 @@
-package bisq.evolution.migration.migrations;
+package bisq.application.migration.migrations;
 
+import bisq.application.migration.migrations.MigrationsForV2_1_2;
 import bisq.common.platform.Version;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.EnabledOnOs;

diff --git a/apps/desktop/desktop-app/src/main/java/bisq/desktop_app/DesktopApplicationService.java b/apps/desktop/desktop-app/src/main/java/bisq/desktop_app/DesktopApplicationService.java
@@ -244,8 +244,7 @@ private Optional<OsSpecificNotificationService> findSystemNotificationDelegate()
 
     @Override
     public CompletableFuture<Boolean> initialize() {
-        return migrationService.initialize()
-                .thenCompose(result -> memoryReportService.initialize())
+        return memoryReportService.initialize()
                 .thenCompose(result -> securityService.initialize())
                 .thenCompose(result -> {
                     setState(State.INITIALIZE_NETWORK);
@@ -338,7 +337,6 @@ public CompletableFuture<Boolean> shutdown() {
                         .orElse(CompletableFuture.completedFuture(true)))
                 .thenCompose(result -> securityService.shutdown().exceptionally(this::logError))
                 .thenCompose(result -> memoryReportService.shutdown().exceptionally(this::logError))
-                .thenCompose(result -> migrationService.shutdown().exceptionally(this::logError))
                 .orTimeout(SHUTDOWN_TIMEOUT_SEC, TimeUnit.SECONDS)
                 .handle((result, throwable) -> {
                     if (throwable == null) {

diff --git a/apps/oracle-node-app/src/main/java/bisq/oracle_node/OracleNodeApplicationService.java b/apps/oracle-node-app/src/main/java/bisq/oracle_node/OracleNodeApplicationService.java
@@ -82,8 +82,7 @@ public OracleNodeApplicationService(String[] args) {
 
     @Override
     public CompletableFuture<Boolean> initialize() {
-        return migrationService.initialize()
-                .thenCompose(result -> memoryReportService.initialize())
+        return memoryReportService.initialize()
                 .thenCompose(result -> securityService.initialize())
                 .thenCompose(result -> networkService.initialize())
                 .thenCompose(result -> identityService.initialize())
@@ -110,7 +109,6 @@ public CompletableFuture<Boolean> shutdown() {
                 .thenCompose(result -> networkService.shutdown())
                 .thenCompose(result -> securityService.shutdown())
                 .thenCompose(result -> memoryReportService.shutdown())
-                .thenCompose(result -> migrationService.shutdown())
                 .orTimeout(2, TimeUnit.MINUTES)
                 .handle((result, throwable) -> throwable == null)
                 .join());

diff --git a/apps/rest-api-app/src/main/java/bisq/rest_api/RestApiApplicationService.java b/apps/rest-api-app/src/main/java/bisq/rest_api/RestApiApplicationService.java
@@ -173,8 +173,7 @@ public RestApiApplicationService(String[] args) {
 
     @Override
     public CompletableFuture<Boolean> initialize() {
-        return migrationService.initialize()
-                .thenCompose(result -> memoryReportService.initialize())
+        return memoryReportService.initialize()
                 .thenCompose(result -> securityService.initialize())
                 .thenCompose(result -> {
                     setState(State.INITIALIZE_NETWORK);
@@ -255,7 +254,6 @@ public CompletableFuture<Boolean> shutdown() {
                         .orElse(CompletableFuture.completedFuture(true)))
                 .thenCompose(result -> securityService.shutdown())
                 .thenCompose(result -> memoryReportService.shutdown())
-                .thenCompose(result -> migrationService.shutdown())
                 .orTimeout(10, TimeUnit.SECONDS)
                 .handle((result, throwable) -> throwable == null)
                 .join());

diff --git a/apps/seed-node-app/src/main/java/bisq/seed_node/SeedNodeApplicationService.java b/apps/seed-node-app/src/main/java/bisq/seed_node/SeedNodeApplicationService.java
@@ -76,8 +76,7 @@ public SeedNodeApplicationService(String[] args) {
 
     @Override
     public CompletableFuture<Boolean> initialize() {
-        return migrationService.initialize()
-                .thenCompose(result -> memoryReportService.initialize())
+        return memoryReportService.initialize()
                 .thenCompose(result -> securityService.initialize())
                 .thenCompose(result -> networkService.initialize())
                 .thenCompose(result -> identityService.initialize())
@@ -105,7 +104,6 @@ public CompletableFuture<Boolean> shutdown() {
                 .thenCompose(result -> networkService.shutdown())
                 .thenCompose(result -> securityService.shutdown())
                 .thenCompose(result -> memoryReportService.shutdown())
-                .thenCompose(result -> migrationService.shutdown())
                 .orTimeout(10, TimeUnit.SECONDS)
                 .handle((result, throwable) -> {
                     if (throwable != null) {

diff --git a/evolution/src/test/java/bisq/evolution/migration/MigratorTest.java b/evolution/src/test/java/bisq/evolution/migration/MigratorTest.java
diff --git a/java-se/src/main/java/bisq/java_se/application/JavaSeApplicationService.java b/java-se/src/main/java/bisq/java_se/application/JavaSeApplicationService.java
@@ -21,7 +21,6 @@
 import bisq.common.facades.FacadeProvider;
 import bisq.common.platform.MemoryReportService;
 import bisq.common.platform.PlatformUtils;
-import bisq.evolution.migration.MigrationService;
 import bisq.java_se.facades.JavaSeGuavaFacade;
 import bisq.java_se.facades.JavaSeJdkFacade;
 import bisq.java_se.jvm.JvmMemoryReportService;
@@ -31,7 +30,6 @@
 @Getter
 @Slf4j
 public abstract class JavaSeApplicationService extends ApplicationService {
-    protected final MigrationService migrationService;
     protected final MemoryReportService memoryReportService;
 
     public JavaSeApplicationService(String configFileName, String[] args) {
@@ -43,7 +41,6 @@ public JavaSeApplicationService(String configFileName, String[] args) {
         FacadeProvider.setGuavaFacade(new JavaSeGuavaFacade());
         FacadeProvider.setJdkFacade(new JavaSeJdkFacade());
 
-        migrationService = new MigrationService(getConfig().getBaseDir());
         memoryReportService = new JvmMemoryReportService(getConfig().getMemoryReportIntervalSec(), getConfig().isIncludeThreadListInMemoryReport());
     }
 }