[HttpKernel] FileProfilerStorage has remove expired profiles mechanism

alamirault · alamirault · commit c670f8a8260a · 2022-08-21T17:05:26.000+02:00
diff --git a/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php b/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php
@@ -18,6 +18,8 @@
  */
 class FileProfilerStorage implements ProfilerStorageInterface
 {
+    protected const MAX_RETENTION_DAYS = 1;
+
     /**
      * Folder where profiler data are stored.
      */
@@ -180,7 +182,7 @@ public function write(Profile $profile): bool
 
         if (!$profileIndexed) {
             // Add to index
-            if (false === $file = fopen($this->getIndexFilename(), 'a')) {
+            if (false === $file = fopen($indexFilename = $this->getIndexFilename(), 'a')) {
                 return false;
             }
 
@@ -194,11 +196,55 @@ public function write(Profile $profile): bool
                 $profile->getStatusCode(),
             ]);
             fclose($file);
+
+            $this->removeExpiredProfiles($indexFilename);
         }
 
         return true;
     }
 
+    protected function removeExpiredProfiles(string $indexFilename)
+    {
+        $minimalProfileTimestamp = (new \DateTime())
+            ->modify(sprintf('-%d days', self::MAX_RETENTION_DAYS))
+            ->getTimestamp();
+
+        $handle = fopen($indexFilename, 'r');
+
+        $tmpIndexFileName = $indexFilename.'.tmp';
+        $atLeastOneExpiredProfile = false;
+        while ($line = fgets($handle)) {
+            $csv = str_getcsv($line);
+            $token = $csv[0];
+            $profileTimestamp = (int) $csv[4];
+
+            if (0 !== $profileTimestamp && $profileTimestamp < $minimalProfileTimestamp) {
+                $atLeastOneExpiredProfile = true;
+                $this->unlinkTokenFile($token);
+            } else {
+                if ($atLeastOneExpiredProfile) {
+                    file_put_contents($tmpIndexFileName, $line);
+                }
+                break;
+            }
+        }
+
+        if ($atLeastOneExpiredProfile) {
+            file_put_contents($tmpIndexFileName, stream_get_contents($handle), \FILE_APPEND);
+            unlink($indexFilename);
+            rename($tmpIndexFileName, $indexFilename);
+        } else {
+            fclose($handle);
+        }
+    }
+
+    public function unlinkTokenFile(string $token)
+    {
+        if (file_exists($filename = $this->getFilename($token))) {
+            unlink($filename);
+        }
+    }
+
     /**
      * Gets filename to store data, associated to the token.
      */
diff --git a/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php b/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php
@@ -344,6 +344,73 @@ public function testMultiRowIndexFile()
         $this->assertFalse(fgetcsv($handle));
     }
 
+    /**
+     * @dataProvider removeExpiredProfilesProvider
+     */
+    public function testRemoveExpiredProfiles(string $originalExpectedIndexContent, string $newExpectedIndexContent)
+    {
+        $indexFilename = $this->tmpDir.'/index.csv';
+
+        file_put_contents($indexFilename, $originalExpectedIndexContent);
+
+        $this->assertSame($originalExpectedIndexContent, file_get_contents($indexFilename));
+
+        $r = new \ReflectionMethod($this->storage, 'removeExpiredProfiles');
+        $r->invoke($this->storage, $indexFilename);
+
+        $this->assertSame($newExpectedIndexContent, file_get_contents($indexFilename));
+    }
+
+    public function removeExpiredProfilesProvider()
+    {
+        $oneHourAgo = new \DateTime('now');
+        $oneHourAgo->modify('-1 hour');
+
+        yield 'One unexpired profile' => [
+            <<< CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+            <<< CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+        ];
+
+        $twoDaysAgo = new \DateTime('now');
+        $twoDaysAgo->modify('-2 days');
+
+        yield 'One expired profile' => [
+            <<< CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$twoDaysAgo->getTimestamp()},,
+            
+            CSV,
+            '',
+        ];
+
+        $threeDaysAgo = new \DateTime('now');
+        $threeDaysAgo->modify('-3 days');
+
+        $twoDaysAgo = new \DateTime('now');
+        $twoDaysAgo->modify('-2 days');
+
+        $oneHourAgo = new \DateTime('now');
+        $oneHourAgo->modify('-1 hour');
+
+        yield 'Multiple expired profiles' => [
+            <<< CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$threeDaysAgo->getTimestamp()},,
+            token1,127.0.0.1,,http://foo.bar/1,{$twoDaysAgo->getTimestamp()},,
+            token2,127.0.0.2,,http://foo.bar/2,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+            <<< CSV
+            token2,127.0.0.2,,http://foo.bar/2,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+        ];
+    }
+
     public function testReadLineFromFile()
     {
         $r = new \ReflectionMethod($this->storage, 'readLineFromFile');
