Symfony 6 and PHP 8.1+

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Changed
+- Update dependencies and code to work with Symfony ^6.0 and PHP ^8.1.
+
+### Breaking changes
+- PHP >= 8.1
+- Symfony ^6.0
 
 ## [5.1.0] - 2023-03-14
 ### Fixed

README.md

@@ -13,12 +13,12 @@ The bundle piggybacks off of the `php-amqplib/rabbitmq-bundle` bundle.
 
 ## Setup & Dependencies
 
-* PHP `>=7.0`
-* https://packagist.org/packages/symfony/symfony `^3.4|^4.0`
-* https://packagist.org/packages/doctrine/orm `~2.5`
-* https://packagist.org/packages/monolog/monolog `~1.11`
-* https://packagist.org/packages/ramsey/uuid `~3.4`
-* https://packagist.org/packages/php-amqplib/rabbitmq-bundle `~1.6`
+* PHP `>=8.1`
+* https://packagist.org/packages/symfony/symfony `^6.0`
+* https://packagist.org/packages/doctrine/orm `~2.14`
+* https://packagist.org/packages/monolog/monolog `~2.8`
+* https://packagist.org/packages/ramsey/uuid `~4.7`
+* https://packagist.org/packages/php-amqplib/rabbitmq-bundle `~2.11`
 
 We assume that you are familiar with the `php-amqplib/rabbitmq-bundle` configuration and setup.
 

composer.json

@@ -20,29 +20,33 @@
   },
 
   "require": {
-    "php": ">=7.0",
+    "php": ">=8.1",
 
-    "symfony/config": "^3.4 || ^4.0",
-    "symfony/console": "^3.4 || ^4.0",
-    "symfony/dependency-injection": "^3.4 || ^4.0",
-    "symfony/expression-language": "^3.4 || ^4.0",
-    "symfony/filesystem": "^3.4 || ^4.0",
-    "symfony/http-foundation": "^3.4 || ^4.0",
-    "symfony/http-kernel": "^3.4 || ^4.0",
-    "symfony/validator": "^3.4 || ^4.0",
+    "symfony/config": "^6.0",
+    "symfony/console": "^6.0",
+    "symfony/dependency-injection": "^6.0",
+    "symfony/expression-language": "^6.0",
+    "symfony/filesystem": "^6.0",
+    "symfony/http-foundation": "^6.0",
+    "symfony/http-kernel": "^6.0",
+    "symfony/validator": "^6.0",
 
-    "doctrine/cache": "^1.6",
-    "doctrine/doctrine-bundle": "~1.4",
-    "doctrine/orm": "~2.5",
+    "doctrine/cache": "^2.0",
+    "doctrine/doctrine-bundle": "^2.8",
+    "doctrine/orm": "^2.14",
 
-    "monolog/monolog": "~1.11",
+    "monolog/monolog": "^2.8",
 
-    "php-amqplib/rabbitmq-bundle": "^1.13.0",
+    "php-amqplib/rabbitmq-bundle": "^2.11",
 
-    "ramsey/uuid": "~3.4",
-    "php-http/guzzle6-adapter": "^1.1",
-    "richardfullmer/rabbitmq-management-api": "^2.0",
+    "ramsey/uuid": "^4.7",
+    "php-http/guzzle7-adapter": "^1.0",
+    "andrewmy/rabbitmq-management-api": "^2.1",
     "psr/log": "^1.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "php-http/discovery": true
+    }
   }
-
 }

src/Printed/Bundle/Queue/Command/EnsureVhostExistsCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Printed\Bundle\Queue\Command;
 
 use Printed\Bundle\Queue\Service\RabbitMqVhostExistenceEnsurer;
