new callback after each operation

flyway · Dec 10, 2020 · 47485ce · 47485ce
1 parent f53f4d4
commit 47485ce
Show file tree

Hide file tree

Showing 25 changed files with 118 additions and 49 deletions.
diff --git a/flyway-core/src/main/java/org/flywaydb/core/Flyway.java b/flyway-core/src/main/java/org/flywaydb/core/Flyway.java
@@ -18,6 +18,7 @@
 import org.flywaydb.core.api.FlywayException;
 import org.flywaydb.core.api.MigrationInfoService;
 import org.flywaydb.core.api.callback.Callback;
+import org.flywaydb.core.api.callback.Event;
 import org.flywaydb.core.api.configuration.ClassicConfiguration;
 import org.flywaydb.core.api.configuration.Configuration;
 import org.flywaydb.core.api.configuration.FluentConfiguration;
@@ -211,8 +212,12 @@ public MigrateResult execute(MigrationResolver migrationResolver,
                     }
                 }
 
-                 return new DbMigrate(database, schemaHistory, schemas[0], migrationResolver, configuration,
-                        callbackExecutor).migrate();
+                 MigrateResult result = new DbMigrate(database, schemaHistory, schemas[0], migrationResolver, configuration,
+                         callbackExecutor).migrate();
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_MIGRATE_OPERATION_FINISH, result);
+
+                return result;
             }
         }, true);
     }
@@ -246,6 +251,10 @@ public UndoResult undo() throws FlywayException {
 
 
 
+
+
+
+
     }
 
     /**
@@ -274,6 +283,8 @@ public Void execute(MigrationResolver migrationResolver, SchemaHistory schemaHis
                     throw new FlywayValidateException(validateResult.errorDetails, validateResult.getAllErrorMessages());
                 }
 
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_VALIDATE_OPERATION_FINISH, validateResult);
+
                 return null;
             }
         }, true);
@@ -299,8 +310,12 @@ public ValidateResult validateWithResult() throws FlywayException {
             public ValidateResult execute(MigrationResolver migrationResolver, SchemaHistory schemaHistory, Database database,
                                           Schema[] schemas, CallbackExecutor callbackExecutor,
                                           StatementInterceptor statementInterceptor) {
-                return doValidate(database, migrationResolver, schemaHistory, schemas, callbackExecutor,
+                ValidateResult validateResult = doValidate(database, migrationResolver, schemaHistory, schemas, callbackExecutor,
                         configuration.isIgnorePendingMigrations());
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_VALIDATE_OPERATION_FINISH, validateResult);
+
+                return validateResult;
             }
         }, true);
     }
@@ -344,7 +359,11 @@ public CleanResult clean() {
             public CleanResult execute(MigrationResolver migrationResolver, SchemaHistory schemaHistory, Database database,
                                 Schema[] schemas, CallbackExecutor callbackExecutor,
                                 StatementInterceptor statementInterceptor) {
-                return doClean(database, schemaHistory, schemas, callbackExecutor);
+                CleanResult cleanResult = doClean(database, schemaHistory, schemas, callbackExecutor);
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_CLEAN_OPERATION_FINISH, cleanResult);
+
+                return cleanResult;
             }
         }, false);
     }
@@ -362,7 +381,12 @@ public MigrationInfoService info() {
             public MigrationInfoService execute(MigrationResolver migrationResolver, SchemaHistory schemaHistory,
                                                 final Database database, final Schema[] schemas, CallbackExecutor callbackExecutor,
                                                 StatementInterceptor statementInterceptor) {
-                return new DbInfo(migrationResolver, schemaHistory, configuration, database, callbackExecutor, schemas).info();
+                MigrationInfoService migrationInfoService = new DbInfo(migrationResolver, schemaHistory, configuration, database,
+                        callbackExecutor, schemas).info();
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_INFO_OPERATION_FINISH, migrationInfoService.getInfoResult());
+
+                return migrationInfoService;
             }
         }, true);
     }
@@ -389,7 +413,11 @@ public BaselineResult execute(MigrationResolver migrationResolver,
                             "See http://flywaydb.org/documentation/migrations#the-createschemas-option-and-the-schema-history-table");
                 }
 
-                return doBaseline(schemaHistory, callbackExecutor, database);
+                BaselineResult baselineResult = doBaseline(schemaHistory, callbackExecutor, database);
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_BASELINE_OPERATION_FINISH, baselineResult);
+
+                return baselineResult;
             }
         }, false);
     }
@@ -410,7 +438,11 @@ public RepairResult repair() throws FlywayException {
             public RepairResult execute(MigrationResolver migrationResolver,
                                         SchemaHistory schemaHistory, Database database, Schema[] schemas, CallbackExecutor callbackExecutor,
                                         StatementInterceptor statementInterceptor) {
-                return new DbRepair(database, migrationResolver, schemaHistory, callbackExecutor, configuration).repair();
+                RepairResult repairResult = new DbRepair(database, migrationResolver, schemaHistory, callbackExecutor, configuration).repair();
+
+                callbackExecutor.onOperationFinishEvent(Event.AFTER_REPAIR_OPERATION_FINISH, repairResult);
+
+                return repairResult;
             }
         }, true);
     }

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/callback/Context.java b/flyway-core/src/main/java/org/flywaydb/core/api/callback/Context.java
@@ -17,6 +17,7 @@
 
 import org.flywaydb.core.api.MigrationInfo;
 import org.flywaydb.core.api.configuration.Configuration;
+import org.flywaydb.core.api.output.OperationResult;
 
 import java.sql.Connection;
 
@@ -48,4 +49,9 @@ public interface Context {
      * <p><i>Flyway Teams only</i></p>
      */
     Statement getStatement();
