Add support for App Engine task

Author: miccehedin

README.md

@@ -85,7 +85,9 @@ Please check the table below on what the values mean and what their value should
 | `STACKKIT_CLOUD_TASKS_LOCATION`                   | The region where the project is hosted.                                                                                                                  |`europe-west6`
 | `STACKKIT_CLOUD_TASKS_QUEUE`                      | The default queue a job will be added to.                                                                                                                |`emails`
 | `STACKKIT_CLOUD_TASKS_CREDENTIAL_FILE` (optional) | A json credential file to authenticate the connection (from outside AppEngine)                                                                           |`project-123.json`
-| `STACKKIT_CLOUD_TASKS_SERVICE_EMAIL`              | The email address of the service account. Important, it should have the correct roles. See the section below which roles.                                |`[email protected]`
+| `STACKKIT_APP_ENGINE_TASK` (optional)             | Set to true to use App Engine task (else a Http task will be used). Defaults to false.                                                                   |`true`
+| `STACKKIT_APP_ENGINE_SERVICE` (optional)          | The App Engine service to handle the task (only if using App Engine task).                                                                               |`api`
+| `STACKKIT_CLOUD_TASKS_SERVICE_EMAIL`   (optional) | The email address of the service account. Important, it should have the correct roles. See the section below which roles.                                |`[email protected]`
 | `STACKKIT_CLOUD_TASKS_HANDLER` (optional)         | The URL that Cloud Tasks will call to process a job. This should be the URL to your Laravel app. By default we will use the URL that dispatched the job. |`https://<your website>.com`
 | `STACKKIT_CLOUD_TASKS_SIGNED_AUDIENCE` (optional) | True or false depending if you want extra security by signing the audience of your tasks. May misbehave in certain Cloud Run setups. Defaults to true.   | `true`
 </details>
@@ -101,6 +103,7 @@ With Cloud Tasks, this is not the case. Instead, Cloud Tasks will schedule the j
 
 #### Good to know
 
+- If `STACKKIT_APP_ENGINE_TASK` is true, `STACKKIT_CLOUD_TASKS_SERVICE_EMAIL` and `STACKKIT_CLOUD_TASKS_HANDLER` will be ignored.
 - The "Min backoff" and "Max backoff" options in Cloud Tasks are ignored. This is intentional: Laravel has its own backoff feature (which is more powerful than what Cloud Tasks offers) and therefore I have chosen that over the Cloud Tasks one.
 - Similarly to the backoff feature, I have also chosen to let the package do job retries the 'Laravel way'. In Cloud Tasks, when a task throws an exception, Cloud Tasks will decide for itself when to retry the task (based on the backoff values). It will also manage its own state and knows how many times a task has been retried. This is different from Laravel. In typical Laravel queues, when a job throws an exception, the job is deleted and released back onto the queue. In order to support Laravel's backoff feature, this package must behave the same way about job retries.
 

src/CloudTasksQueue.php

@@ -2,6 +2,8 @@
 
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
+use Google\Cloud\Tasks\V2\AppEngineHttpRequest;
+use Google\Cloud\Tasks\V2\AppEngineRouting;
 use Google\Cloud\Tasks\V2\CloudTasksClient;
 use Google\Cloud\Tasks\V2\HttpMethod;
 use Google\Cloud\Tasks\V2\HttpRequest;
@@ -136,10 +138,6 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
         $queueName = $this->client->queueName($this->config['project'], $this->config['location'], $queue);
         $availableAt = $this->availableAt($delay);
 
-        $httpRequest = $this->createHttpRequest();
-        $httpRequest->setUrl($this->getHandler());
-        $httpRequest->setHttpMethod(HttpMethod::POST);
-
         $payload = json_decode($payload, true);
 
         // Laravel 7+ jobs have a uuid, but Laravel 6 doesn't have it.
@@ -152,11 +150,38 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
         // value and need to manually set and update the number of times a task has been attempted.
         $payload = $this->withAttempts($payload);
 
-        $httpRequest->setBody(json_encode($payload));
-
         $task = $this->createTask();
         $task->setName($this->taskName($queue, $payload));
