feature #45265 [HttpKernel] Add Profiler::isEnabled() method (Bilge)

fabpot · fabpot · commit 0c1bf57588ae · 2022-02-21T17:22:49.000+01:00
This PR was squashed before being merged into the 6.1 branch. Discussion ---------- [HttpKernel] Add Profiler::isEnabled() method | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#...  When disabling the profiler programmatically, collectors will not be called, but any collaborating services that collect profiling data on behalf of those collectors will still do unnecessary work. By being able to inquire about whether the profiler is enabled, such services may elect to omit data collection thus reducing memory and CPU footprint. Relates to #45241. Commits ------- b305386 [HttpKernel] Add Profiler::isEnabled() method
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `BackedEnumValueResolver` to resolve backed enum cases from request attributes in controller arguments
  * Deprecate StreamedResponseListener, it's not needed anymore
+ * Add `Profiler::isEnabled()` so collaborating collector services may elect to omit themselves.
 
 6.0
 ---
diff --git a/src/Symfony/Component/HttpKernel/Profiler/Profiler.php b/src/Symfony/Component/HttpKernel/Profiler/Profiler.php
@@ -60,6 +60,11 @@ public function enable()
         $this->enabled = true;
     }
 
+    public function isEnabled(): bool
+    {
+        return $this->enabled;
+    }
+
     /**
      * Loads the Profile for the given Response.
      */
diff --git a/src/Symfony/Component/HttpKernel/Tests/Profiler/ProfilerTest.php b/src/Symfony/Component/HttpKernel/Tests/Profiler/ProfilerTest.php
@@ -83,6 +83,28 @@ public function testFindWorksWithStatusCode()
         $this->assertCount(0, $profiler->find(null, null, null, null, null, null, '204'));
     }
 
+    public function testIsInitiallyEnabled()
+    {
+        self::assertTrue((new Profiler($this->storage))->isEnabled());
+    }
+
+    public function testDisable()
+    {
+        $profiler = new Profiler($this->storage);
+        $profiler->disable();
+
+        self::assertFalse($profiler->isEnabled());
+    }
+
+    public function testEnable()
+    {
+        $profiler = new Profiler($this->storage);
+        $profiler->disable();
+        $profiler->enable();
+
+        self::assertTrue($profiler->isEnabled());
+    }
+
     protected function setUp(): void
     {
         $this->tmp = tempnam(sys_get_temp_dir(), 'sf_profiler');
