Rewrite readme and cleanup

Author: marickvantuil

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.0.0 - 2022-04-03
+
+**Added**
+
+- Added support for PostgreSQL
+- Added a dashboard used to monitor jobs
+
+**Removed**
+
+- Dropped support for PHP 7.2 and 7.3
+- Dropped support for Laravel 5.x
+
 ## 2.3.0 - 2022-02-09
 
 **Changed**

README.md

@@ -21,7 +21,7 @@ This package allows Google Cloud Tasks to be used as the queue driver.
   </summary>
 
   <br>
-  This package requires Laravel 6 or higher.
+  This package requires Laravel 6 or higher and supports MySQL 8 and PostgreSQL 14. Might support older database versions too, but package hasn't been tested for it.
 
 Please check the table below for supported Laravel and PHP versions:
 
@@ -36,18 +36,15 @@ Please check the table below for supported Laravel and PHP versions:
   <summary>Installation</summary>
   <br>
 
-(1) Require the package using Composer
+  Require the package using Composer
 
-  ```bash
+  ```console
   composer require stackkit/laravel-google-cloud-tasks-queue
   ```
 
+  Add a new queue connection to `config/queue.php`
 
-[Official documentation - Creating Cloud Tasks queues](https://cloud.google.com/tasks/docs/creating-queues)
-
-(2) Add a new queue connection to `config/queue.php`
-
-  ```
+  ```php
   'cloudtasks' => [
       'driver' => 'cloudtasks',
       'project' => env('STACKKIT_CLOUD_TASKS_PROJECT', ''),
@@ -58,33 +55,23 @@ Please check the table below for supported Laravel and PHP versions:
   ],
   ```
 
-(3) Update the `QUEUE_CONNECTION` environment variable
+Update the `QUEUE_CONNECTION` environment variable
 
-  ```
+  ```dotenv
   QUEUE_CONNECTION=cloudtasks
   ```
 
-(4) [Laravel ^8.0 and above only] configure failed tasks to use the `database-uuids` driver in `config/queue.php`
-
-  ```
-  'failed' => [
-      'database' => env('DB_CONNECTION', 'mysql'),
-      'table' => 'failed_jobs',
-      'driver' => 'database-uuids',
-  ],
-  ```
-
 Now that the package is installed, the final step is to set the correct environment variables.
 
 Please check the table below on what the values mean and what their value should be.
 
-| Environment variable                 | Description                                                                                                                                                                                |Example
---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---
-| `STACKKIT_CLOUD_TASKS_PROJECT`       | The project your queue belongs to.                                                                                                                                                         |`my-project`
-| `STACKKIT_CLOUD_TASKS_LOCATION`      | The region where the AppEngine is hosted                                                                                                                                                   |`europe-west6`
-| `STACKKIT_CLOUD_TASKS_QUEUE`         | The queue a job will be added to                                                                                                                                                           |`emails`
-| `STACKKIT_CLOUD_TASKS_SERVICE_EMAIL` | The email address of the AppEngine 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 with the `handle-task` path added. By default we will use the URL that dispatched the job. |`https://<your website>.com/handle-task`
+| Environment variable                 | Description                                                                                                                                                                               |Example
+--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---
+| `STACKKIT_CLOUD_TASKS_PROJECT`       | The project your queue belongs to.                                                                                                                                                        |`my-project`
+| `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_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_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`
 </details>
 <details>
 <summary>
@@ -95,8 +82,6 @@ Please check the table below on what the values mean and what their value should
 
 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.
-
-For more information on how to configure the Cloud Tasks queue, read the next section [Configuring the queue](#configuring-the-queue)
 </details>
 <details>
   <summary>Dashboard (beta)</summary>
@@ -112,7 +97,7 @@ _Experimental_
 
 The dashboard works by storing all outgoing tasks in a database table. When Cloud Tasks calls the application and this
 package handles the task, we will automatically update the tasks' status, attempts
-and possible exceptions.
+and possible errors.
 
 There is probably a (small) performance penalty because each task dispatch and handling does extra database read and writes.
 Also, the dashboard has not been tested with high throughput queues.
@@ -129,10 +114,13 @@ To make use of it, enable it through the `.env` file:
 
 Then publish its assets and migrations:
 
-  ```php
+  ```console
   php artisan vendor:publish --tag=cloud-tasks
   php artisan migrate
   ```
+
+The dashboard is accessible at the URI: /cloud-tasks
+
 </details>
 <details>
   <summary>Authentication</summary>
@@ -149,65 +137,6 @@ If you're not using your master service account (which has all abilities), you m
 4. Cloud Tasks Task Deleter
 5. Service Account User
 </details>
-<details>
-  <summary>Configuring the queue</summary>
-  <br>
-  When you first create a queue using `gcloud tasks queues create`, the default settings will look something like this:
-
-  ```
-  rateLimits:
-    maxBurstSize: 100
-    maxConcurrentDispatches: 1000
-    maxDispatchesPerSecond: 500.0
-  retryConfig:
-    maxAttempts: 100
-    maxBackoff: 3600s
-    maxDoublings: 16
-    minBackoff: 0.100s
-  ```
-
-## Configurable settings
-
-### maxBurstSize
-
-Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high.
-
-### maxConcurrentDispatches
-
-The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue
-
-### maxDispatchesPerSecond
-
-The maximum rate at which tasks are dispatched from this queue.
-
-### maxAttempts
-
-Number of attempts per task. Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be >= -1.|
-
-### maxBackoff
-
-A task will be scheduled for retry between min_backoff and max_backoff duration after it fails
-
-### maxDoublings
-
-The time between retries will double max_doublings times.
-
-A task's retry interval starts at min_backoff, then doubles max_doublings times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times.
-
-For example, if min_backoff is 10s, max_backoff is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
-
-## Recommended settings for Laravel
-
-To simulate a single `queue:work/queue:listen` process, simply set the `maxConcurrentDispatches` to 1:
-
-  ```
-  gcloud tasks queues update [QUEUE_ID] --max-concurrent-dispatches=1
-  ```
-
-More information on configuring queues:
-
-https://cloud.google.com/tasks/docs/configuring-queues
-</details>
 <details>
   <summary>Security</summary>
   <br>
@@ -219,3 +148,8 @@ More information about OpenID Connect:
 
 https://developers.google.com/identity/protocols/oauth2/openid-connect
 </details>
+<details>
+  <summary>Upgrading</summary>
+  <br>
+  Read [UPGRADING.MD](UPGRADING.md) on how to update versions.
+</details>

UPGRADING.md

@@ -0,0 +1,18 @@
+# From 2.x to 3.x
+
+PHP 7.2 and 7.3, and Laravel 5.x are no longer supported.
+
+## Update handler URL (Impact: high)
+
+The handler URL environment has been simplified. Please change it like this:
+
+```dotenv
+# Before
+STACKKIT_CLOUD_TASKS_HANDLER=https://my-app/handle-task
+# After
+STACKKIT_CLOUD_TASKS_HANDLER=https://my-app
+```
+
+It's also allowed to remove this variable entirely in 3.x: The package will automatically use the application URL if the `STACKKIT_CLOUD_TASKS_HANDLER`
+environment is not present. If you omit it, please ensure the [trusted proxy](https://laravel.com/docs/9.x/requests#configuring-trusted-proxies) have been configured
+in your application. Otherwise, you might run into weird issues. :-)