feat(profiler): add XHProf middleware to get profiles from web API

src/Application.php

@@ -58,10 +58,11 @@ public function __construct(
             new Traffic\Dispatcher\VarDumper(),
             new Traffic\Dispatcher\Http(
                 [
-                    new Middleware\Resources(),
-                    new Middleware\DebugPage(),
-                    new Middleware\RayRequestDump(),
-                    new Middleware\SentryTrap(),
+                    $this->container->get(Middleware\Resources::class),
+                    $this->container->get(Middleware\DebugPage::class),
+                    $this->container->get(Middleware\RayRequestDump::class),
+                    $this->container->get(Middleware\SentryTrap::class),
+                    $this->container->get(Middleware\XHProfTrap::class),
                 ],
                 [new Websocket()],
             ),

src/Command/Test.php

@@ -35,6 +35,9 @@ protected function execute(
     ): int {
         $this->logger = new Logger($output);
 
+        // XHProf
+        $this->sendContent('yii-xhprof.http');
+
         $this->dump();
         \usleep(100_000);
         $this->mail($output, true);

src/Handler/Http/Middleware/XHProfTrap.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Buggregator\Trap\Handler\Http\Middleware;
+
+use Buggregator\Trap\Handler\Http\Middleware;
+use Buggregator\Trap\Logger;
+use Buggregator\Trap\Module\Profiler\Struct\Profile;
+use Buggregator\Trap\Module\Profiler\XHProf\ProfileBuilder as XHProfProfileBuilder;
+use Buggregator\Trap\Proto\Frame;
+use Nyholm\Psr7\Response;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * @internal
+ * @psalm-internal Buggregator\Trap
+ *
+ * @psalm-type XHProfMessage = array{
+ *     profile: array,
+ *     tags: array,
+ *     app_name: string,
+ *     hostname: string,
+ *     date: positive-int
+ * }
+ */
+final class XHProfTrap implements Middleware
+{
+    private const MAX_BODY_SIZE = 10 * 1024 * 1024;
+
+    public function __construct(
+        private readonly XHProfProfileBuilder $profileBuilder,
+        private readonly Logger $logger,
+    ) {}
+
+    public function handle(ServerRequestInterface $request, callable $next): ResponseInterface
+    {
+        try {
+            if ($request->getMethod() === 'POST'
+                && \str_ends_with($request->getUri()->getPath(), '/api/profiler/store')
+            ) {
+                return $this->processStore($request);
+            }
+        } catch (\JsonException $e) {
+            // Reject invalid JSON
+            $this->logger->exception($e, important: true);
+            return new Response(400, body: 'Invalid JSON data.');
+        } catch (\Throwable $e) {
+            // Reject invalid request
+            $this->logger->exception($e, important: true);
+            return new Response(400, body: $e->getMessage());
+        }
+
+        return $next($request);
+    }
+
+    /**
+     * @throws \JsonException
+     * @throws \Throwable
+     */
+    private function processStore(ServerRequestInterface $request): ResponseInterface
+    {
+        $size = $request->getBody()->getSize();
+        if ($size === null || $size > self::MAX_BODY_SIZE) {
+            // Reject too big content
+            return new Response(413);
+        }
+
+        /** @var XHProfMessage $payload */
+        $payload = \json_decode((string) $request->getBody(), true, 96, \JSON_THROW_ON_ERROR);
+
+        $metadata = $payload;
+        unset($metadata['profile'], $metadata['tags'], $metadata['date']);
+
+        isset($payload['profile'], $payload['tags'])
+            && \is_array($payload['profile'])
+            && \is_array($payload['tags'])
+            or throw new \InvalidArgumentException('Invalid payload');
+
+        /** @psalm-suppress MixedAssignment */
+        $time = $request->getAttribute('begin_at');
+        $time = $time instanceof \DateTimeImmutable ? $time : new \DateTimeImmutable();
+
+        \Fiber::suspend(
+            new Frame\Profiler(
+                payload: Frame\Profiler\Payload::new(
+                    type: Frame\Profiler\Type::XHProf,
+                    callsProvider: fn(): Profile => $this->profileBuilder->createProfile(
+                        date: $time,
+                        metadata: $metadata,
+                        tags: $payload['tags'] ?? [],
+                        calls: $payload['profile'] ?? [],
+                    ),
+                ),
+                time: $time,
+            ),
+        );
+
+        return new Response(200);
+    }
+}

src/Module/Profiler/Struct/Peaks.php

@@ -74,12 +74,25 @@ public function jsonSerialize(): array
         ];
     }
 
-    public function update(Cost $item): void
+    public function update(Cost $cost): void
     {
-        $this->ct = \max($this->ct, $item->ct);
-        $this->wt = \max($this->wt, $item->wt);
-        $this->cpu = \max($this->cpu, $item->cpu);
-        $this->mu = \max($this->mu, $item->mu);
-        $this->pmu = \max($this->pmu, $item->pmu);
+        $this->ct = \max($this->ct, $cost->ct);
+        $this->wt = \max($this->wt, $cost->wt);
+        $this->cpu = \max($this->cpu, $cost->cpu);
+        $this->mu = \max($this->mu, $cost->mu);
+        $this->pmu = \max($this->pmu, $cost->pmu);
+    }
+
+    public function toCost(): Cost
+    {
+        return new Cost($this->ct, $this->wt, $this->cpu, $this->mu, $this->pmu);
+    }
+
+    public function add(Cost $cost): void
+    {
+        $this->wt += $cost->wt;
+        $this->cpu += $cost->cpu;
+        $this->mu = \max($this->mu, $cost->mu);
+        $this->pmu = \max($this->pmu, $cost->pmu);
     }
 }

