Feature: Add support for running migration in batches

src/API/Endpoints/Migrations/GetMigrations.php

@@ -2,6 +2,7 @@
 
 namespace Give\API\Endpoints\Migrations;
 
+use Give\Framework\Migrations\Contracts\BatchMigration;
 use Give\Framework\Migrations\Contracts\Migration;
 use Give\Framework\Migrations\MigrationsRegister;
 use Give\MigrationLog\Helpers\MigrationHelper;
@@ -161,6 +162,7 @@ public function handleRequest(WP_REST_Request $request)
                 'run_order' => $this->migrationHelper->getRunOrderForMigration($migration->getId()),
                 'source' => $migrationClass::source(),
                 'title' => $migrationClass::title(),
+                'isBatchMigration' => is_subclass_of($migrationClass, BatchMigration::class)
             ];
         }
 
@@ -175,6 +177,7 @@ public function handleRequest(WP_REST_Request $request)
                 'run_order' => $this->migrationHelper->getRunOrderForMigration($migration::id()),
                 'source' => $migration::source(),
                 'title' => $migration::title(),
+                'isBatchMigration' => is_subclass_of($migration, BatchMigration::class)
             ];
         }
 

src/API/Endpoints/Migrations/RunMigration.php

@@ -3,6 +3,10 @@
 namespace Give\API\Endpoints\Migrations;
 
 use Exception;
+use Give\Framework\Database\DB;
+use Give\Framework\Migrations\Contracts\BatchMigration;
+use Give\Framework\Migrations\Contracts\Migration;
+use Give\Framework\Migrations\Controllers\BatchMigrationRunner;
 use Give\Framework\Migrations\MigrationsRegister;
 use Give\MigrationLog\MigrationLogFactory;
 use Give\MigrationLog\MigrationLogStatus;
