feat: added ability to snapshot on ProfilerInterface

src/Exception/ParentProfileIsNotStarted.php

@@ -8,6 +8,8 @@
 
 /**
  * @internal exception should never be thrown out
+ *
+ * @todo rename to `ProfilerCouldNotProfileOutsideParentProfile`
  */
 final class ParentProfileIsNotStarted extends LogicException implements ProfilerException
 {

src/Exception/ProfilerCouldNotSnapshotOutsideParentProfile.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\Profiler\Exception;
+
+use LogicException;
+
+final class ProfilerCouldNotSnapshotOutsideParentProfile extends LogicException implements ProfilerException
+{
+}

src/NullProfiler.php

@@ -45,4 +45,8 @@ public function getMemoryUsages(): array
             }
         };
     }
+
+    public function snapshot(): void
+    {
+    }
 }

src/Profiler.php

@@ -29,4 +29,9 @@ public function profile(callable $callable): ProcessableProfileInterface & Profi
 
         return $profile; // @phpstan-ignore return.type
     }
+
+    public function snapshot(): void
+    {
+        throw new Exception\ProfilerCouldNotSnapshotOutsideParentProfile();
+    }
 }

src/ProfilerInterface.php

@@ -14,4 +14,9 @@ interface ProfilerInterface
      * @return ProcessableProfileInterface<TOutput> & ProfileWithOutputInterface<TOutput>
      */
     public function profile(callable $callable): ProcessableProfileInterface & ProfileWithOutputInterface;
+
+    /**
+     * @throws Exception\ProfilerCouldNotSnapshotOutsideParentProfile
+     */
+    public function snapshot(): void;
 }

src/Profiling.php

@@ -88,6 +88,14 @@ public function profile(callable $callable): ProcessableProfileInterface & Profi
                     $this->parentProfile->registerTickSnapshot();
                 }
             }
+
+            public function snapshot(): void
+            {
+                if ($this->parentProfile->getState() !== ProfileState::Started) {
+                    throw new Exception\ProfilerCouldNotSnapshotOutsideParentProfile();
+                }
+                $this->parentProfile->snapshot();
+            }
         };
     }
 

tests/NullProfilerTest.php

@@ -41,4 +41,13 @@ public function testProfileDoesNotRunProcessorAndReturnsCallablesOutput(): void
         self::assertFalse($processorWasCalled);
         self::assertSame('output', $output);
     }
+
+    public function testSnapshotDoesNotThrow(): void
+    {
+        $profiler = new NullProfiler();
+
+        $profiler->snapshot();
+
+        self::assertTrue(true);
+    }
 }

tests/ProfilerTest.php

@@ -37,4 +37,22 @@ public function testReturnsCallablesOutput(): void
 
         self::assertSame('output', $profile->getOutput());
     }
+
+    public function testSnapshotsOnParentProfile(): void
+    {
+        $profiler = new Profiler();
+
+        $profile = $profiler->profile(static fn (ProfilerInterface $profiler) => $profiler->snapshot());
+
+        self::assertCount(2 + 1, $profile->getMemoryUsages());
+    }
+
+    public function testSnapshotsThrowsOutsideProfile(): void
+    {
+        $profiler = new Profiler();
+
+        self::expectException(Exception\ProfilerCouldNotSnapshotOutsideParentProfile::class);
+
+        $profiler->snapshot();
+    }
 }