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