handle serialization

Signed-off-by: Robert Landers <landers.robert@gmail.com>

Author: withinboredom

composer.json

@@ -29,25 +29,25 @@
   "license": "MIT",
   "name": "bottledcode/durable-php",
   "require": {
-    "adhocore/cli": "^1.7.1",
-    "amphp/file": "^3.1.1",
-    "amphp/http-client": "^5.1.0",
+    "adhocore/cli": "^1.9.4",
+    "amphp/file": "^3.2.0",
+    "amphp/http-client": "^5.3.3",
     "amphp/log": "^v2.0.0",
-    "amphp/parallel": "^2.2.9",
-    "crell/serde": "^1.2.0",
+    "amphp/parallel": "^2.3.1",
+    "crell/serde": "^1.5.0",
     "nesbot/carbon": ">2.0",
-    "nikic/php-parser": "^5.1",
+    "nikic/php-parser": "^5.6",
     "php": ">=8.4",
-    "php-di/php-di": "^7.0.7",
-    "ramsey/uuid": "^4.7.6",
-    "webonyx/graphql-php": "^15.12.5",
-    "withinboredom/records": "v0.1.2",
+    "php-di/php-di": "^7.0.11",
+    "ramsey/uuid": "^4.9.0",
+    "webonyx/graphql-php": "^15.22.0",
+    "withinboredom/records": "^0.1.3",
     "withinboredom/time": "^6.0.0"
   },
   "require-dev": {
-    "laravel/pint": "^1.17.2",
+    "laravel/pint": "^1.24.0",
     "mockery/mockery": "^1.6.12",
-    "pestphp/pest": "^2.35.1 || ^3.0.0"
+    "pestphp/pest": "^2.35.1 || ^3.8.2"
   },
   "scripts": {
     "test": "pest"

src/Events/EventDescription.php

@@ -159,6 +159,7 @@ public static function fromStream(string $data): self
         $data = base64_decode($data, true);
         $data = function_exists('gzdecode') ? gzdecode($data) : $data;
         $data = function_exists('igbinary_unserialize') ? igbinary_unserialize($data) : unserialize($data);
+        $data = Serializer::deserialize($data, Event::class);
 
         return new self($data);
     }
