Upgraded the library to require at least PHP8.1 and illuminate/queue 10.0 (digbang#3)

* Upgraded the library to require at least PHP8.1 and illuminate/queue 10.0

- Upgraded the laravel-doctrine/orm package to version 2.0
- Require phpunit version 10 and migrated the phpunit.xml.dist to the newest schema
- Merged the Throwable catch branch with the Exception catch branch in the Worker.php as it used an exception class that is no longer available
- Added the MockeryPHPUnitIntegration trait to the testcases to allow Mockery to influence the expectation count
- Changed the namespace of the test cases to Digbang\SafeQueue\Tests
- DoctrineQueueProvider now implements DeferrableProvider instead of using the $defer property
- Added some return type (non-exhaustive)

* Ran phpcsfixer with default configuration

Author: cvanzanten-dij

.gitignore

@@ -3,3 +3,4 @@
 .DS_Store
 .php_cs.cache
 composer.lock
+/.phpunit.cache/

composer.json

@@ -10,17 +10,21 @@
         {
             "name": "Dario Govergun",
             "email": "dgovergun@digbang.com"
+        },
+        {
+            "name": "DIJ Digital",
+            "email": "support@dij.digital"
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0.2",
-        "illuminate/queue": "^8.0 || ^9.0",
-        "laravel-doctrine/orm": "^1.7"
+        "php": "^8.1",
+        "illuminate/queue": "^10.0",
+        "laravel-doctrine/orm": "^2.0"
     },
     "require-dev": {
-        "mockery/mockery": "^1.5",
-        "phpunit/phpunit": "^8.5 || ^9.5",
-        "friendsofphp/php-cs-fixer": "^3.6"
+        "mockery/mockery": "^1.6",
+        "phpunit/phpunit": "^10.0",
+        "friendsofphp/php-cs-fixer": "^3.40"
     },
     "autoload": {
         "psr-4": {
@@ -29,7 +33,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "test\\Digbang\\SafeQueue\\": "tests/"
+            "Digbang\\SafeQueue\\Tests\\": "tests/"
         }
     }
 }

phpunit.xml.dist

@@ -1,15 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage/>
   <testsuites>
     <testsuite name="Full Test Suite">
       <directory>./tests/</directory>
     </testsuite>
   </testsuites>
   <php>
     </php>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
 </phpunit>

src/Console/WorkCommand.php