-        $task->setHttpRequest($httpRequest);
+
+        if ($this->config['app_engine']) {
+            $path = \Safe\parse_url(route('cloud-tasks.handle-task'), PHP_URL_PATH);
+
+            $appEngineRequest = new AppEngineHttpRequest();
+            $appEngineRequest->setRelativeUri($path);
+            $appEngineRequest->setHttpMethod(HttpMethod::POST);
+            $appEngineRequest->setBody(json_encode($payload));
+            if (!empty($service = $this->config['app_engine_service'])) {
+                $routing = new AppEngineRouting();
+                $routing->setService($service);
+                $appEngineRequest->setAppEngineRouting($routing);
+            }
+            $task->setAppEngineHttpRequest($appEngineRequest);
+        } else {
+            $httpRequest = $this->createHttpRequest();
+            $httpRequest->setUrl($this->getHandler());
+            $httpRequest->setHttpMethod(HttpMethod::POST);
+
+            $httpRequest->setBody(json_encode($payload));
+
+            $token = new OidcToken;
+            $token->setServiceAccountEmail($this->config['service_account_email']);
+            if ($audience = $this->getAudience()) {
+                $token->setAudience($audience);
+            }
+            $httpRequest->setOidcToken($token);
+            $task->setHttpRequest($httpRequest);
+        }
+
 
         // The deadline for requests sent to the app. If the app does not respond by
         // this deadline then the request is cancelled and the attempt is marked as
@@ -165,13 +190,6 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
             $task->setDispatchDeadline(new Duration(['seconds' => $this->config['dispatch_deadline']]));
         }
 
-        $token = new OidcToken;
-        $token->setServiceAccountEmail($this->config['service_account_email']);
-        if ($audience = $this->getAudience()) {
-            $token->setAudience($audience);
-        }
-        $httpRequest->setOidcToken($token);
-
         if ($availableAt > time()) {
             $task->setScheduleTime(new Timestamp(['seconds' => $availableAt]));
         }

src/Config.php

@@ -19,8 +19,8 @@ public static function validate(array $config): void
             throw new Error(Errors::invalidLocation());
         }
 
-        if (empty($config['service_account_email'])) {
-            throw new Error(Errors::invalidServiceAccountEmail());
+        if (empty($config['service_account_email']) && empty($config['app-engine'])) {
+            throw new Error(Errors::serviceAccountOrAppEngine());
         }
     }
 
@@ -42,25 +42,29 @@ public static function getHandler($handler): string
             // (still) set to localhost. That will never work because Cloud Tasks
             // should always call a public address / hostname to process tasks.
             if (in_array($parse['host'], ['localhost', '127.0.0.1', '::1'])) {
-                throw new Exception(sprintf(
-                    'Unable to push task to Cloud Tasks because the handler URL is set to a local host: %s. ' .
-                    'This does not work because Google is not able to call the given local URL. ' .
-                    'If you are developing on locally, consider using Ngrok or Expose for Laravel to expose your local ' .
-                    'application to the internet.',
-                    $handler
-                ));
+                throw new Exception(
+                    sprintf(
+                        'Unable to push task to Cloud Tasks because the handler URL is set to a local host: %s. ' .
+                        'This does not work because Google is not able to call the given local URL. ' .
+                        'If you are developing on locally, consider using Ngrok or Expose for Laravel to expose your local ' .
+                        'application to the internet.',
+                        $handler
+                    )
+                );
             }
 
             // When the application is running behind a proxy and the TrustedProxy middleware has not been set up yet,
             // an error like [HttpRequest.url must start with 'https'] could be thrown. Since the handler URL must
             // always be https, we will provide a little extra information on how to fix this.
             if ($parse['scheme'] !== 'https') {
-                throw new Exception(sprintf(
-                    'Unable to push task to Cloud Tasks because the hander URL is not https. Google Cloud Tasks ' .
-                    'will only call safe (https) URLs. If you are running Laravel behind a proxy (e.g. Ngrok, Expose), make sure it is ' .
-                    'as a trusted proxy. To quickly fix this, add the following to the [app/Http/Middleware/TrustProxies] middleware: ' .
-                    'protected $proxies = \'*\';'
-                ));
+                throw new Exception(
+                    sprintf(
+                        'Unable to push task to Cloud Tasks because the hander URL is not https. Google Cloud Tasks ' .
+                        'will only call safe (https) URLs. If you are running Laravel behind a proxy (e.g. Ngrok, Expose), make sure it is ' .
+                        'as a trusted proxy. To quickly fix this, add the following to the [app/Http/Middleware/TrustProxies] middleware: ' .
+                        'protected $proxies = \'*\';'
+                    )
+                );
             }
 
             $trimmedHandlerUrl = rtrim($handler, '/');

src/Errors.php

@@ -18,4 +18,9 @@ public static function invalidServiceAccountEmail(): string
     {
         return 'Google Service Account email address not provided. This is needed to secure the handler so it is only accessible by Google. To fix this, set the STACKKIT_CLOUD_TASKS_SERVICE_EMAIL environment variable';
     }
+
+    public static function serviceAccountOrAppEngine(): string
+    {
+        return 'A Google Service Account email or App Engine Request must be set. Set STACKKIT_CLOUD_TASKS_SERVICE_EMAIL or STACKKIT_APP_ENGINE_TASK';
+    }
 }