@@ -13,21 +15,16 @@
  */
 class EnsureVhostExistsCommand extends Command
 {
-    /** @var RabbitMqVhostExistenceEnsurer */
-    private $rabbitMqVhostExistenceEnsurer;
-
     public function __construct(
-        RabbitMqVhostExistenceEnsurer $rabbitMqVhostExistenceEnsurer
+        private readonly RabbitMqVhostExistenceEnsurer $rabbitMqVhostExistenceEnsurer,
     ) {
         parent::__construct();
-
-        $this->rabbitMqVhostExistenceEnsurer = $rabbitMqVhostExistenceEnsurer;
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('queue:ensure-vhost-exists');
         $this->setDescription("Ensures, that a rabbitmq's vhost exists, and that rabbitmq's user can manage it");
@@ -36,13 +33,15 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($output->getVerbosity() === OutputInterface::VERBOSITY_NORMAL) {
             $output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE);
         }
 
         $this->rabbitMqVhostExistenceEnsurer->ensure();
+
+        return static::SUCCESS;
     }
 
 }

src/Printed/Bundle/Queue/Command/MaintenanceDownCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Printed\Bundle\Queue\Command;
 
 use Printed\Bundle\Queue\Service\QueueMaintenance;
@@ -12,20 +14,15 @@
  */
 class MaintenanceDownCommand extends Command
 {
-    /** @var QueueMaintenance */
-    private $queueMaintenance;
-
-    public function __construct(QueueMaintenance $queueMaintenance)
+    public function __construct(private readonly QueueMaintenance $queueMaintenance)
     {
         parent::__construct();
-
-        $this->queueMaintenance = $queueMaintenance;
     }
-    
+
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('queue:maintenance:down');
         $this->setDescription('Disable the maintenance mode for the queue');
@@ -35,10 +32,12 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln('<info>Disabling maintenance mode</info>');
 
         $this->queueMaintenance->disable();
+
+        return static::SUCCESS;
     }
 }

src/Printed/Bundle/Queue/Command/MaintenanceUpCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Printed\Bundle\Queue\Command;
 
 use Printed\Bundle\Queue\Service\QueueMaintenance;
@@ -12,20 +14,15 @@
  */
 class MaintenanceUpCommand extends Command
 {
-    /** @var QueueMaintenance */
-    private $queueMaintenance;
-
-    public function __construct(QueueMaintenance $queueMaintenance)
+    public function __construct(private readonly QueueMaintenance $queueMaintenance)
     {
         parent::__construct();
-
-        $this->queueMaintenance = $queueMaintenance;
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('queue:maintenance:up');
         $this->setDescription('Puts the queue in to maintenance mode');
@@ -35,10 +32,12 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln('<info>Enabling maintenance mode</info>');
 
         $this->queueMaintenance->enable();
+
+        return static::SUCCESS;
     }
 }

src/Printed/Bundle/Queue/Command/MaintenanceWaitForRunningCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Printed\Bundle\Queue\Command;
 
 use Doctrine\DBAL\Connection;