+
+    /**
+     * @return The OperationResult object for the finished operation. Only relevant for the AFTER_*_OPERATION_FINISH events.
+     */
+    OperationResult getOperationResult();
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/callback/Event.java b/flyway-core/src/main/java/org/flywaydb/core/api/callback/Event.java
@@ -188,7 +188,35 @@ public enum Event {
     /**
      * Fired after info has failed. This event will be fired in a separate transaction from the actual info operation.
      */
-    AFTER_INFO_ERROR("afterInfoError");
+    AFTER_INFO_ERROR("afterInfoError"),
+    /**
+     * Fired after a migrate operation has finished.
+     */
+    AFTER_MIGRATE_OPERATION_FINISH("afterMigrateOperationFinish"),
+    /**
+     * Fired after an info operation has finished.
+     */
+    AFTER_INFO_OPERATION_FINISH("afterInfoOperationFinish"),
+    /**
+     * Fired after a clean operation has finished.
+     */
+    AFTER_CLEAN_OPERATION_FINISH("afterInfoOperationFinish"),
+    /**
+     * Fired after a validate operation has finished.
+     */
+    AFTER_VALIDATE_OPERATION_FINISH("afterInfoOperationFinish"),
+    /**
+     * Fired after a validate operation has finished.
+     */
+    AFTER_UNDO_OPERATION_FINISH("afterInfoOperationFinish"),
+    /**
+     * Fired after a validate operation has finished.
+     */
+    AFTER_REPAIR_OPERATION_FINISH("afterInfoOperationFinish"),
+    /**
+     * Fired after a validate operation has finished.
+     */
+    AFTER_BASELINE_OPERATION_FINISH("afterInfoOperationFinish");
 
     private final String id;
 

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/BaselineResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/BaselineResult.java
@@ -16,7 +16,6 @@
 package org.flywaydb.core.api.output;
 
 public class BaselineResult extends OperationResultBase {
-
     public boolean successfullyBaselined;
     public String baselineVersion = null;
 
@@ -25,5 +24,4 @@ public BaselineResult(String flywayVersion, String database) {
         this.database = database;
         this.operation = "baseline";
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/CleanResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/CleanResult.java
@@ -18,7 +18,6 @@
 import java.util.ArrayList;
 
 public class CleanResult extends OperationResultBase {
-
     public ArrayList<String> schemasCleaned = new ArrayList<>();
     public ArrayList<String> schemasDropped = new ArrayList<>();
 
@@ -27,5 +26,4 @@ public CleanResult(String flywayVersion, String database) {
         this.database = database;
         this.operation = "clean";
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/CommandResultFactory.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/CommandResultFactory.java
@@ -67,19 +67,16 @@ public static MigrateResult createMigrateResult(String databaseName, Configurati
 
     public static CleanResult createCleanResult(String databaseName) {
         String flywayVersion = VersionPrinter.getVersion();
-
         return new CleanResult(flywayVersion, databaseName);
     }
 
     public static UndoResult createUndoResult(String databaseName, Configuration configuration) {
         String flywayVersion = VersionPrinter.getVersion();
-
         return new UndoResult(flywayVersion, databaseName, String.join(", ", configuration.getSchemas()));
     }
 
     public static BaselineResult createBaselineResult(String databaseName) {
         String flywayVersion = VersionPrinter.getVersion();
-
         return new BaselineResult(flywayVersion, databaseName);
     }
 
@@ -94,7 +91,6 @@ public static ValidateResult createValidateResult(String databaseName, ErrorDeta
 
     public static RepairResult createRepairResult(String databaseName) {
         String flywayVersion = VersionPrinter.getVersion();
-
         return new RepairResult(flywayVersion, databaseName);
     }
 
@@ -131,11 +127,12 @@ public static MigrateOutput createMigrateOutput(MigrationInfo migrationInfo, int
                 executionTime);
     }
 
-    public static UndoOutput createUndoOutput(ResolvedMigration migrationInfo) {
+    public static UndoOutput createUndoOutput(ResolvedMigration migrationInfo, int executionTime) {
         return new UndoOutput(
                 migrationInfo.getVersion().getVersion(),
                 migrationInfo.getDescription(),
-                migrationInfo.getPhysicalLocation() != null ? migrationInfo.getPhysicalLocation() : "");
+                migrationInfo.getPhysicalLocation() != null ? migrationInfo.getPhysicalLocation() : "",
+                executionTime);
     }
 
     public static ValidateOutput createValidateOutput(MigrationInfo migrationInfo, ErrorDetails validateError) {

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/CompositeResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/CompositeResult.java
@@ -18,7 +18,5 @@
 import java.util.LinkedList;
 
 public class CompositeResult extends OperationResultBase {
-
     public LinkedList<OperationResultBase> individualResults = new LinkedList<>();
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/ErrorOutput.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/ErrorOutput.java
@@ -24,7 +24,6 @@
 import java.nio.charset.StandardCharsets;
 
 public class ErrorOutput implements OperationResult {
-
     public static class ErrorOutputItem {
         public ErrorCode errorCode;
         public String message;

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/InfoOutput.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/InfoOutput.java
@@ -16,7 +16,6 @@
 package org.flywaydb.core.api.output;
 
 public class InfoOutput {
-
     public String category;
     public String version;
     public String description;

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/InfoResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/InfoResult.java
@@ -18,7 +18,6 @@
 import java.util.List;
 
 public class InfoResult extends OperationResultBase {
-
     public String schemaVersion;
     public String schemaName;
     public List<InfoOutput> migrations;
@@ -38,5 +37,4 @@ public InfoResult(String flywayVersion,
         this.operation = "info";
         this.allSchemasEmpty = allSchemasEmpty;
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/MigrateOutput.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/MigrateOutput.java
@@ -16,7 +16,6 @@
 package org.flywaydb.core.api.output;
 
 public class MigrateOutput {
-
     public String category;
     public String version;
     public String description;

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/MigrateResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/MigrateResult.java
@@ -19,7 +19,6 @@
 import java.util.List;
 
 public class MigrateResult extends OperationResultBase {
-
     public String initialSchemaVersion;
     public String targetSchemaVersion;
     public String schemaName;
@@ -35,5 +34,4 @@ public MigrateResult(String flywayVersion,
         this.migrations = new ArrayList<>();
         this.operation = "migrate";
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/OperationResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/OperationResult.java
@@ -15,7 +15,5 @@
  */
 package org.flywaydb.core.api.output;
 
-// This interface provides little explicit functionality, it serves to mark which classes are outputtable as JSON
-public interface OperationResult {
-
-}
+// This interface provides little explicit functionality, it serves to mark which classes are output-able as JSON
+public interface OperationResult { }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/OperationResultBase.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/OperationResultBase.java
@@ -19,7 +19,6 @@
 import java.util.List;
 
 public abstract class OperationResultBase implements OperationResult {
-
     public String flywayVersion;
     public String database;
     public List<String> warnings;
@@ -32,5 +31,4 @@ public OperationResultBase() {
     public void addWarning(String warning) {
         warnings.add(warning);
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/RepairOutput.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/RepairOutput.java
@@ -16,7 +16,6 @@
 package org.flywaydb.core.api.output;
 
 public class RepairOutput {
-
     public String version;
     public String description;
     public String filepath;
@@ -26,5 +25,4 @@ public RepairOutput(String version, String description, String filepath) {
         this.description = description;
         this.filepath = filepath;
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/RepairResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/RepairResult.java
@@ -21,7 +21,6 @@
 import java.util.List;
 
 public class RepairResult extends OperationResultBase {
-
     public List<String> repairActions;
     public List<RepairOutput> migrationsRemoved;
     public List<RepairOutput> migrationsDeleted;
@@ -42,5 +41,4 @@ public void setRepairActions(DbRepair.CompletedRepairActions completedRepairActi
         if (completedRepairActions.deletedMissingMigrations) repairActions.add(completedRepairActions.deletedMessage());
         if (completedRepairActions.alignedAppliedMigrationChecksums) repairActions.add(completedRepairActions.alignedMessage());
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/UndoOutput.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/UndoOutput.java
@@ -16,15 +16,15 @@
 package org.flywaydb.core.api.output;
 
 public class UndoOutput {
-
     public String version;
     public String description;
     public String filepath;
+    public int executionTime;
 
-    public UndoOutput(String version, String description, String filepath) {
+    public UndoOutput(String version, String description, String filepath, int executionTime) {
         this.version = version;
         this.description = description;
         this.filepath = filepath;
+        this.executionTime = executionTime;
     }
-
 }
diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/output/UndoResult.java b/flyway-core/src/main/java/org/flywaydb/core/api/output/UndoResult.java
@@ -19,7 +19,6 @@
 import java.util.List;
 
 public class UndoResult extends OperationResultBase {
-
     public String initialSchemaVersion;
     public String targetSchemaVersion;
     public String schemaName;
@@ -33,5 +32,4 @@ public UndoResult(String flywayVersion, String database, String schemaName) {
         this.undoneMigrations = new ArrayList<>();
         this.operation = "undo";
     }
-
 }