@@ -11,16 +15,13 @@
 
 /**
  * Class RunMigration
- * @package Give\API\Endpoints\Migrations
+ * @package    Give\API\Endpoints\Migrations
  *
- * @since 2.10.0
+ * @unreleased run batch migrations
+ * @since      2.10.0
  */
 class RunMigration extends Endpoint
 {
-
-    /** @var string */
-    protected $endpoint = 'migrations/run-migration';
-
     /**
      * @var MigrationsRegister
      */
@@ -34,7 +35,7 @@ class RunMigration extends Endpoint
     /**
      * RunMigration constructor.
      *
-     * @param MigrationsRegister $migrationsRegister
+     * @param MigrationsRegister  $migrationsRegister
      * @param MigrationLogFactory $migrationLogFactory
      */
     public function __construct(
@@ -52,23 +53,58 @@ public function registerRoute()
     {
         register_rest_route(
             'give-api/v2',
-            $this->endpoint,
+            'migrations/run-migration',
             [
                 [
                     'methods' => 'POST',
-                    'callback' => [$this, 'handleRequest'],
+                    'callback' => [$this, 'runMigration'],
                     'permission_callback' => [$this, 'permissionsCheck'],
                     'args' => [
                         'id' => [
-                            'validate_callback' => function ($param) {
-                                return ! empty(trim($param));
-                            },
+                            'type' => 'string',
+                            'required' => true,
                         ],
                     ],
                 ],
                 'schema' => [$this, 'getSchema'],
             ]
         );
+
+        register_rest_route(
+            'give-api/v2',
+            'migrations/run-batch-migration',
+            [
+                [
+                    'methods' => 'POST',
+                    'callback' => [$this, 'runBatchMigration'],
+                    'permission_callback' => [$this, 'permissionsCheck'],
+                    'args' => [
+                        'id' => [
+                            'type' => 'string',
+                            'required' => true,
+                        ],
+                    ],
+                ],
+            ]
+        );
+
+        register_rest_route(
+            'give-api/v2',
+            'migrations/reschedule-failed-actions',
+            [
+                [
+                    'methods' => 'POST',
+                    'callback' => [$this, 'rescheduleFailedActions'],
+                    'permission_callback' => [$this, 'permissionsCheck'],
+                    'args' => [
+                        'id' => [
+                            'type' => 'string',
+                            'required' => true,
+                        ],
+                    ],
+                ],
+            ]
+        );
     }
 
     /**
@@ -94,29 +130,31 @@ public function getSchema()
      *
      * @return WP_REST_Response
      */
-    public function handleRequest(WP_REST_Request $request)
+    public function runMigration(WP_REST_Request $request): WP_REST_Response
     {
-        global $wpdb;
         $migrationId = $request->get_param('id');
         $migrationLog = $this->migrationLogFactory->make($migrationId);
 
         // Begin transaction
-        $wpdb->query('START TRANSACTION');
+        DB::beginTransaction();
 
         try {
             $migrationClass = $this->migrationRegister->getMigration($migrationId);
+            /**
+             * @var Migration $migration
+             */
             $migration = give($migrationClass);
             $migration->run();
             // Save migration status
             $migrationLog->setStatus(MigrationLogStatus::SUCCESS);
             $migrationLog->setError(null);
             $migrationLog->save();
 
-            $wpdb->query('COMMIT');
+            DB::commit();
 
             return new WP_REST_Response(['status' => true]);
         } catch (Exception $exception) {
-            $wpdb->query('ROLLBACK');
+            DB::rollback();
 
             $migrationLog->setStatus(MigrationLogStatus::FAILED);
             $migrationLog->setError($exception);
@@ -131,4 +169,68 @@ public function handleRequest(WP_REST_Request $request)
         );
     }
 
+
+    /**
+     * Run batch migration
+     *
+     * @unreleased
+     */
+    public function runBatchMigration(WP_REST_Request $request): WP_REST_Response
+    {
+        $migrationId = $request->get_param('id');
+        $migrationClass = $this->migrationRegister->getMigration($migrationId);
+
+        if ( ! is_subclass_of($migrationClass, BatchMigration::class)) {
+            return new WP_REST_Response([
+                'status' => false,
+                'message' => 'Migration is not an instance of ' . BatchMigration::class,
+            ]);
+        }
+
+        try {
+            // We are not running migration directly,
+            // we just have to set migration status to PENDING and Migration Runner will handle it
+            $migrationLog = $this->migrationLogFactory->make($migrationId);
+            $migrationLog->setStatus(MigrationLogStatus::PENDING);
+            $migrationLog->save();
+        } catch (Exception $e) {
+            return new WP_REST_Response([
+                'status' => false,
+                'message' => $e->getMessage(),
+            ]);
+        }
+
+        return new WP_REST_Response(['status' => true]);
+    }
+
+    /**
+     * Reschedule failed actions
+     *
+     * @unreleased
+     */
+    public function rescheduleFailedActions(WP_REST_Request $request): WP_REST_Response
+    {
+        $migrationId = $request->get_param('id');
+        $migrationClass = $this->migrationRegister->getMigration($migrationId);
+        $migration = give($migrationClass);
+
+        if ( ! is_subclass_of($migration, BatchMigration::class)) {
+            return new WP_REST_Response([
+                'status' => false,
+                'message' => 'Migration is not an instance of ' . BatchMigration::class,
+            ]);
+        }
+
+        try {
+            (new BatchMigrationRunner($migration))->rescheduleFailedActions();
+        } catch (Exception $e) {
+            return new WP_REST_Response([
+                'status' => false,
+                'message' => $e->getMessage(),
+            ]);
+        }
+
+        return new WP_REST_Response(['status' => true]);
+    }
+
 }

src/Campaigns/Migrations/Donations/AddCampaignId.php

@@ -5,13 +5,13 @@
 use Give\Donations\ValueObjects\DonationMetaKeys;
 use Give\Framework\Database\DB;
 use Give\Framework\Database\Exceptions\DatabaseQueryException;
-use Give\Framework\Migrations\Contracts\Migration;
+use Give\Framework\Migrations\Contracts\BatchMigration;
 use Give\Framework\Migrations\Exceptions\DatabaseMigrationException;
 
 /**
  * @unreleased
  */
-class AddCampaignId extends Migration
+class AddCampaignId extends BatchMigration
 {
     /**
      * @inheritDoc
@@ -34,14 +34,14 @@ public static function title(): string
      */
     public static function timestamp(): string
     {
-        return strtotime('2024-11-22 00:00:00');
+        return time();
     }
 
     /**
      * @inheritDoc
      * @throws DatabaseMigrationException
      */
-    public function run()
+    public function runBatch($batchNumber)
     {
         $relationships = [];
 
@@ -63,6 +63,8 @@ public function run()
                     [DonationMetaKeys::FORM_ID(), 'formId']
                 )
                 ->where('post_type', 'give_payment')
+                ->offset($batchNumber)
+                ->limit($this->getBatchSize())
                 ->getAll();
 
             $donationMeta = [];
@@ -86,7 +88,26 @@ public function run()
                     ->insert($donationMeta, ['%d', '%s', '%d']);
             }
         } catch (DatabaseQueryException $exception) {
-            throw new DatabaseMigrationException("An error occurred while adding campaign ID to the donation meta table", 0, $exception);
+            throw new DatabaseMigrationException("An error occurred while adding campaign ID to the donation meta table",
+                0, $exception);
         }
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getItemsCount(): int
+    {
+        return DB::table('posts')
+            ->where('post_type', 'give_payment')
+            ->count();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBatchSize(): int
+    {
+        return 50;
+    }
 }

