wip: reset hashing

for #114

Author: g105b

src/Cli/ExecuteCommand.php

@@ -57,9 +57,19 @@ public function run(?ArgumentValueList $arguments = null):void {
 		$migrationCount = $migrator->getMigrationCount();
 		$migrationFileList = $migrator->getMigrationFileList();
 
+		$resetNumber = null;
+		if($arguments->contains("reset")) {
+			$resetNumber = $arguments->get("reset")->get();
+			if(!$resetNumber) {
+				$lastKey = array_key_last($migrationFileList);
+				$resetNumber = $migrator->extractNumberFromFilename($migrationFileList[$lastKey]);
+			}
+			$resetNumber = (int)$resetNumber;
+		}
+
 		try {
-			$migrator->checkIntegrity($migrationFileList, $migrationCount);
-			$migrator->performMigration($migrationFileList, $migrationCount);
+			$migrator->checkIntegrity($migrationFileList, $resetNumber ?? $migrationCount);
+			$migrator->performMigration($migrationFileList, $resetNumber ?? $migrationCount);
 		}
 		catch(MigrationIntegrityException $exception) {
 			$this->writeLine(
@@ -106,6 +116,12 @@ public function getOptionalParameterList():array {
 				"force",
 				"f",
 				"Forcefully drop the current schema and run from migration 1"
+			),
+			new Parameter(
+				true,
+				"reset",
+				"r",
+				"Reset the integrity checks to a specific migration number"
 			)
 		];
 	}

src/Migration/Migrator.php

@@ -89,7 +89,7 @@ public function createMigrationTable():void {
 		$this->dbClient->executeSql(implode("\n", [
 			"create table if not exists `{$this->tableName}` (",
 			"`" . self::COLUMN_QUERY_NUMBER . "` int primary key,",
-			"`" . self::COLUMN_QUERY_HASH . "` varchar(32) not null,",
+			"`" . self::COLUMN_QUERY_HASH . "` varchar(32) null,",
 			"`" . self::COLUMN_MIGRATED_AT . "` datetime not null )",
 		]));
 	}
@@ -144,26 +144,32 @@ public function checkFileListOrder(array $fileList):void {
 	/** @param array<string> $migrationFileList */
 	public function checkIntegrity(
 		array $migrationFileList,
-		?int $migrationCount = null
+		?int $migrationStartFrom = null
 	):int {
 		$fileNumber = 0;
 
 		foreach($migrationFileList as $i => $file) {
-			$fileNumber = $i + 1;
+			$fileNumber = $this->extractNumberFromFilename($file);
 			$md5 = md5_file($file);
 
-			if(is_null($migrationCount)
-				|| $fileNumber <= $migrationCount) {
+			if($migrationStartFrom) {
+				if($fileNumber < $migrationStartFrom) {
+					continue;
+				}
+			}
+
+			if(is_null($migrationStartFrom)
+				|| $fileNumber <= $migrationStartFrom) {
 				$result = $this->dbClient->executeSql(implode("\n", [
 					"select `" . self::COLUMN_QUERY_HASH . "`",
 					"from `{$this->tableName}`",
 					"where `" . self::COLUMN_QUERY_NUMBER . "` = ?",
 					"limit 1",
 				]), [$fileNumber]);
 
-				$hashInDb = ($result->fetch())->getString(self::COLUMN_QUERY_HASH);
+				$hashInDb = ($result->fetch())?->getString(self::COLUMN_QUERY_HASH);
 
-				if($hashInDb !== $md5) {
+				if($hashInDb && $hashInDb !== $md5) {
 					throw new MigrationIntegrityException($file);
 				}
 			}
@@ -172,7 +178,7 @@ public function checkIntegrity(
 		return $fileNumber;
 	}
 
-	protected function extractNumberFromFilename(string $pathName):int {
+	public function extractNumberFromFilename(string $pathName):int {
 		$file = new SplFileInfo($pathName);
 		$filename = $file->getFilename();
 		preg_match("/(\d+)-?.*\.sql/", $filename, $matches);
@@ -187,15 +193,15 @@ protected function extractNumberFromFilename(string $pathName):int {
 	/** @param array<string> $migrationFileList */
 	public function performMigration(
 		array $migrationFileList,
-		int $existingMigrationCount = 0
+		int $existingFileNumber = 0
 	):int {
 		$fileNumber = 0;
 		$numCompleted = 0;
 
 		foreach($migrationFileList as $i => $file) {
-			$fileNumber = $i + 1;
+			$fileNumber = $this->extractNumberFromFilename($file);
 
-			if($fileNumber <= $existingMigrationCount) {
+			if($fileNumber <= $existingFileNumber) {
 				continue;
 			}
 
@@ -277,7 +283,7 @@ public function selectSchema():void {
 		}
 	}
 
-	protected function recordMigrationSuccess(int $number, string $hash):void {
+	protected function recordMigrationSuccess(int $number, ?string $hash):void {
 		$now = "now()";
 
 		if($this->driver === Settings::DRIVER_SQLITE) {
@@ -295,6 +301,15 @@ protected function recordMigrationSuccess(int $number, string $hash):void {
 		]), [$number, $hash]);
 	}
 
+	/**
+	 * @param int $numberToForce A null-hashed migration will be marked as
+	 * successful with this number. This will allow the next number to be
+	 * executed out of sequence.
+	 */
+	public function resetMigrationSequence(int $numberToForce):void {
+		$this->recordMigrationSuccess($numberToForce, null);
+	}
+
 	/**
 	 * @codeCoverageIgnore
 	 */

src/Query/QueryCollectionFactory.php

@@ -27,7 +27,6 @@ public function create(string $name):QueryCollection {
 		}
 
 		return $this->queryCollectionCache[$name];
-
 	}
 
 	public function directoryExists(string $name):bool {

test/phpunit/Migration/MigratorTest.php

@@ -279,6 +279,58 @@ public function testForcedMigration(array $fileList) {
 		self::assertNull($exception,"Exception should not be thrown");
 	}
 
+	/**
+	 * This test needs an explanation because it's not immediately obvious.
+	 * The fileList is generated as usual, but then to simulate a real
+	 * production "messy" codebase, a new migration file is created with a
+	 * much higher sequence (15 higher than the last in the fileList).
+	 *
+	 * Because of this, the migration will fail. However, we reset the
+	 * migration sequence before performing the migration, and even though
+	 * none of the files in fileList are migrated yet, we should only see
+	 * 1 migration take place.
+	 *
+	 * @dataProvider dataMigrationFileList
+	 */
+	public function testResetMigration(array $fileList) {
+		$path = $this->getMigrationDirectory();
+		$this->createMigrationFiles($fileList, $path);
+		$settings = $this->createSettings($path);
+
+		$migrator = new Migrator(
+			$settings,
+			$path,
+			"_migration",
+		);
+
+		$newNumber = count($fileList) + 15;
+
+		$newFileName = str_pad($newNumber, 4, "0", STR_PAD_LEFT);
+		$newFileName .= "-" . uniqid() . ".sql";
+		$newFilePath = implode(DIRECTORY_SEPARATOR, [
+			$path,
+			$newFileName,
+		]);
+		array_push($fileList, $newFileName);
+
+		$absoluteFileList = array_map(function($file)use($path) {
+			return implode(DIRECTORY_SEPARATOR, [
+				$path,
+				$file,
+			]);
+		},$fileList);
+
+		$lastKey = array_key_last($absoluteFileList);
+		file_put_contents($absoluteFileList[$lastKey], "create table migrated_out_of_order ( id int primary key )");
+
+		$migrator->createMigrationTable();
+		$migrator->resetMigrationSequence($newNumber - 1);
+		$migrationCount = $migrator->getMigrationCount();
+		$migrator->checkIntegrity($absoluteFileList, $migrationCount);
+		$migrationsExecuted = $migrator->performMigration($absoluteFileList, $migrationCount);
+		self::assertSame(1, $migrationsExecuted);
+	}
+
 	/**
 	 * @dataProvider dataMigrationFileList
 	 * @runInSeparateProcess