src/Module/Profiler/Struct/Tree.php

@@ -14,13 +14,13 @@
 final class Tree implements \IteratorAggregate, \Countable
 {
     /** @var array<non-empty-string, Branch<TItem>> */
-    private array $root = [];
+    public array $root = [];
 
     /** @var array<non-empty-string, Branch<TItem>> */
-    private array $all = [];
+    public array $all = [];
 
     /** @var array<non-empty-string, Branch<TItem>> */
-    private array $lostChildren = [];
+    public array $lostChildren = [];
 
     /**
      * @template T of object
@@ -94,6 +94,14 @@ public function iterateAll(): \Traversable
         }
     }
 
+    /**
+     * @return \Traversable<Branch<TItem>>
+     */
+    public function iterateLostChildren(): \Traversable
+    {
+        yield from $this->lostChildren;
+    }
+
     /**
      * Yield items by the level in the hierarchy with custom sorting in level scope
      *
@@ -144,6 +152,14 @@ public function getItemsSortedV0(?callable $sorter): \Traversable
         }
     }
 
+    /**
+     * @return int<0, max>
+     */
+    public function count(): int
+    {
+        return \count($this->all);
+    }
+
     public function __destruct()
     {
         foreach ($this->all as $branch) {
@@ -152,12 +168,4 @@ public function __destruct()
 
         unset($this->all, $this->root, $this->lostChildren);
     }
-
-    /**
-     * @return int<0, max>
-     */
-    public function count(): int
-    {
-        return \count($this->all);
-    }
 }

src/Module/Profiler/XHProf/ProfileBuilder.php

@@ -58,6 +58,8 @@ private function dataToPayload(array $data): array
         /** @var Tree<Edge> $tree */
         $tree = new Tree();
 
+        unset($data['value']);
+
         foreach (\array_reverse($data, true) as $key => $value) {
             [$caller, $callee] = \explode('==>', $key, 2) + [1 => ''];
             if ($callee === '') {
@@ -76,6 +78,25 @@ private function dataToPayload(array $data): array
             $tree->addItem($edge, $edge->callee, $edge->caller);
         }
 
+        // Add parents for lost children
+        $lostParents = [];
+        /** @var Branch<Edge> $branch */
+        foreach ($tree->iterateLostChildren() as $branch) {
+            \assert($branch->item->caller !== null);
+            ($lostParents[$branch->item->caller] ??= new Peaks())
+                ->add($branch->item->cost);
+        }
+        /** @var array<non-empty-string, Peaks> $lostParents */
+        foreach ($lostParents as $key => $peak) {
+            $edge = new Edge(
+                caller: null,
+                callee: $key,
+                cost: $peak->toCost(),
+            );
+            $tree->addItem($edge, $edge->callee, $edge->caller);
+        }
+        unset($lostParents);
+
         /**
          * Calc percentages and delta
          * @var Branch<Edge> $branch Needed for IDE

src/Proto/Frame/Binary.php

@@ -32,6 +32,11 @@ public function getSize(): int
         return (int) $this->stream->getSize();
     }
 
+    public function getStream(): StreamInterface
+    {
+        return $this->stream;
+    }
+
     /**
      * @throws \JsonException
      */
@@ -41,9 +46,4 @@ public function __toString(): string
             'size' => $this->getSize(),
         ]);
     }
-
-    public function getStream(): StreamInterface
-    {
-        return $this->stream;
-    }
 }

src/Proto/Frame/Http.php

@@ -107,6 +107,11 @@ public function iterateUploadedFiles(): \Iterator
         return $generator($this->request->getUploadedFiles());
     }
 
+    public function getStream(): StreamInterface
+    {
+        return $this->request->getBody();
+    }
+
     /**
      * @throws \JsonException
      */
@@ -124,9 +129,4 @@ public function __toString(): string
             'uploadedFiles' => $this->request->getUploadedFiles(),
         ]);
     }
-
-    public function getStream(): StreamInterface
-    {
-        return $this->request->getBody();
-    }
 }

src/Proto/Frame/Profiler/Payload.php

@@ -29,8 +29,7 @@ final class Payload implements \JsonSerializable
     private function __construct(
         public readonly PayloadType $type,
         private readonly \Closure $callsProvider,
-    ) {
-    }
+    ) {}
 
     /**
      * @param PayloadType $type

src/Proto/Frame/Smtp.php

@@ -44,16 +44,16 @@ public function getFiles(): array
         return $this->message->getAttachments();
     }
 
+    public function getStream(): StreamInterface
+    {
+        return $this->message->getBody();
+    }
+
     /**
      * @throws \JsonException
      */
     public function __toString(): string
     {
         return Json::encode($this->message);
     }
-
-    public function getStream(): StreamInterface
-    {
-        return $this->message->getBody();
-    }
 }