Actions
4 years ago
Contracts
4 years ago
Controllers
4 years ago
Exceptions
4 years ago
MigrationsRegister.php
4 years ago
MigrationsRunner.php
4 years ago
MigrationsServiceProvider.php
4 years ago
MigrationsRunner.php
171 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Migrations; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Framework\Database\Exceptions\DatabaseQueryException; |
| 7 | use Give\Framework\Migrations\Contracts\Migration; |
| 8 | use Give\Log\Log; |
| 9 | use Give\MigrationLog\MigrationLogFactory; |
| 10 | use Give\MigrationLog\MigrationLogRepository; |
| 11 | use Give\MigrationLog\MigrationLogStatus; |
| 12 | |
| 13 | /** |
| 14 | * Class MigrationsRunner |
| 15 | * |
| 16 | * @since 2.9.0 |
| 17 | */ |
| 18 | class MigrationsRunner |
| 19 | { |
| 20 | /** |
| 21 | * List of completed migrations. |
| 22 | * |
| 23 | * @since 2.9.0 |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | private $completedMigrations; |
| 28 | |
| 29 | /** |
| 30 | * @since 2.9.0 |
| 31 | * |
| 32 | * @var MigrationsRegister |
| 33 | */ |
| 34 | private $migrationRegister; |
| 35 | |
| 36 | /** |
| 37 | * @since 2.10.0 |
| 38 | * |
| 39 | * @var MigrationLogFactory |
| 40 | */ |
| 41 | private $migrationLogFactory; |
| 42 | |
| 43 | /** |
| 44 | * @since 2.10.0 |
| 45 | * @var MigrationLogRepository |
| 46 | */ |
| 47 | private $migrationLogRepository; |
| 48 | |
| 49 | /** |
| 50 | * MigrationsRunner constructor. |
| 51 | * |
| 52 | * @param MigrationsRegister $migrationRegister |
| 53 | * @param MigrationLogFactory $migrationLogFactory |
| 54 | * @param MigrationLogRepository $migrationLogRepository |
| 55 | */ |
| 56 | public function __construct( |
| 57 | MigrationsRegister $migrationRegister, |
| 58 | MigrationLogFactory $migrationLogFactory, |
| 59 | MigrationLogRepository $migrationLogRepository |
| 60 | ) { |
| 61 | $this->migrationRegister = $migrationRegister; |
| 62 | $this->migrationLogFactory = $migrationLogFactory; |
| 63 | $this->migrationLogRepository = $migrationLogRepository; |
| 64 | $this->completedMigrations = $this->migrationLogRepository->getCompletedMigrationsIDs(); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Run database migrations. |
| 69 | * |
| 70 | * @since 2.9.0 |
| 71 | */ |
| 72 | public function run() |
| 73 | { |
| 74 | global $wpdb; |
| 75 | |
| 76 | if ( ! $this->hasMigrationToRun()) { |
| 77 | return; |
| 78 | } |
| 79 | |
| 80 | // Stop Migration Runner if there are failed migrations |
| 81 | if ($this->migrationLogRepository->getFailedMigrationsCountByIds( |
| 82 | $this->migrationRegister->getRegisteredIds() |
| 83 | )) { |
| 84 | return; |
| 85 | } |
| 86 | |
| 87 | // Store and sort migrations by timestamp |
| 88 | $migrations = []; |
| 89 | |
| 90 | foreach ($this->migrationRegister->getMigrations() as $migrationClass) { |
| 91 | /* @var Migration $migrationClass */ |
| 92 | $migrations[$migrationClass::timestamp() . '_' . $migrationClass::id()] = $migrationClass; |
| 93 | } |
| 94 | |
| 95 | ksort($migrations); |
| 96 | |
| 97 | foreach ($migrations as $key => $migrationClass) { |
| 98 | $migrationId = $migrationClass::id(); |
| 99 | |
| 100 | if (in_array($migrationId, $this->completedMigrations, true)) { |
| 101 | continue; |
| 102 | } |
| 103 | |
| 104 | $migrationLog = $this->migrationLogFactory->make($migrationId); |
| 105 | |
| 106 | // Begin transaction |
| 107 | $wpdb->query('START TRANSACTION'); |
| 108 | |
| 109 | try { |
| 110 | /** @var Migration $migration */ |
| 111 | $migration = give($migrationClass); |
| 112 | |
| 113 | $migration->run(); |
| 114 | |
| 115 | // Save migration status |
| 116 | $migrationLog->setStatus(MigrationLogStatus::SUCCESS); |
| 117 | } catch (Exception $exception) { |
| 118 | $wpdb->query('ROLLBACK'); |
| 119 | |
| 120 | $migrationLog->setStatus(MigrationLogStatus::FAILED); |
| 121 | $migrationLog->setError($exception); |
| 122 | |
| 123 | give()->notices->register_notice( |
| 124 | [ |
| 125 | 'id' => 'migration-failure', |
| 126 | 'description' => sprintf( |
| 127 | '%1$s <a href="https://givewp.com/support/">https://givewp.com/support</a>', |
| 128 | esc_html__( |
| 129 | 'There was a problem running the migrations. Please reach out to GiveWP support for assistance:', |
| 130 | 'give' |
| 131 | ) |
| 132 | ), |
| 133 | ] |
| 134 | ); |
| 135 | } |
| 136 | |
| 137 | try { |
| 138 | $migrationLog->save(); |
| 139 | } catch (DatabaseQueryException $e) { |
| 140 | Log::error( |
| 141 | 'Failed to save migration log', |
| 142 | [ |
| 143 | 'Error Message' => $e->getMessage(), |
| 144 | 'Query Errors' => $e->getQueryErrors(), |
| 145 | ] |
| 146 | ); |
| 147 | } |
| 148 | |
| 149 | // Stop Migration Runner if migration has failed |
| 150 | if ($migrationLog->getStatus() === MigrationLogStatus::FAILED) { |
| 151 | break; |
| 152 | } |
| 153 | |
| 154 | // Commit transaction if successful |
| 155 | $wpdb->query('COMMIT'); |
| 156 | } |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Return whether or not all migrations completed. |
| 161 | * |
| 162 | * @since 2.9.0 |
| 163 | * |
| 164 | * @return bool |
| 165 | */ |
| 166 | public function hasMigrationToRun() |
| 167 | { |
| 168 | return (bool)array_diff($this->migrationRegister->getRegisteredIds(), $this->completedMigrations); |
| 169 | } |
| 170 | } |
| 171 |