Merge pull request #272 from laravel-workflow/fix-webhook-route-prefixes

Fix webhookUrl() to account for route prefixes

Author: rmcdaniel

src/Activity.php

@@ -76,15 +76,16 @@ public function workflowId()
 
     public function webhookUrl(string $signalMethod = ''): string
     {
-        $basePath = config('workflows.webhooks_route', '/webhooks');
         $workflow = Str::kebab(class_basename($this->storedWorkflow->class));
 
         if ($signalMethod === '') {
-            return url("{$basePath}/{$workflow}");
+            return route("workflows.start.{$workflow}");
         }
 
         $signal = Str::kebab($signalMethod);
-        return url("{$basePath}/signal/{$workflow}/{$this->storedWorkflow->id}/{$signal}");
+        return route("workflows.signal.{$workflow}.{$signal}", [
+            'workflowId' => $this->storedWorkflow->id,
+        ]);
     }
 
     public function handle()

src/Webhooks.php

@@ -85,7 +85,7 @@ private static function registerWorkflowWebhooks($workflow, $basePath)
                     return response()->json([
                         'message' => 'Workflow started',
                     ]);
-                });
+                })->name("workflows.start.{$slug}");
             }
         }
     }
@@ -111,7 +111,7 @@ static function (Request $request, $workflowId) use ($workflow, $method) {
                             'message' => 'Signal sent',
                         ]);
                     }
-                );
+                )->name("workflows.signal.{$slug}.{$signal}");
             }
         }
     }

tests/Fixtures/TestWorkflow.php

@@ -8,9 +8,11 @@
 use Workflow\ActivityStub;
 use Workflow\QueryMethod;
 use Workflow\SignalMethod;
+use Workflow\Webhook;
 use Workflow\Workflow;
 use Workflow\WorkflowStub;
 
+#[Webhook]
 class TestWorkflow extends Workflow
 {
     public $connection = 'redis';
@@ -20,6 +22,7 @@ class TestWorkflow extends Workflow
     private bool $canceled = false;
 
     #[SignalMethod]
+    #[Webhook]
     public function cancel(): void
     {
         $this->canceled = true;

tests/Unit/ActivityTest.php

@@ -17,6 +17,7 @@
 use Workflow\Serializers\Serializer;
 use Workflow\States\WorkflowCreatedStatus;
 use Workflow\States\WorkflowFailedStatus;
+use Workflow\Webhooks;
 use Workflow\WorkflowStub;
 
 final class ActivityTest extends TestCase
@@ -125,12 +126,14 @@ public function testActivityAlreadyComplete(): void
 
     public function testWebhookUrl(): void
     {
+        Webhooks::routes('Tests\\Fixtures', __DIR__ . '/../Fixtures');
+
         $workflow = WorkflowStub::load(WorkflowStub::make(TestWorkflow::class)->id());
         $activity = new TestOtherActivity(0, now()->toDateTimeString(), StoredWorkflow::findOrFail($workflow->id()), [
             'other',
         ]);
 
-        $this->assertSame('http://localhost/webhooks/test-workflow', $activity->webhookUrl());
-        $this->assertSame('http://localhost/webhooks/signal/test-workflow/1/other', $activity->webhookUrl('other'));
+        $this->assertSame('http://localhost/webhooks/start/test-workflow', $activity->webhookUrl());
+        $this->assertSame('http://localhost/webhooks/signal/test-workflow/1/cancel', $activity->webhookUrl('cancel'));
     }
 }

tests/Unit/WebhooksTest.php

@@ -313,19 +313,13 @@ public function testResolveNamedParametersUsesDefaults()
 
     public function testWebhookRegistration()
     {
-        $response = $this->postJson('/webhooks/signal/test-webhook-workflow/1/cancel');
-
-        Route::shouldReceive('post')
-            ->once()
-            ->withArgs(static function ($uri, $callback) {
-                return str_contains($uri, 'webhooks/start/test-webhook-workflow');
-            });
+        $routeMock = Mockery::mock();
+        $routeMock->shouldReceive('name')
+            ->andReturnSelf();
 
         Route::shouldReceive('post')
-            ->once()
-            ->withArgs(static function ($uri, $callback) {
-                return str_contains($uri, 'webhooks/signal/test-webhook-workflow/{workflowId}/cancel');
-            });
+            ->times(4)
+            ->andReturn($routeMock);
 
         Webhooks::routes('Tests\\Fixtures', __DIR__ . '/../Fixtures');
     }