src/DonationForms/Migrations/CleanMultipleSlashesOnDB.php

@@ -61,7 +61,7 @@ public static function title()
      */
     public static function timestamp()
     {
-        return strtotime('2023-20-11');
+        return strtotime('2023-11-20');
     }
 
     /**

src/Donations/Migrations/AddMissingDonorIdToDonationComments.php

@@ -58,6 +58,6 @@ public static function title()
      */
     public static function timestamp()
     {
-        return strtotime('2022-19-12');
+        return strtotime('2022-12-19');
     }
 }

src/Donations/Migrations/UnserializeTitlePrefix.php

@@ -54,6 +54,6 @@ public static function title()
      */
     public static function timestamp()
     {
-        return strtotime('2024-23-10');
+        return strtotime('2024-10-23');
     }
 }

src/Donors/Migrations/AddPhoneColumn.php

@@ -55,6 +55,6 @@ public static function title(): string
      */
     public static function timestamp()
     {
-        return strtotime('2024-26-03');
+        return strtotime('2024-03-26');
     }
 }

src/Framework/Migrations/Contracts/BaseMigration.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Give\Framework\Migrations\Contracts;
+
+use Give\Framework\Exceptions\Primitives\RuntimeException;
+
+/**
+ * Base Migration class
+ *
+ * @unreleased
+ */
+abstract class BaseMigration
+{
+    /**
+     * Return a unique identifier for the migration
+     *
+     * @return string
+     */
+    public static function id()
+    {
+        throw new RuntimeException('A unique ID must be provided for the migration');
+    }
+
+    /**
+     * Return a Unix Timestamp for when the migration was created
+     *
+     * Example: strtotime( '2020-09-16 12:30:00')
+     *
+     * @since 2.9.0
+     *
+     * @return int Unix timestamp for when the migration was created
+     */
+    public static function timestamp()
+    {
+        throw new RuntimeException('This method must be overridden to return a valid unix timestamp');
+    }
+
+    /**
+     * Return migration title
+     *
+     * @since 2.10.0
+     *
+     * @return string
+     */
+    public static function title()
+    {
+        return static::id();
+    }
+
+    /**
+     * Return migration source
+     *
+     * @since 2.10.0
+     *
+     * @return string
+     */
+    public static function source()
+    {
+        return esc_html__('GiveWP Core', 'give');
+    }
+}