Merge pull request #140 from cakephp/1x-merge

1x merge

Author: markstory

.github/workflows/ci.yml

@@ -3,8 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - master
-      - cake5
+      - 2.x
   pull_request:
     branches:
       - '*'

.github/workflows/deploy_docs_1x.yml

@@ -4,15 +4,15 @@ name: 'deploy_docs_1x'
 on:
   push:
     branches:
-      - master
+      - 1.x
   workflow_dispatch:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Cloning repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

README.md

@@ -5,7 +5,7 @@
 [![Coverage Status](https://img.shields.io/codecov/c/github/cakephp/queue/master.svg?style=flat-square)](https://codecov.io/github/cakephp/queue?branch=master)
 [![Total Downloads](https://img.shields.io/packagist/dt/cakephp/queue.svg?style=flat-square)](https://packagist.org/packages/cakephp/queue)
 
-This is a Queue system for CakePHP 4.
+This is a Queue system for CakePHP.
 
 The plugin consists of a CakePHP shell wrapper and Queueing libraries for the [php-queue](https://php-enqueue.github.io) queue library.
 
@@ -34,7 +34,7 @@ bin/cake plugin load Cake/Queue
 
 Or you can manually add the loading statement in the **src/Application.php** file of your application:
 ```php
-public function bootstrap()
+public function bootstrap(): void
 {
     parent::bootstrap();
     $this->addPlugin('Cake/Queue');

composer.json

@@ -1,16 +1,19 @@
 {
     "name": "cakephp/queue",
     "description": "Queue plugin for CakePHP",
-    "keywords": ["cakephp", "queue"],
-    "homepage": "https://github.com/cakephp/queue",
-    "type": "cakephp-plugin",
     "license": "MIT",
+    "type": "cakephp-plugin",
+    "keywords": [
+        "cakephp",
+        "queue"
+    ],
     "authors": [
         {
             "name": "CakePHP Community",
             "homepage": "https://github.com/cakephp/queue/graphs/contributors"
         }
     ],
+    "homepage": "https://github.com/cakephp/queue",
     "support": {
         "issues": "https://github.com/cakephp/queue/issues",
         "forum": "https://stackoverflow.com/tags/cakephp",
@@ -29,21 +32,27 @@
         "enqueue/fs": "^0.10",
         "phpunit/phpunit": "^10.1.0"
     },
+    "suggest": {
+        "cakephp/bake": "Required if you want to generate jobs.",
+        "cakephp/migrations": "Needed for running the migrations necessary for using Failed Jobs."
+    },
     "autoload": {
         "psr-4": {
             "Cake\\Queue\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Cake\\Test\\": "vendor/cakephp/cakephp/tests/",
             "Cake\\Queue\\Test\\": "tests/",
+            "Cake\\Test\\": "vendor/cakephp/cakephp/tests/",
             "TestApp\\": "tests/test_app/src/"
         }
     },
-    "suggest": {
-        "cakephp/bake": "Required if you want to generate jobs.",
-        "cakephp/migrations": "Needed for running the migrations necessary for using Failed Jobs."
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        },
+        "sort-packages": true
     },
     "scripts": {
         "check": [
@@ -63,11 +72,5 @@
         "stan-setup": "phive install",
         "test": "phpunit",
         "test-coverage": "phpunit --coverage-clover=clover.xml"
-    },
-    "config": {
-        "sort-packages": true,
-        "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
-        }
     }
 }

docs/config/all.py

@@ -32,7 +32,7 @@
 
 # The GitHub branch name for this version of the docs
 # for edit links to point at.
-branch = 'master'
+branch = '1.x'
 
 # Current version being built
 version = '2.x'

docs/en/index.rst

@@ -299,14 +299,15 @@ queue jobs, you can use the ``QueueTransport``. In your application's
 
     return [
         // ... other configuration
-        'EmailTransport' => [
+        'EmailTransport' => [            
+            'default' => [
+                'className' => MailTransport::class,
+                // Configuration for MailTransport.
+            ]
             'queue' => [
                 'className' => QueueTransport::class,
-                // The transport to use inside the queue job.
-                'transport' => MailTransport::class,
-                'config' => [
-                    // Configuration for MailTransport.
-                ]
+                // The transport name to use inside the queue job.
+                'transport' => 'default',
             ]
         ],
         'Email' => [
@@ -320,7 +321,7 @@ queue jobs, you can use the ``QueueTransport``. In your application's
 
 With this configuration in place, any time you send an email with the ``default``
 email profile CakePHP will generate a queue message. Once that queue message is
-processed the ``MailTransport`` will be used to deliver the email messages.
+processed the default ``MailTransport`` will be used to deliver the email messages.
 
 Run the worker
 ==============

phpstan.neon

@@ -1,9 +1,12 @@
 parameters:
-	level: 6
+	level: 8
 	checkMissingIterableValueType: false
 	checkGenericClassInNonGenericObjectType: false
 	treatPhpDocTypesAsCertain: false
 	bootstrapFiles:
 		- tests/bootstrap.php
 	paths:
 		- src/
+	ignoreErrors:
+		- '#Parameter \#1 \$callback of static method Closure::fromCallable\(\) expects callable\(\): mixed, array\{mixed, string\} given.#'
+		- '#Method Cake\\Queue\\Job\\Message::getTarget\(\) should return array\{class-string, string\} but returns non-empty-array.#'

psalm-baseline.xml

@@ -1,11 +1,3 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="dev-master@">
-  <file src="src/Model/Table/FailedJobsTable.php">
-    <LessSpecificImplementedReturnType occurrences="4">
-      <code>\Cake\Queue\Model\Entity\FailedJob[]|\Cake\Datasource\ResultSetInterface</code>
-      <code>\Cake\Queue\Model\Entity\FailedJob[]|\Cake\Datasource\ResultSetInterface</code>
-      <code>\Cake\Queue\Model\Entity\FailedJob[]|\Cake\Datasource\ResultSetInterface|false</code>
-      <code>\Cake\Queue\Model\Entity\FailedJob[]|\Cake\Datasource\ResultSetInterface|false</code>
-    </LessSpecificImplementedReturnType>
-  </file>
 </files>

src/Job/Message.php

@@ -108,6 +108,7 @@ public function getCallable(): Closure
      */
     public function getTarget(): array
     {
+        /** @var array|null $target */
         $target = $this->parsedBody['class'] ?? null;
 
         if (!is_array($target) || count($target) !== 2) {
@@ -161,7 +162,7 @@ public function getMaxAttempts(): ?int
      */
     public function __toString(): string
     {
-        return json_encode($this);
+        return (string)json_encode($this);
     }
 
     /**

src/Job/SendMailJob.php

@@ -18,7 +18,8 @@
 
 use Cake\Log\Log;
 use Cake\Mailer\AbstractTransport;
-use Cake\Mailer\Message as CakeMessage;
+use Cake\Mailer\Message as MailerMessage;
+use Cake\Mailer\TransportFactory;
 use Cake\Queue\Queue\Processor;
 use Exception;
 use InvalidArgumentException;
@@ -40,7 +41,7 @@ public function execute(Message $message): ?string
             /** @var \Cake\Mailer\AbstractTransport $transport */
             $transport = $this->getTransport($transportClassName, $config);
 
-            $emailMessage = new CakeMessage();
+            $emailMessage = new MailerMessage();
             $data = json_decode($message->getArgument('emailMessage'), true);
             if (!is_array($data)) {
                 throw new InvalidArgumentException('Email Message cannot be decoded.');
@@ -68,12 +69,15 @@ public function execute(Message $message): ?string
      */
     protected function getTransport(string $transportClassName, array $config): AbstractTransport
     {
+        if ($transportClassName === '') {
+            throw new InvalidArgumentException('Transport class name is empty.');
+        }
+
         if (
-            empty($transportClassName) ||
             !class_exists($transportClassName) ||
             !method_exists($transportClassName, 'send')
         ) {
-            throw new InvalidArgumentException(sprintf('Transport class name is not valid: %s', $transportClassName));
+            return TransportFactory::get($transportClassName);
         }
 
         $transport = new $transportClassName($config);