@@ -17,26 +19,17 @@
  */
 class MaintenanceWaitForRunningCommand extends Command
 {
-    /** @var QueueMaintenance */
-    private $queueMaintenance;
-
-    /** @var Connection */
-    private $dbalConnection;
-
     public function __construct(
-        QueueMaintenance $queueMaintenance,
-        Connection $dbalConnection
+        private readonly QueueMaintenance $queueMaintenance,
+        private readonly Connection $dbalConnection,
     ) {
         parent::__construct();
-
-        $this->queueMaintenance = $queueMaintenance;
-        $this->dbalConnection = $dbalConnection;
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('queue:maintenance:wait');
         $this->setDescription('Wait for running tasks to complete and exit');
@@ -49,7 +42,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln('<info>Monitoring running tasks</info>');
 
@@ -65,28 +58,30 @@ public function execute(InputInterface $input, OutputInterface $output)
         $dbal = $this->dbalConnection;
 
         if (!$this->doesDatabaseExist($dbal)) {
-            $output->writeln("<error>The database doesn't exist. This is expected, if the bundle is used for the first time. Otherwise it's a critical error you should investigate.</error>");
-            return;
+            $output->writeln("<comment>The database doesn't exist. This is expected, if the bundle is used for the first time. Otherwise, it's a critical error you should investigate.</comment>");
+
+            return static::SUCCESS;
         }
 
         /*
          * Exit immediately if the queue tasks db table is not in the database. Assume no workers
          * are running.
          */
-        if (!in_array('queue_task', $dbal->getSchemaManager()->listTableNames())) {
-            $output->writeln("<error>Couldn't find the queue tasks table in the database. This is expected, if the bundle is used for the first time. Otherwise it's a critical error you should investigate.</error>");
-            return;
+        if (!in_array('queue_task', $dbal->createSchemaManager()->listTableNames())) {
+            $output->writeln("<comment>Couldn't find the queue tasks table in the database. This is expected, if the bundle is used for the first time. Otherwise, it's a critical error you should investigate.</comment>");
+
+            return static::SUCCESS;
         }
 
         //  Get the refresh time, this is 3 by default.
-        $refresh = (integer) $input->getOption('refresh');
+        $refresh = (int) $input->getOption('refresh');
 
         $table = new Table($output);
         $table->setHeaders(['Queue', 'Tasks']);
 
         while (true) {
             //  Find all tasks with running status.
-            $tasks = $dbal->fetchAll(
+            $tasks = $dbal->fetchAllAssociative(
                 'SELECT id, queue_name FROM queue_task WHERE status = :status_running',
                 [ 'status_running' => QueueTaskStatus::RUNNING ]
             );
@@ -95,7 +90,8 @@ public function execute(InputInterface $input, OutputInterface $output)
             //  If there are none we can exit the command.
             if ($count === 0) {
                 $output->writeln(sprintf('<info>There are no tasks in running state!</info>'));
-                return;
+
+                return static::SUCCESS;
             }
 
             $table->setRows([]);
@@ -162,7 +158,7 @@ private function doesDatabaseExist(Connection $connection): bool
 
         $tmpConnection = DriverManager::getConnection($params);
 
-        $doesDatabaseExist = in_array($name, $tmpConnection->getSchemaManager()->listDatabases());
+        $doesDatabaseExist = in_array($name, $tmpConnection->createSchemaManager()->listDatabases());
 
         $tmpConnection->close();
 

src/Printed/Bundle/Queue/Command/RequeueTaskCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Printed\Bundle\Queue\Command;
 
 use Printed\Bundle\Queue\Helper\QueueTaskHelper;
@@ -17,39 +19,22 @@
  */
 class RequeueTaskCommand extends Command
 {
-    /** @var LoggerInterface */
-    private $logger;
-
-    /** @var QueueTaskDispatcher */
-    private $queueTaskDispatcher;
-
-    /** @var QueueTaskHelper */
-    private $queueTaskHelper;
-
-    /** @var QueueTaskRepository */
-    private $queueTaskRepository;
-
     public function __construct(
-        LoggerInterface $logger,
-        QueueTaskDispatcher $queueTaskDispatcher,
-        QueueTaskHelper $queueTaskHelper,
-        QueueTaskRepository $queueTaskRepository
+        private readonly LoggerInterface $logger,
+        private readonly QueueTaskDispatcher $queueTaskDispatcher,
+        private readonly QueueTaskHelper $queueTaskHelper,
+        private readonly QueueTaskRepository $queueTaskRepository,
     ) {
         parent::__construct();
-
-        $this->logger = $logger;
-        $this->queueTaskDispatcher = $queueTaskDispatcher;
-        $this->queueTaskHelper = $queueTaskHelper;
-        $this->queueTaskRepository = $queueTaskRepository;
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('queue:requeue-task');
-        $this->setDescription("Requeues a task. Should be used with great care (preferably never)");
+        $this->setDescription("Re-queues a task. Should be used with great care (preferably never)");
         $this->setHelp('This command allows to perform dangerous stuff and is mostly useful only for debugging.');
 
         $this->addArgument('queue-task-id', InputArgument::REQUIRED, 'Queue task to requeue');
@@ -58,7 +43,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($output->getVerbosity() === OutputInterface::VERBOSITY_NORMAL) {
             $output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE);
@@ -77,5 +62,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         $newTask = $this->queueTaskDispatcher->dispatch($this->queueTaskHelper->getPayload($task));
 
         $this->logger->info("Successfully requeued task. New task id: `{$newTask->getId()}`");
+
+        return static::SUCCESS;
     }
 }