Download the PHP package stackkit/laravel-google-cloud-tasks-queue without Composer

Cloud Tasks queue driver for Laravel

This package allows Google Cloud Tasks to be used as the queue driver.

_{Companion packages: Cloud Scheduler, Cloud Logging}

Requirements

This package requires Laravel 11 or 12.

Installation

Require the package using Composer

Add a new queue connection to config/queue.php

Finally, set the correct environment variables.

If you're using Cloud Run:

If you're using App Engine:

Please check the table below on what the values mean and what their value should be.

Optionally, you may publish the config file:

If you are using separate services for dispatching and handling tasks, and your application only dispatches jobs and should not be able to handle jobs, you may disable the task handler from config/cloud-tasks.php:

How to

Passing headers to a task

You can pass headers to a task by using the setTaskHeadersUsing method on the CloudTasksQueue class.

If necessary, the current payload being dispatched is also available:

Configure task handler url

You can set the handler url for a task by using the configureHandlerUrlUsing method on the CloudTasksQueue class.

If necessary, the current job being dispatched is also available:

Configure worker options

You can configure worker options by using the configureWorkerOptionsUsing method on the CloudTasksQueue class.

Use a custom credentials file

Modify (or add) the client_options key in the config/cloud-tasks.php file:

Modify CloudTasksClient options

Modify (or add) the client_options key in the config/cloud-tasks.php file:

How it works and differences

Using Cloud Tasks as a Laravel queue driver is fundamentally different than other Laravel queue drivers, like Redis.

Typically a Laravel queue has a worker that listens to incoming jobs using the queue:work / queue:listen command. With Cloud Tasks, this is not the case. Instead, Cloud Tasks will schedule the job for you and make an HTTP request to your application with the job payload. There is no need to run a queue:work/listen command.

Good to know

Cloud Tasks has it's own retry configuration options: maximum number of attempts, retry duration, min/max backoff and max doublings. All of these options are ignored by this package. Instead, you may configure max attempts, retry duration and backoff strategy right from Laravel.

Authentication

If you're not using your master service account (which has all abilities), you must add the following roles to make it works:

1. App Engine Viewer
2. Cloud Tasks Enqueuer
3. Cloud Tasks Viewer
4. Cloud Tasks Task Deleter
5. Service Account User

Upgrading

Read UPGRADING.MD on how to update versions.

Troubleshooting

HttpRequest.url must start with 'https://'

This can happen when your application runs behind a reverse proxy. To fix this, add the application domain to Laravel's trusted proxies. You may need to add the wildcard * as trusted proxy.

Maximum call stack size (zend.max_allowed_stack_size - zend.reserved_stack_size) reached. Infinite recursion?

This currently seems to be a bug with PHP 8.3 and googleapis/gax-php. See this issue for more information.

A potential workaround is to disable PHP 8.3 call stack limit by setting this value in php.ini:

Contributing

You can use the services defined in docker-compose.yml to start running the package.

Inside the container, run composer install.

Set up the environment: cp .env.example .env

Some tests hit the Cloud Tasks API and need a project and key to be able to hit it. See the variables in .env