Do not delete a container that another process has not journaled yet (#6797)

Author: SanderMuller

src/DependencyInjection/Configurator.php

@@ -145,6 +145,7 @@ private function journal(string $currentContainerClassName): void
 		$linesToWrite = [];
 		$usedInTheLastWeek = [];
 		$now = time();
+		$week = 3600 * 24 * 7;
 		$currentAlreadyInTheJournal = false;
 		foreach ($journalLines as $journalLine) {
 			if ($journalLine === '') {
@@ -157,8 +158,6 @@ private function journal(string $currentContainerClassName): void
 			$className = $journalLineParts[0];
 			$containerLastUsedTime = (int) $journalLineParts[1];
 
-			$week = 3600 * 24 * 7;
-
 			if ($containerLastUsedTime + $week < $now) {
 				continue;
 			}
@@ -200,6 +199,11 @@ private function journal(string $currentContainerClassName): void
 			if (in_array($fileClassName, $usedInTheLastWeek, true)) {
 				continue;
 			}
+			// another PHPStan process sharing this directory writes a new container before it is
+			// journaled, so a file missing from the journal is deleted only once it is a week old
+			if ($fileInfo->getMTime() + $week >= $now) {
+				continue;
+			}
 			$basePathname = $fileInfo->getPathname();
 			@unlink($basePathname);
 			@unlink($basePathname . '.lock');

tests/PHPStan/DependencyInjection/ConfiguratorJournalTest.php

@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection;
+
+use Nette\Utils\FileSystem;
+use Override;
+use PHPStan\File\FileHelper;
+use PHPUnit\Framework\TestCase;
+use function file_put_contents;
+use function is_file;
+use function sprintf;
+use function sys_get_temp_dir;
+use function time;
+use function touch;
+use function uniqid;
+
+final class ConfiguratorJournalTest extends TestCase
+{
+
+	private string $tempDirectory;
+
+	#[Override]
+	protected function setUp(): void
+	{
+		$this->tempDirectory = sys_get_temp_dir() . '/' . uniqid('phpstan-configurator-journal-', true);
+	}
+
+	#[Override]
+	protected function tearDown(): void
+	{
+		FileSystem::delete($this->tempDirectory);
+	}
+
+	public function testKeepsAContainerThatAnotherProcessHasNotJournaledYet(): void
+	{
+		$configurator = new Configurator(new LoaderFactory(new FileHelper(__DIR__), __DIR__, __DIR__, null, []), true);
+		$configurator->setTempDirectory($this->tempDirectory);
+		$directory = $configurator->getContainerCacheDirectory();
+		FileSystem::createDir($directory);
+
+		$now = time();
+		$eightDaysAgo = $now - 3600 * 24 * 8;
+		file_put_contents($directory . '/container.journal', sprintf("Container_used:%d\nContainer_expired:%d\n", $now, $eightDaysAgo));
+		foreach (['Container_used', 'Container_expired', 'Container_current', 'Container_unjournaled'] as $className) {
+			file_put_contents($directory . '/' . $className . '.php', '<?php');
+			touch($directory . '/' . $className . '.php', $eightDaysAgo);
+		}
+		// written by another process that has not journaled it yet
+		file_put_contents($directory . '/Container_fresh.php', '<?php');
+
+		(fn () => $this->journal('Container_current'))->call($configurator);
+
+		$this->assertFileExists($directory . '/Container_used.php');
+		$this->assertFileExists($directory . '/Container_current.php');
+		$this->assertFileExists($directory . '/Container_fresh.php');
+		$this->assertFalse(is_file($directory . '/Container_expired.php'));
+		$this->assertFalse(is_file($directory . '/Container_unjournaled.php'));
+	}
+
+}