wip

src/Plugins/Tia/Edges/InertiaEdges.php

@@ -0,0 +1,202 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Plugins\Tia\Edges;
+
+use Pest\Plugins\Tia\Recorder;
+
+/**
+ * @internal
+ */
+final class InertiaEdges
+{
+    private const string CONTAINER_CLASS = '\\Illuminate\\Container\\Container';
+
+    /**
+     * Event class name used as the listener key. Stored *without* a
+     * leading backslash because Laravel's `Dispatcher` keys
+     * `$listeners[$eventName]` by the literal string passed to
+     * `listen()`, and looks up incoming events by their PHP-class
+     * name (`get_class($event)`), which never has a leading
+     * backslash. A `\Illuminate\…` key would silently never match.
+     */
+    private const string REQUEST_HANDLED_EVENT = 'Illuminate\\Foundation\\Http\\Events\\RequestHandled';
+
+    /**
+     * App-scoped marker that makes `arm()` idempotent across per-test
+     * `setUp()` calls. Laravel reuses the same app across tests in
+     * most configurations — without this guard we'd stack one
+     * listener per test.
+     */
+    private const string MARKER = 'pest.tia.inertia-edges-armed';
+
+    public static function arm(Recorder $recorder): void
+    {
+        if (! $recorder->isActive()) {
+            return;
+        }
+
+        $containerClass = self::CONTAINER_CLASS;
+
+        if (! class_exists($containerClass)) {
+            return;
+        }
+
+        /** @var object $app */
+        $app = $containerClass::getInstance();
+
+        if (! method_exists($app, 'bound') || ! method_exists($app, 'make') || ! method_exists($app, 'instance')) {
+            return;
+        }
+
+        if ($app->bound(self::MARKER)) {
+            return;
+        }
+
+        if (! $app->bound('events')) {
+            return;
+        }
+
+        $app->instance(self::MARKER, true);
+
+        /** @var object $events */
+        $events = $app->make('events');
+
+        if (! method_exists($events, 'listen')) {
+            return;
+        }
+
+        $events->listen(self::REQUEST_HANDLED_EVENT, static function (object $event) use ($recorder): void {
+            if (! property_exists($event, 'response')) {
+                return;
+            }
+
+            /** @var mixed $response */
+            $response = $event->response;
+
+            if (! is_object($response)) {
+                return;
+            }
+
+            $component = self::extractComponent($response);
+
+            if ($component !== null) {
+                $recorder->linkInertiaComponent($component);
+            }
+        });
+    }
+
+    /**
+     * Pulls the Inertia component name out of a Laravel response,
+     * handling both XHR (`X-Inertia` + JSON body) and full HTML
+     * (`<div id="app" data-page="…">`) shapes. Returns null for any
+     * non-Inertia response so the caller can ignore it cheaply.
+     */
+    private static function extractComponent(object $response): ?string
+    {
+        // XHR path: Inertia sets an `X-Inertia: true` header and the
+        // body is JSON with a `component` key.
+        if (property_exists($response, 'headers') && is_object($response->headers)) {
+            $headers = $response->headers;
+
+            if (method_exists($headers, 'has') && $headers->has('X-Inertia')) {
+                $content = self::readContent($response);
+
+                if ($content !== null) {
+                    /** @var mixed $decoded */
+                    $decoded = json_decode($content, true);
+
+                    if (is_array($decoded)
+                        && isset($decoded['component'])
+                        && is_string($decoded['component'])
+                        && $decoded['component'] !== '') {
+                        return $decoded['component'];
+                    }
+                }
+            }
+        }
+
+        // Initial-load HTML path. Inertia ships two shapes here and
+        // we honour both:
+        //
+        //   1. SSR-safe script tag — `<script data-page="app"
+        //      type="application/json">{…JSON…}</script>`. The
+        //      Laravel React starter kit (and modern Inertia-React)
+        //      use this so the JSON survives server-rendered
+        //      hydration without HTML-encoding the payload into an
+        //      attribute. The `data-page="app"` *attribute value* is
+        //      the literal string `"app"` — only the tag *body*
+        //      carries the page JSON.
+        //   2. Classic — `<div id="app" data-page="{…JSON…}">…`. Older
+        //      Inertia-Vue and Inertia-React still emit this. Here
+        //      `data-page` IS the JSON, HTML-entity-encoded.
+        //
+        // Try the script-tag shape first; if the response uses it,
+        // the classic regex would also see a `data-page="app"` token
+        // and try to JSON-decode the literal string `"app"`.
+        $content = self::readContent($response);
+
+        if ($content === null) {
+            return null;
+        }
+
+        // Lookahead pair handles arbitrary attribute order on the
+        // `<script>` tag.
+        if (str_contains($content, 'type="application/json"')
+            && preg_match('#<script\b(?=[^>]*\bdata-page="app")(?=[^>]*\btype="application/json")[^>]*>(.+?)</script>#s', $content, $match) === 1) {
+            $component = self::componentFromJson(html_entity_decode($match[1]));
+
+            if ($component !== null) {
+                return $component;
+            }
+        }
+
+        // Classic: only accept a value that looks like a JSON object
+        // (`{…}`). Avoids matching the script-tag form's
+        // `data-page="app"` attribute when both shapes coexist.
+        if (str_contains($content, 'data-page=')
+            && preg_match('/\sdata-page="(\{[^"]+\})"/', $content, $match) === 1) {
+            $component = self::componentFromJson(html_entity_decode($match[1]));
+
+            if ($component !== null) {
+                return $component;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Parses an Inertia page JSON blob and returns the `component`
+     * field if it's a non-empty string. Used by both the script-tag
+     * and the `data-page`-attribute paths so the success criteria are
+     * identical.
+     */
+    private static function componentFromJson(string $json): ?string
+    {
+        /** @var mixed $decoded */
+        $decoded = json_decode($json, true);
+
+        if (is_array($decoded)
+            && isset($decoded['component'])
+            && is_string($decoded['component'])
+            && $decoded['component'] !== '') {
+            return $decoded['component'];
+        }
+
+        return null;
+    }
+
+    private static function readContent(object $response): ?string
+    {
+        if (! method_exists($response, 'getContent')) {
+            return null;
+        }
+
+        /** @var mixed $content */
+        $content = $response->getContent();
+
+        return is_string($content) ? $content : null;
+    }
+}