@@ -8,7 +8,7 @@
 
 class WorkCommand extends IlluminateWorkCommand
 {
-    const SIGNATURE_REGEX_PATTERN = '/([\w:-]+)(?=\s|\{)/i';
+    public const SIGNATURE_REGEX_PATTERN = '/([\w:-]+)(?=\s|\{)/i';
 
     /**
      * The console command description.
@@ -31,7 +31,7 @@ public function __construct(Worker $worker, Cache $cache, $config)
         parent::__construct($worker, $cache);
     }
 
-    public function renameCommandInSignature($commandName)
+    public function renameCommandInSignature($commandName): void
     {
         if ($commandName) {
             /**

src/DoctrineQueueProvider.php

@@ -2,24 +2,22 @@
 
 namespace Digbang\SafeQueue;
 
+use Illuminate\Contracts\Support\DeferrableProvider;
 use Illuminate\Support\ServiceProvider;
 use Digbang\SafeQueue\Console\WorkCommand;
 use Illuminate\Contracts\Cache\Repository as Cache;
-use Illuminate\Contracts\Debug\ExceptionHandler;
 
 /**
  * @codeCoverageIgnore
  */
-class DoctrineQueueProvider extends ServiceProvider
+class DoctrineQueueProvider extends ServiceProvider implements DeferrableProvider
 {
-    protected $defer = true;
-
     /**
      * Register the service provider.
      *
      * @return void
      */
-    public function register()
+    public function register(): void
     {
         if (!$this->isLumen()) {
             $this->publishes([
@@ -35,15 +33,15 @@ public function register()
         $this->registerWorker();
     }
 
-    public function boot()
+    public function boot(): void
     {
         $this->commands('command.safeQueue.work');
     }
 
     /**
      * @return void
      */
-    protected function registerWorker()
+    protected function registerWorker(): void
     {
         $this->registerWorkCommand();
 
@@ -65,7 +63,7 @@ protected function registerWorker()
     /**
      * @return void
      */
-    protected function registerWorkCommand()
+    protected function registerWorkCommand(): void
     {
         $this->app->singleton('command.safeQueue.work', function ($app) {
             return new WorkCommand(
@@ -81,7 +79,7 @@ protected function registerWorkCommand()
      *
      * @return array
      */
-    public function provides()
+    public function provides(): array
     {
         return [
             'safeQueue.worker',
@@ -92,8 +90,8 @@ public function provides()
     /**
      * @return bool
      */
-    protected function isLumen()
+    protected function isLumen(): bool
     {
-        return strpos($this->app->version(), 'Lumen') !== false;
+        return str_contains($this->app->version(), 'Lumen');
     }
 }

src/Worker.php

@@ -2,24 +2,17 @@
 
 namespace Digbang\SafeQueue;
 
-use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Exception;
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Contracts\Events\Dispatcher;
-use Illuminate\Contracts\Container\Container;
 use Illuminate\Queue\QueueManager;
 use Illuminate\Queue\Worker as IlluminateWorker;
-use Illuminate\Queue\WorkerOptions;
-use Symfony\Component\Debug\Exception\FatalThrowableError;
 use Throwable;
 
 class Worker extends IlluminateWorker
 {
-    /**
-     * @var ManagerRegistry
-     */
-    protected $managerRegistry;
+    protected ManagerRegistry $managerRegistry;
 
     /**
      * Worker constructor.
@@ -28,7 +21,7 @@ class Worker extends IlluminateWorker
      * @param Dispatcher $events
      * @param ManagerRegistry $managerRegistry
      * @param ExceptionHandler $exceptions
-     * @param \callable $isDownForMaintenance
+     * @param callable $isDownForMaintenance
      */
     public function __construct(
         QueueManager $manager,
@@ -62,10 +55,8 @@ protected function getNextJob($connection, $queue)
             $this->assertGoodDatabaseConnection();
         } catch (EntityManagerClosedException $e) {
             $exception = $e;
-        } catch (Exception $e) {
+        } catch (Exception|Throwable $e) {
             $exception = new QueueSetupException("Error in queue setup while getting next job", 0, $e);
-        } catch (Throwable $e) {
-            $exception = new QueueSetupException("Error in queue setup while getting next job", 0, new FatalThrowableError($e));
         }
 
         if ($exception) {
@@ -85,7 +76,7 @@ private function assertEntityManagerOpen()
     {
         foreach ($this->managerRegistry->getManagers() as $entityManager) {
             if (!$entityManager->isOpen()) {
-                throw new EntityManagerClosedException;
+                throw new EntityManagerClosedException();
             }
         }
     }

tests/Console/WorkCommandTest.php

@@ -1,7 +1,8 @@
 <?php
 
+declare(strict_types=1);
 
-namespace tests\Digbang\SafeQueue\Console;
+namespace Digbang\SafeQueue\Tests\Console;
 
 use Mockery as m;
 use ReflectionClass;
@@ -12,6 +13,8 @@
 
 class WorkCommandTest extends TestCase
 {
+    use m\Adapter\Phpunit\MockeryPHPUnitIntegration;
+
     /**
      * @var Worker|m\MockInterface
      */

tests/WorkerTest.php

@@ -1,7 +1,8 @@
 <?php
 
+declare(strict_types=1);
 
-namespace tests\Digbang\SafeQueue;
+namespace Digbang\SafeQueue\Tests;
 
 use Doctrine\DBAL\Connection;
 use Doctrine\ORM\EntityManager;
@@ -21,6 +22,8 @@
 
 class WorkerTest extends TestCase
 {
+    use m\Adapter\Phpunit\MockeryPHPUnitIntegration;
+
     /**
      * @var QueueManager|m\MockInterface
      */
@@ -81,7 +84,7 @@ protected function setUp(): void
         $this->cache         = m::mock(Repository::class);
         $this->exceptions    = m::mock(Handler::class);
         $this->managerRegistry = m::mock(ManagerRegistry::class);
-        $isDownForMaintenance= function () {
+        $isDownForMaintenance = function () {
             return false;
         };
 
@@ -96,12 +99,7 @@ protected function setUp(): void
         $this->entityManager->shouldReceive('getConnection')->andReturn($this->dbConnection);
     }
 
-    protected function tearDown(): void
-    {
-        m::close();
-    }
-
-    protected function prepareToRunJob($job)
+    protected function prepareToRunJob($job): void
     {
         if ($job instanceof Job) {
             $jobs = [$job];
@@ -114,6 +112,7 @@ protected function prepareToRunJob($job)
         $this->queueManager->shouldReceive('getName')->andReturn('test');
 
         $this->queue->shouldReceive('pop')->andReturn(...$jobs);
+        $this->queue->shouldReceive('getConnectionName')->andReturn('test');
     }
 
     public function testExtendsLaravelWorker()
@@ -123,8 +122,7 @@ public function testExtendsLaravelWorker()
 
     public function testChecksEmState()
     {
-        $job = m::mock(Job::class);
-        $job->shouldReceive('fire')->once();
+        $job = m::spy(Job::class);
         $job->shouldIgnoreMissing();
 
         $this->prepareToRunJob($job);
@@ -143,11 +141,13 @@ public function testChecksEmState()
         $this->managerRegistry->shouldReceive('getManagers')->andReturn(array($this->entityManager));
 
         $this->worker->runNextJob('connection', 'queue', $this->options);
+
+        $job->shouldHaveReceived('fire')->once();
     }
 
-    public function testMultipleEntityManagers() {
-        $job = m::mock(Job::class);
-        $job->shouldReceive('fire')->once();
+    public function testMultipleEntityManagers()
+    {
+        $job = m::spy(Job::class);
         $job->shouldIgnoreMissing();
 
         $this->prepareToRunJob($job);
@@ -172,5 +172,7 @@ public function testMultipleEntityManagers() {
         $this->managerRegistry->shouldReceive('getManagers')->andReturn(array($this->entityManager, $secondManager));
 
         $this->worker->runNextJob('connection', 'queue', $this->options);
+
+        $job->shouldHaveReceived('fire')->once();
     }
 }