@@ -175,8 +176,10 @@ public static function fromJson(string $json): EventDescription
 
     public function toStream(): string
     {
+        $serialized = Serializer::serialize($this->event);
+
         $serialized =
-            function_exists('igbinary_serialize') ? igbinary_serialize($this->event) : serialize($this->event);
+            function_exists('igbinary_serialize') ? igbinary_serialize($serialized) : serialize($serialized);
         $serialized = function_exists('gzencode') ? gzencode($serialized) : $serialized;
 
         $event = base64_encode($serialized);

src/Glue/glue.php

@@ -88,7 +88,7 @@ public function __construct(private DurableLogger $logger)
         $this->method = $_SERVER['HTTP_DPHP_FUNCTION'];
         try {
             $provenance = json_decode($_SERVER['HTTP_DPHP_PROVENANCE'] ?? 'null', true, 32, JSON_THROW_ON_ERROR);
-            if (!$provenance || $provenance === ['userId' => '', 'roles' => null]) {
+            if (! $provenance || $provenance === ['userId' => '', 'roles' => null]) {
                 $this->provenance = null;
             } else {
                 $provenance['roles'] ??= [];
@@ -102,7 +102,7 @@ public function __construct(private DurableLogger $logger)
             $this->provenance = null;
         }
 
-        if (!file_exists($_SERVER['HTTP_DPHP_PAYLOAD'])) {
+        if (! file_exists($_SERVER['HTTP_DPHP_PAYLOAD'])) {
             throw new LogicException('Unable to load payload');
         }
 
@@ -192,7 +192,7 @@ public function outputEvent(EventDescription $event): void
 
     private function startOrchestration(): void
     {
-        if (!$this->target->toOrchestrationInstance()->executionId) {
+        if (! $this->target->toOrchestrationInstance()->executionId) {
             $this->target = StateId::fromInstance(
                 OrchestrationInstance(
                     $this->target->toOrchestrationInstance()->instanceId,
@@ -204,8 +204,7 @@ private function startOrchestration(): void
         header('X-Id: ' . $this->target->id);
         $input = SerializedArray::import($this->payload['input'])->toArray();
 
-        $event =
-            WithOrchestration::forInstance($this->target, StartExecution::asParent($input, []/* todo: scheduling */));
+        $event = WithOrchestration::forInstance($this->target, StartExecution::asParent($input, []/* todo: scheduling */));
         $this->outputEvent(new EventDescription($event));
 
         $actualId = $this->target->toOrchestrationInstance();

src/State/EntityId.php

@@ -33,26 +33,17 @@
 readonly class EntityId extends Record implements Stringable
 {
     public protected(set) string $name;
+
     public protected(set) string $id;
 
     /**
-     * @param class-string<T> $name
-     * @param string $id
-     * @return static
+     * @param  class-string<T>  $name
      */
     public static function from(string $name, string $id): static
     {
         return self::fromArgs(name: $name, id: $id);
     }
 
-    protected static function create(...$args): static
-    {
-        $obj = parent::create($args);
-        $obj->name = $args['name'];
-        $obj->id = $args['id'];
-        return $obj;
-    }
-
     public function __toString(): string
     {
         return $this->name . ':' . $this->id;

src/State/Exporter.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace bottledcode\DurablePhp\State;
+
+use Crell\Serde\Attributes\Field;
+use Crell\Serde\Deserializer;
+use Crell\Serde\PropertyHandler\DictionaryExporter;
+use Crell\Serde\Serializer;
+use Override;
+use ReflectionClass;
+use Withinboredom\Record;
+
+class Exporter extends DictionaryExporter
+{
+    #[Override]
+    public function exportValue(Serializer $serializer, Field $field, mixed $value, mixed $runningValue): mixed
+    {
+        assert($value instanceof Record);
+
+        $ref = new ReflectionClass($value);
+        $id = $ref->getMethod('getIdentity')->invoke($value);
+
+        return parent::exportValue($serializer, $field, $id, $runningValue);
+    }
+
+    public function canExport(Field $field, mixed $value, string $format): bool
+    {
+        return $value instanceof Record;
+    }
+
+    public function importValue(Deserializer $deserializer, Field $field, mixed $source): mixed
+    {
+        $reflectedRecord = new ReflectionClass($field->phpType);
+        $record = $reflectedRecord->getMethod('fromArgs')->invoke(null, ...($source['root']));
+
+        return $record;
+    }
+
+    public function canImport(Field $field, string $format): bool
+    {
+        return is_a($field->phpType, Record::class, true);
+    }
+}

src/State/OrchestrationInstance.php

@@ -38,15 +38,6 @@ public static function from(string $instanceId, string $executionId): static
         return static::fromArgs(instanceId: $instanceId, executionId: $executionId);
     }
 
-    protected static function create(...$args): static
-    {
-        $obj = parent::create($args);
-        $obj->instanceId = $args['instanceId'];
-        $obj->executionId = $args['executionId'];
-
-        return $obj;
-    }
-
     public function __toString(): string
     {
         return "{$this->instanceId}:{$this->executionId}";

src/State/Serializer.php

@@ -38,11 +38,7 @@ public static function serialize(mixed $value, array $scopes = []): array
             return self::get()->serialize($value, 'array', scopes: $scopes);
         }
         if (is_array($value)) {
-            $result = [];
-            foreach ($value as $k => $v) {
-                $result[$k] = self::serialize($v, $scopes);
-            }
-            return $result;
+            return array_map(static fn($v) => self::serialize($v, $scopes), $value);
         }
         if (is_scalar($value) || $value === null) {
             return compact('value');
@@ -53,13 +49,13 @@ public static function serialize(mixed $value, array $scopes = []): array
 
     public static function get(): Serde
     {
-        return self::$serializer ??= new SerdeCommon();
+        return self::$serializer ??= new SerdeCommon(handlers: [new Exporter()]);
     }
 
     /**
      * @template T
-     * @param array $value
-     * @param class-string<T> $type
+     *
+     * @param  class-string<T>  $type
      * @return T
      */
     public static function deserialize(array $value, string $type): mixed

tests/Unit/EventDescriptionTest.php

@@ -279,6 +279,9 @@ public function __toString(): string
     $stream = json_decode($stream, true);
     $result = EventDescription::fromStream($stream['event']);
 
+    // hack around serialization of timestamps
+    $description = new EventDescription($event->with(timestamp: $result->event->timestamp));
+
     expect($result)->toEqual($description);
 });
 

tests/Unit/RecordTest.php

@@ -0,0 +1,22 @@
+<?php
+
+use Bottledcode\DurablePhp\State\EntityId;
+use Bottledcode\DurablePhp\State\OrchestrationInstance;
+use Bottledcode\DurablePhp\State\Serializer;
+
+use function Bottledcode\DurablePhp\EntityId;
+use function Bottledcode\DurablePhp\OrchestrationInstance;
+
+it('can serialize an entity id', function (): void {
+    $record = EntityId('name', 'id');
+    $result = Serializer::serialize($record);
+    $result = Serializer::deserialize($result, EntityId::class);
+    expect($result)->toBe($record);
+});
+
+it('can serialize an orchestration id', function (): void {
+    $record = OrchestrationInstance('name', 'id');
+    $result = Serializer::serialize($record);
+    $result = Serializer::deserialize($result, OrchestrationInstance::class);
+    expect($result)->toBe($record);
+});