Setting childrenFingerprints from request onto MountedComponent

Author: weaverryan

src/LiveComponent/src/EventListener/LiveComponentSubscriber.php

@@ -13,6 +13,7 @@
 
 use Psr\Container\ContainerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\Exception\JsonException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
@@ -198,16 +199,18 @@ public function onKernelController(ControllerEvent $event): void
      *     data: array,
      *     args: array,
      *     actions: array
+     *     childrenFingerprints: array
      * }
      */
-    private function parseDataFor(Request $request): array
+    private static function parseDataFor(Request $request): array
     {
         if (!$request->attributes->has('_live_request_data')) {
             if ($request->query->has('data')) {
                 $liveRequestData = [
-                    'data' => json_decode($request->query->get('data'), true, 512, \JSON_THROW_ON_ERROR),
+                    'data' => self::parseJsonFromQuery($request, 'data'),
                     'args' => [],
                     'actions' => [],
+                    'childrenFingerprints' => self::parseJsonFromQuery($request, 'childrenFingerprints'),
                 ];
             } else {
                 $requestData = $request->toArray();
@@ -216,6 +219,7 @@ private function parseDataFor(Request $request): array
                     'data' => $requestData['data'] ?? [],
                     'args' => $requestData['args'] ?? [],
                     'actions' => $requestData['actions'] ?? [],
+                    'childrenFingerprints' => $requestData['childrenFingerprints'] ?? []
                 ];
             }
 
@@ -322,6 +326,21 @@ private function hydrateComponent(object $component, string $componentName, Requ
             $componentName
         );
 
+        $mountedComponent->addExtraMetadata('childrenFingerprints', $this->parseDataFor($request)['childrenFingerprints']);
+
         return $mountedComponent;
     }
+
+    private static function parseJsonFromQuery(Request $request, string $key): array
+    {
+        if (!$request->query->has($key)) {
+            return [];
+        }
+
+        try {
+            return json_decode($request->query->get($key), true, 512, \JSON_THROW_ON_ERROR);
+        } catch (\JsonException $exception) {
+            throw new JsonException(sprintf('Invalid JSON on query string %s.', $key), 0, $exception);
+        }
+    }
 }

src/TwigComponent/src/MountedComponent.php

@@ -20,6 +20,13 @@
  */
 final class MountedComponent
 {
+    /**
+     * Any extra metadata that might be useful to set.
+     *
+     * @var array<string, string>
+     */
+    private array $extraMetadata = [];
+
     /**
      * @param array|null $inputProps if the component was just originally created,
      *                               (not hydrated from a request), this is the
@@ -56,4 +63,23 @@ public function getInputProps(): array
 
         return $this->inputProps;
     }
+
+    public function addExtraMetadata(string $key, mixed $metadata): void
+    {
+        $this->extraMetadata[$key] = $metadata;
+    }
+
+    public function hasExtraMetadata(string $key): bool
+    {
+        return array_key_exists($key, $this->extraMetadata);
+    }
+
+    public function getExtraMetadata(string $key): mixed
+    {
+        if (!$this->hasExtraMetadata($key)) {
+            throw new \InvalidArgumentException(sprintf('No extra metadata for key "%s" found.', $key));
+        }
+
+        return $this->extraMetadata[$key];
+    }
 }