feature #47352 [HttpKernel] FileProfilerStorage remove expired profiles mechanism (alamirault)

fabpot · fabpot · commit fee5714d0227 · 2022-12-18T10:57:03.000+01:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [HttpKernel] FileProfilerStorage remove expired profiles mechanism | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix #45831  | License | MIT | Doc PR | symfony/symfony-docs#...  This is a first attempt for limit number of profiles saved (discussed in #45831). When we save new profile, all expired profiles are removed. Expiration is one day for the moment. Questions: - Not sure how to deal, profiles with time `0`, like an unexpired profile ? - I assume profiles are sorted and oldest profile is on firstline. -> avoid readind all index file if first profile is not expired - Is there a best way ? (cpu/memory, io efficient) (I'm not sure I have the necessary skills, changes are welcome :)) TODOS: - [x] Changelog - [x] Complete tests - [ ] Symfony docs PR Commits ------- 58d0662 [HttpKernel] FileProfilerStorage remove expired profiles mechanism
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Deprecate parameters `container.dumper.inline_factories` and `container.dumper.inline_class_loader`, use `.container.dumper.inline_factories` and `.container.dumper.inline_class_loader` instead
+ * `FileProfilerStorage` removes profiles automatically after two days
 
 6.2
 ---
diff --git a/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php b/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php
@@ -165,11 +165,15 @@ public function write(Profile $profile): bool
                 $profile->getIp(),
                 $profile->getMethod(),
                 $profile->getUrl(),
-                $profile->getTime(),
+                $profile->getTime() ?: time(),
                 $profile->getParentToken(),
                 $profile->getStatusCode(),
             ]);
             fclose($file);
+
+            if (1 === mt_rand(1, 10)) {
+                $this->removeExpiredProfiles();
+            }
         }
 
         return true;
@@ -289,4 +293,29 @@ private function doRead($token, Profile $profile = null): ?Profile
 
         return $this->createProfileFromData($token, $data, $profile);
     }
+
+    private function removeExpiredProfiles()
+    {
+        $minimalProfileTimestamp = time() - 2 * 86400;
+        $file = $this->getIndexFilename();
+        $handle = fopen($file, 'r');
+
+        if ($offset = is_file($file.'.offset') ? (int) file_get_contents($file.'.offset') : 0) {
+            fseek($handle, $offset);
+        }
+
+        while ($line = fgets($handle)) {
+            [$csvToken, , , , $csvTime] = str_getcsv($line);
+
+            if ($csvTime >= $minimalProfileTimestamp) {
+                break;
+            }
+
+            @unlink($this->getFilename($csvToken));
+            $offset += \strlen($line);
+        }
+        fclose($handle);
+
+        file_put_contents($file.'.offset', $offset);
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php b/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php
@@ -344,6 +344,57 @@ public function testMultiRowIndexFile()
         $this->assertFalse(fgetcsv($handle));
     }
 
+    /**
+     * @dataProvider provideExpiredProfiles
+     */
+    public function testRemoveExpiredProfiles(string $index, string $expectedOffset)
+    {
+        $file = $this->tmpDir.'/index.csv';
+        file_put_contents($file, $index);
+
+        $r = new \ReflectionMethod($this->storage, 'removeExpiredProfiles');
+        $r->invoke($this->storage);
+
+        $this->assertSame($expectedOffset, file_get_contents($this->tmpDir.'/index.csv.offset'));
+    }
+
+    public static function provideExpiredProfiles()
+    {
+        $oneHourAgo = new \DateTimeImmutable('-1 hour');
+
+        yield 'One unexpired profile' => [
+            <<<CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+            '0',
+        ];
+
+        $threeDaysAgo = new \DateTimeImmutable('-3 days');
+
+        yield 'One expired profile' => [
+            <<<CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$threeDaysAgo->getTimestamp()},,
+
+            CSV,
+            '48',
+        ];
+
+        $fourDaysAgo = new \DateTimeImmutable('-4 days');
+        $threeDaysAgo = new \DateTimeImmutable('-3 days');
+        $oneHourAgo = new \DateTimeImmutable('-1 hour');
+
+        yield 'Multiple expired profiles' => [
+            <<<CSV
+            token0,127.0.0.0,,http://foo.bar/0,{$fourDaysAgo->getTimestamp()},,
+            token1,127.0.0.1,,http://foo.bar/1,{$threeDaysAgo->getTimestamp()},,
+            token2,127.0.0.2,,http://foo.bar/2,{$oneHourAgo->getTimestamp()},,
+
+            CSV,
+            '96',
+        ];
+    }
+
     public function testReadLineFromFile()
     {
         $r = new \ReflectionMethod($this->storage, 'readLineFromFile');
