Make task handler route customizable

Author: marickvantuil

config/cloud-tasks.php

@@ -3,6 +3,9 @@
 declare(strict_types=1);
 
 return [
+    // The URI of the endpoint that will handle the task
+    'uri' => env('STACKKIT_CLOUD_TASKS_URI', 'handle-task'),
+
     // If the application only dispatches jobs
     'disable_task_handler' => env('STACKKIT_CLOUD_TASKS_DISABLE_TASK_HANDLER', false),
 

src/CloudTasksQueue.php

@@ -245,10 +245,10 @@ public function getHandler(): string
 
         $handler = rtrim($this->config['handler'], '/');
 
-        if (str_ends_with($handler, '/handle-task')) {
+        if (str_ends_with($handler, '/'. config('cloud-tasks.uri'))) {
             return $handler;
         }
 
-        return $handler.'/handle-task';
+        return $handler.'/'. config('cloud-tasks.uri');
     }
 }

src/CloudTasksServiceProvider.php

@@ -64,7 +64,7 @@ private function registerRoutes(): void
          */
         $router = $this->app['router'];
 
-        $router->post('handle-task', [TaskHandler::class, 'handle'])->name('cloud-tasks.handle-task');
+        $router->post(config('cloud-tasks.uri'), [TaskHandler::class, 'handle'])->name('cloud-tasks.handle-task');
     }
 
     private function registerEvents(): void

tests/ConfigHandlerTest.php

@@ -26,6 +26,35 @@ public function test_it_allows_a_handler_url_to_contain_path(string $handler, st
         });
     }
 
+    /** @test */
+    public function the_handle_route_task_uri_can_be_configured(): void
+    {
+        CloudTasksApi::fake();
+
+        $this->app['config']->set('cloud-tasks.uri', 'my-custom-route');
+
+        $this->dispatch(new SimpleJob());
+
+        CloudTasksApi::assertTaskCreated(function (Task $task) {
+            return $task->getHttpRequest()->getUrl() === 'https://docker.for.mac.localhost:8080/my-custom-route';
+        });
+    }
+
+    /** @test */
+    public function the_handle_route_task_uri_in_combination_with_path_can_be_configured(): void
+    {
+        CloudTasksApi::fake();
+
+        $this->setConfigValue('handler', 'https://example.com/api');
+        $this->app['config']->set('cloud-tasks.uri', 'my-custom-route');
+
+        $this->dispatch(new SimpleJob());
+
+        CloudTasksApi::assertTaskCreated(function (Task $task) {
+            return $task->getHttpRequest()->getUrl() === 'https://example.com/api/my-custom-route';
+        });
+    }
+
     public static function handlerDataProvider(): array
     {
         return [

tests/TestCase.php

@@ -70,8 +70,8 @@ protected function getPackageProviders($app)
      */
     protected function defineDatabaseMigrations()
     {
-//        $this->loadMigrationsFrom(__DIR__.'/../migrations');
-//        $this->loadMigrationsFrom(__DIR__.'/../vendor/orchestra/testbench-core/laravel/migrations');
+        $this->loadMigrationsFrom(__DIR__.'/../migrations');
+        $this->loadMigrationsFrom(__DIR__.'/../vendor/orchestra/testbench-core/laravel/migrations');
     }
 
     /**