Make the migration job name explicit

Automattic · Sep 4, 2023 · e7332eb · e7332eb
1 parent bef4b79
commit e7332eb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/includes/class-sensei.php b/includes/class-sensei.php
@@ -595,8 +595,12 @@ public function initialize_global_objects() {
 		// Student progress migration.
 		if ( $use_tables ) {
 			$this->migration_scheduler = new Migration_Job_Scheduler( $this->action_scheduler );
-			$this->migration_scheduler->register_job( new Migration_Job( new Student_Progress_Migration() ) );
-			$this->migration_scheduler->register_job( new Migration_Job( new Quiz_Migration() ) );
+			$this->migration_scheduler->register_job(
+				new Migration_Job( 'student_progress_migration', new Student_Progress_Migration() )
+			);
+			$this->migration_scheduler->register_job(
+				new Migration_Job( 'quiz_migration', new Quiz_Migration() )
+			);
 			( new Migration_Tool( \Sensei_Tools::instance(), $this->migration_scheduler ) )->init();
 		}
 

diff --git a/includes/internal/migration/class-migration-job.php b/includes/internal/migration/class-migration-job.php
@@ -7,8 +7,6 @@
 
 namespace Sensei\Internal\Migration;
 
-use ReflectionClass;
-
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
 }
@@ -21,6 +19,12 @@
  * @since $$next-version$$
  */
 class Migration_Job {
+	/**
+	 * Job name.
+	 *
+	 * @var string
+	 */
+	private $name;
 
 	/**
 	 * Migration.
@@ -36,23 +40,15 @@ class Migration_Job {
 	 */
 	private $is_complete = false;
 
-	/**
-	 * Job name.
-	 *
-	 * @var string
-	 */
-	private $name;
-
 	/**
 	 * Migration_Job constructor.
 	 *
+	 * @param string             $name The job name. Should be hook friendly (lowercase, underscored).
 	 * @param Migration_Abstract $migration Migration.
 	 */
-	public function __construct( Migration_Abstract $migration ) {
+	public function __construct( string $name, Migration_Abstract $migration ) {
+		$this->name      = $name;
 		$this->migration = $migration;
-		$this->name      = strtolower(
-			( new ReflectionClass( $migration ) )->getShortName()
-		);
 	}
 
 	/**
@@ -94,7 +90,7 @@ public function is_complete(): bool {
 	}
 
 	/**
-	 * Get job name.
+	 * Get the job name.
 	 *
 	 * @internal
 	 *

diff --git a/tests/unit-tests/internal/migration/test-class-migration-job.php b/tests/unit-tests/internal/migration/test-class-migration-job.php
@@ -14,7 +14,7 @@ class Migration_Job_Test extends \WP_UnitTestCase {
 	public function testRun_Always_RunsMigration() {
 		/* Arrange. */
 		$migration = $this->createMock( Student_Progress_Migration::class );
-		$job       = new Migration_Job( $migration );
+		$job       = new Migration_Job( 'student_progress_migration', $migration );
 
 		/* Expect & Act. */
 		$migration
@@ -30,7 +30,7 @@ public function testIsComplete_MigrationRanWithoutInsertions_ReturnsTrue() {
 		$migration = $this->createMock( Student_Progress_Migration::class );
 		$migration->method( 'run' )->willReturn( 0 );
 
-		$job = new Migration_Job( $migration );
+		$job = new Migration_Job( 'student_progress_migration', $migration );
 		$job->run();
 
 		/* Act. */
@@ -45,7 +45,7 @@ public function testIsComplete_MigrationRanWithInsertions_ReturnsFalse() {
 		$migration = $this->createMock( Student_Progress_Migration::class );
 		$migration->method( 'run' )->willReturn( 1 );
 
-		$job = new Migration_Job( $migration );
+		$job = new Migration_Job( 'student_progress_migration', $migration );
 		$job->run();
 
 		/* Act. */
@@ -65,7 +65,7 @@ public function testGetErrors_Always_ReturnsMigrationErrors( $errors ) {
 		$migration = $this->createMock( Student_Progress_Migration::class );
 		$migration->method( 'get_errors' )->willReturn( $errors );
 
-		$job = new Migration_Job( $migration );
+		$job = new Migration_Job( 'student_progress_migration', $migration );
 
 		/* Act. */
 		$actual = $job->get_errors();
@@ -88,7 +88,7 @@ public function providerGetErrors_Always_ReturnsMigrationErrors(): array {
 	public function testGetName_Always_ReturnsMatchingValue() {
 		/* Arrange. */
 		$migration = new Student_Progress_Migration();
-		$job       = new Migration_Job( $migration );
+		$job       = new Migration_Job( 'student_progress_migration', $migration );
 
 		/* Act. */
 		$actual = $job->get_name();