laravel-workflow · rmcdaniel · Jan 9, 2025 · Nov 7, 2024 · Nov 7, 2024 · Nov 7, 2024
diff --git a/src/Activity.php b/src/Activity.php
@@ -18,6 +18,7 @@
 use LimitIterator;
 use SplFileObject;
 use Throwable;
+use Workflow\Exceptions\NonRetryableExceptionContract;
 use Workflow\Middleware\ActivityMiddleware;
 use Workflow\Middleware\WithoutOverlappingMiddleware;
 use Workflow\Models\StoredWorkflow;
@@ -93,6 +94,10 @@ public function handle()
                     'exception' => Y::serialize($throwable),
                 ]);
 
+            if ($throwable instanceof NonRetryableExceptionContract) {
+                $this->fail($throwable);
+            }
+
             throw $throwable;
         }
     }

diff --git a/src/Exceptions/NonRetryableException.php b/src/Exceptions/NonRetryableException.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workflow\Exceptions;
+
+use Exception;
+use Throwable;
+
+class NonRetryableException extends Exception implements NonRetryableExceptionContract
+{
+    public function __construct($message = '', $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}
diff --git a/src/Exceptions/NonRetryableExceptionContract.php b/src/Exceptions/NonRetryableExceptionContract.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workflow\Exceptions;
+
+interface NonRetryableExceptionContract
+{
+}
diff --git a/tests/Feature/ExceptionWorkflowTest.php b/tests/Feature/ExceptionWorkflowTest.php
@@ -4,10 +4,12 @@
 
 namespace Tests\Feature;
 
+use Tests\Fixtures\NonRetryableTestExceptionWorkflow;
 use Tests\Fixtures\TestExceptionWorkflow;
 use Tests\TestCase;
 use Workflow\Serializers\Y;
 use Workflow\States\WorkflowCompletedStatus;
+use Workflow\States\WorkflowFailedStatus;
 use Workflow\WorkflowStub;
 
 final class ExceptionWorkflowTest extends TestCase
@@ -26,4 +28,21 @@ public function testRetry(): void
             $this->assertSame('failed', Y::unserialize($workflow->exceptions()->first()->exception)['message']);
         }
     }
+
+    public function testNonRetryableException(): void
+    {
+        $workflow = WorkflowStub::make(NonRetryableTestExceptionWorkflow::class);
+
+        $workflow->start();
+
+        while ($workflow->running());
+
+        $this->assertSame(WorkflowFailedStatus::class, $workflow->status());
+        $this->assertNotNull($workflow->exceptions()->first());
+        $this->assertNull($workflow->output());
+        $this->assertSame(
+            'This is a non-retryable error',
+            Y::unserialize($workflow->exceptions()->last()->exception)['message']
+        );
+    }
 }
diff --git a/tests/Fixtures/NonRetryableTestExceptionActivity.php b/tests/Fixtures/NonRetryableTestExceptionActivity.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use Workflow\Activity;
+use Workflow\Exceptions\NonRetryableException;
+
+final class NonRetryableTestExceptionActivity extends Activity
+{
+    public function execute()
+    {
+        throw new NonRetryableException('This is a non-retryable error');
+    }
+}
diff --git a/tests/Fixtures/NonRetryableTestExceptionWorkflow.php b/tests/Fixtures/NonRetryableTestExceptionWorkflow.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use Workflow\ActivityStub;
+use Workflow\Workflow;
+
+final class NonRetryableTestExceptionWorkflow extends Workflow
+{
+    public function execute()
+    {
+        yield ActivityStub::make(NonRetryableTestExceptionActivity::class);
+        yield ActivityStub::make(TestActivity::class);
+
+        return 'Workflow completes';
+    }
+}