Merge pull request #258 from laravel-workflow/serializes-models

Fixed support for SerializesModels

Author: rmcdaniel

src/Activity.php

@@ -11,7 +11,6 @@
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
 use Illuminate\Routing\RouteDependencyResolverTrait;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Cache;
@@ -24,6 +23,7 @@
 use Workflow\Middleware\WithoutOverlappingMiddleware;
 use Workflow\Models\StoredWorkflow;
 use Workflow\Serializers\Serializer;
+use Workflow\Traits\SerializesModels;
 
 class Activity implements ShouldBeEncrypted, ShouldQueue
 {

src/Traits/SerializesModels.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workflow\Traits;
+
+use Illuminate\Queue\SerializesModels as LaravelSerializesModels;
+
+trait SerializesModels
+{
+    use LaravelSerializesModels {
+        getSerializedPropertyValue as parentGetSerializedPropertyValue;
+        getRestoredPropertyValue as parentGetRestoredPropertyValue;
+    }
+
+    public function getSerializedPropertyValue($value)
+    {
+        if (is_array($value)) {
+            $result = [];
+            foreach ($value as $index => $item) {
+                $result[$index] = $this->parentGetSerializedPropertyValue($item);
+            }
+            return $result;
+        }
+
+        return $this->parentGetSerializedPropertyValue($value);
+    }
+
+    public function getRestoredPropertyValue($value)
+    {
+        if (is_array($value)) {
+            $result = [];
+            foreach ($value as $index => $item) {
+                $result[$index] = $this->parentGetRestoredPropertyValue($item);
+            }
+            return $result;
+        }
+
+        return $this->parentGetRestoredPropertyValue($value);
+    }
+}

src/Workflow.php

@@ -12,7 +12,6 @@
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
 use Illuminate\Routing\RouteDependencyResolverTrait;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\App;
@@ -27,6 +26,7 @@
 use Workflow\States\WorkflowRunningStatus;
 use Workflow\States\WorkflowWaitingStatus;
 use Workflow\Traits\Sagas;
+use Workflow\Traits\SerializesModels;
 
 class Workflow implements ShouldBeEncrypted, ShouldQueue
 {

tests/Fixtures/TestModelActivity.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use Workbench\App\Models\User;
+use Workflow\Activity;
+
+class TestModelActivity extends Activity
+{
+    public function execute(User $user)
+    {
+        return $user->id;
+    }
+}

tests/Fixtures/TestModelWorkflow.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use Workbench\App\Models\User;
+use Workflow\ActivityStub;
+use Workflow\Workflow;
+
+class TestModelWorkflow extends Workflow
+{
+    public function execute(User $user)
+    {
+        $result = yield ActivityStub::make(TestModelActivity::class, $user);
+
+        return $result;
+    }
+}

tests/Unit/Traits/SerializesModelsTest.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Traits;
+
+use Illuminate\Contracts\Database\ModelIdentifier;
+use Tests\Fixtures\TestModelActivity;
+use Tests\Fixtures\TestModelWorkflow;
+use Tests\TestCase;
+use Workbench\App\Models\User;
+use Workflow\Models\StoredWorkflow;
+
+class SerializesModelsTest extends TestCase
+{
+    public function testActivityJobSerializationWithModel(): void
+    {
+        $user = User::create([
+            'name' => 'Test User',
+            'email' => 'test@example.com',
+            'password' => 'password',
+        ]);
+
+        $storedWorkflow = StoredWorkflow::create([
+            'class' => TestModelWorkflow::class,
+        ]);
+        $activity = new TestModelActivity(0, now()->toDateTimeString(), $storedWorkflow, $user);
+
+        $serialized = serialize($activity);
+
+        $unserialized = unserialize($serialized);
+
+        $userArgument = $unserialized->arguments[0];
+
+        $this->assertStringContainsString(ModelIdentifier::class, $serialized);
+        $this->assertStringNotContainsString($user->email, $serialized);
+        $this->assertInstanceOf(User::class, $userArgument);
+        $this->assertEquals($user->id, $userArgument->id);
+    }
+
+    public function testWorkflowJobSerializationWithModel(): void
+    {
+        $user = User::create([
+            'name' => 'Test User',
+            'email' => 'test@example.com',
+            'password' => 'password',
+        ]);
+
+        $storedWorkflow = StoredWorkflow::create([
+            'class' => TestModelWorkflow::class,
+        ]);
+        $workflow = new TestModelWorkflow($storedWorkflow, $user);
+
+        $serialized = serialize($workflow);
+
+        $unserialized = unserialize($serialized);
+
+        $userArgument = $unserialized->arguments[0];
+
+        $this->assertStringContainsString(ModelIdentifier::class, $serialized);
+        $this->assertStringNotContainsString($user->email, $serialized);
+        $this->assertInstanceOf(User::class, $userArgument);
+        $this->assertEquals($user->id, $userArgument->id);
+    }
+}