Show Failed Message

.github/workflows/ci.yml → .github/workflows/ci.yaml

@@ -1,64 +1,13 @@
-name: MessengerMonitorBundle CI
+name: CI
 
 on:
   pull_request: ~
   push:
-    branches:
-      - "master"
+    branches: ['master']
+  schedule:
+    - cron: '0 */12 * * *'
 
 jobs:
-  coding-standards:
-    name: "Coding Standards"
-
-    runs-on: "ubuntu-latest"
-
-    strategy:
-      matrix:
-        php:
-          - "8.0"
-
-    steps:
-      - name: "Checkout"
-        uses: actions/checkout@v3
-
-      - name: "Set up PHP"
-        uses: shivammathur/setup-php@v2
-        with:
-          coverage: none
-          php-version: ${{ matrix.php }}
-
-      - name: "Install dependencies with composer"
-        uses: ramsey/composer-install@v2
-
-      - name: "Run friendsofphp/php-cs-fixer"
-        run: vendor/bin/php-cs-fixer fix --ansi --config=.php-cs-fixer.dist.php --diff --dry-run --verbose
-
-  static-code-analysis:
-    name: "Static Code Analysis"
-
-    runs-on: "ubuntu-latest"
-
-    strategy:
-      matrix:
-        php:
-          - "8.0"
-
-    steps:
-      - name: "Checkout"
-        uses: actions/checkout@v3
-
-      - name: "Set up PHP"
-        uses: shivammathur/setup-php@v2
-        with:
-          coverage: none
-          php-version: ${{ matrix.php }}
-
-      - name: "Install dependencies with composer"
-        uses: ramsey/composer-install@v2
-
-      - name: "Run vimeo/psalm"
-        run: vendor/bin/psalm --diff --show-info=false --stats --threads=4
-
   tests-mariadb:
     name: "Tests with MariaDB"
 
@@ -68,24 +17,24 @@ jobs:
       fail-fast: false
       matrix:
         php:
-          - "8.0"
           - "8.1"
+          - "8.2"
+          - "8.3"
         dependencies:
           - "lowest"
           - "highest"
 
     services:
       mariadb:
-        image: mariadb:latest
+        image: mariadb:10.11
         ports:
           - 3306
         env:
           MYSQL_USER: user
           MYSQL_PASSWORD: password
           MYSQL_DATABASE: messenger_monitor_bundle_test
           MYSQL_ROOT_PASSWORD: password
-        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
-
+        options: --health-cmd "mysqladmin ping --silent"
     steps:
       - name: "Checkout"
         uses: actions/checkout@v3
@@ -115,8 +64,9 @@ jobs:
       fail-fast: false
       matrix:
         php:
-          - "8.0"
           - "8.1"
+          - "8.2"
+          - "8.3"
         postgres-version:
           - "14"
 
@@ -148,3 +98,15 @@ jobs:
         run: vendor/bin/simple-phpunit
         env:
           TEST_DATABASE_DSN: postgres://user:[email protected]:${{ job.services.postgres.ports[5432] }}/messenger_monitor_bundle_test
+
+  composer-validate:
+    uses: SymfonyCasts/.github/.github/workflows/composer-validate.yaml@main
+
+  cs:
+    uses: SymfonyCasts/.github/.github/workflows/php-cs-fixer.yaml@main
+
+  sca:
+    uses: SymfonyCasts/.github/.github/workflows/phpstan.yaml@main
+    with:
+      php: 8.1
+      install-phpunit-bridge: true

README.md

@@ -1,44 +1,48 @@
 Messenger Monitor
----
+=================
 
+[![CI](https://github.com/SymfonyCasts/messenger-monitor-bundle/actions/workflows/ci.yaml/badge.svg)](https://github.com/SymfonyCasts/messenger-monitor-bundle/actions/workflows/ci.yaml)
 
-A Symfony Bundle to show you information about your Messenger queues/transports
+> **Note**
+> **THIS BUNDLE IS EXPERIMENTAL & UNSTABLE** and may not work and probably isn't ready for production.
+> It's also super rough and currently is in a development phase.
 
-This is in a development phase
+A Symfony Bundle to show you information about your Messenger queues/transports.
+
+### Implemented Features
 
-Implemented Features
 * Show queue length in console (configure interval) 
 
-Planned Features
+### Planned Features
+
 * Add admin route to see the queues in the browser
 * Auto Refresh
 * Refactor queue information to allow additional data
 * Collect data (how? TBD)
 * Show more queue information (avg time, ago, ...)
 
-Phase 2
-* Realtime updates in browser (use TURTED_reactphp)
+### Phase 2
+
+* Realtime updates in the browser (use TURTED_reactphp)
 
 Installation
-============
+------------
 
 Make sure Composer is installed globally, as explained in the
 [installation chapter](https://getcomposer.org/doc/00-intro.md)
 of the Composer documentation.
 
-Applications that use Symfony Flex
-----------------------------------
+### Applications that use Symfony Flex
 
 Open a command console, enter your project directory and execute:
 
 ```console
 $ composer require symfonycasts/messenger-monitor-bundle
 ```
 
-Applications that don't use Symfony Flex
-----------------------------------------
+### Applications that don't use Symfony Flex
 
-### Step 1: Download the Bundle
+#### Step 1: Download the Bundle
 
 Open a command console, enter your project directory and execute the
 following command to download the latest stable version of this bundle:
@@ -47,7 +51,7 @@ following command to download the latest stable version of this bundle:
 $ composer require symfonycasts/messenger-monitor-bundle
 ```
 
-### Step 2: Enable the Bundle
+#### Step 2: Enable the Bundle
 
 Then, enable the bundle by adding it to the list of registered bundles
 in the `config/bundles.php` file of your project:
@@ -62,15 +66,10 @@ return [
 ```
 
 Usage
-=====
-
-```bin/console messenger:monitor``` to refresh every 3 seconds (default)
-
-```bin/console messenger:monitor -i 0``` to get the information only once
-```bin/console messenger:monitor -i 1``` to refresh every second
-
-Check ```bin/console help messenger:monitor``` for more information
-
-
+-----
 
+- `bin/console messenger:monitor` to refresh every 3 seconds (default)
+- `bin/console messenger:monitor -i 0` to get the information only once
+- `bin/console messenger:monitor -i 1` to refresh every second
 
+Check `bin/console help messenger:monitor` for more information.

composer.json

@@ -3,31 +3,30 @@
     "description": "Symfony bundle for information about your Messenger queues and transports",
     "type": "symfony-bundle",
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "ext-json": "*",
-        "symfony/config": "^5.4|^6.0",
-        "symfony/dependency-injection": "^5.4|^6.0",
-        "symfony/event-dispatcher": "^5.4|^6.0",
-        "symfony/framework-bundle": "^5.4|^6.0",
-        "symfony/http-foundation": "^5.4|^6.0",
-        "symfony/http-kernel": "^5.4|^6.0",
-        "symfony/messenger": "^5.4|^6.0",
+        "symfony/config": "^5.4|^6.0|^7.0",
+        "symfony/dependency-injection": "^5.4|^6.0|^7.0",
+        "symfony/event-dispatcher": "^5.4|^6.0|^7.0",
+        "symfony/framework-bundle": "^5.4|^6.0|^7.0",
+        "symfony/http-foundation": "^5.4|^6.0|^7.0",
+        "symfony/http-kernel": "^5.4|^6.0|^7.0",
+        "symfony/messenger": "^5.4|^6.0|^7.0",
         "symfony/polyfill-uuid": "^1.23",
-        "symfony/routing": "^5.4|^6.0",
-        "symfony/twig-bundle": "^5.4|^6.0",
+        "symfony/routing": "^5.4|^6.0|^7.0",
+        "symfony/twig-bundle": "^5.4|^6.0|^7.0",
         "twig/twig": "^2.14.7|^3.0"
     },
     "require-dev": {
         "doctrine/dbal": "^2.13.3",
         "doctrine/doctrine-bundle": "^2.0",
         "doctrine/orm": "^2.10",
-        "friendsofphp/php-cs-fixer": "^3.11",
-        "symfony/browser-kit": "^5.4|^6.0",
-        "symfony/css-selector": "^5.4|^6.0",
-        "symfony/doctrine-messenger": "^6.0",
-        "symfony/phpunit-bridge": "^5.4|^6.0",
-        "symfony/security-bundle": "^5.4|^6.0",
-        "vimeo/psalm": "^4.0"
+        "php-cs-fixer/shim": "^3.17",
+        "symfony/browser-kit": "^5.4|^6.0|^7.0",
+        "symfony/css-selector": "^5.4|^6.0|^7.0",
+        "symfony/doctrine-messenger": "^6.0|^7.0",
+        "symfony/phpunit-bridge": "^5.4|^6.0|^7.0",
+        "symfony/security-bundle": "^5.4|^6.0|^7.0"
     },
     "conflict": {
         "symfony/doctrine-bridge": "<5.4"
@@ -56,5 +55,19 @@
             "name": "Nicolas PHILIPPE",
             "email": "[email protected]"
         }
-    ]
+    ],
+    "scripts": {
+        "tools:upgrade": [
+            "@tools:upgrade:php-cs-fixer",
+            "@tools:upgrade:phpstan"
+        ],
+        "tools:upgrade:php-cs-fixer": "composer upgrade -W -d tools/php-cs-fixer",
+        "tools:upgrade:phpstan": "composer upgrade -W -d tools/phpstan",
+        "tools:run": [
+            "@tools:run:php-cs-fixer",
+            "@tools:run:phpstan"
+        ],
+        "tools:run:php-cs-fixer": "tools/php-cs-fixer/vendor/bin/php-cs-fixer fix",
+        "tools:run:phpstan": "tools/phpstan/vendor/bin/phpstan --memory-limit=1G"
+    }
 }

phpstan-baseline.neon

@@ -0,0 +1,26 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Method SymfonyCasts\\\\MessengerMonitorBundle\\\\Exception\\\\ReceiverDoesNotExistException\\:\\:__construct\\(\\) has parameter \\$availableReceivers with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Exception/ReceiverDoesNotExistException.php
+
+		-
+			message: "#^Method SymfonyCasts\\\\MessengerMonitorBundle\\\\Locator\\\\ReceiverLocator\\:\\:__construct\\(\\) has parameter \\$receiverLocator with generic interface Symfony\\\\Contracts\\\\Service\\\\ServiceProviderInterface but does not specify its types\\: T$#"
+			count: 1
+			path: src/Locator/ReceiverLocator.php
+
+		-
+			message: "#^Method SymfonyCasts\\\\MessengerMonitorBundle\\\\Locator\\\\ReceiverLocator\\:\\:__construct\\(\\) has parameter \\$receiverNames with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Locator/ReceiverLocator.php
+
+		-
+			message: "#^Method SymfonyCasts\\\\MessengerMonitorBundle\\\\Storage\\\\Doctrine\\\\Connection\\:\\:executeQuery\\(\\) has parameter \\$parameters with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Storage/Doctrine/Connection.php
+
+		-
+			message: "#^Method SymfonyCasts\\\\MessengerMonitorBundle\\\\Storage\\\\Doctrine\\\\Connection\\:\\:executeQuery\\(\\) has parameter \\$types with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Storage/Doctrine/Connection.php

phpstan.dist.neon

@@ -0,0 +1,12 @@
+includes:
+	- phpstan-baseline.neon
+
+parameters:
+    level: 6
+    bootstrapFiles:
+        - vendor/autoload.php
+    paths:
+        - src
+#        - tests
+    excludePaths:
+        - tests/tmp/*

src/Controller/DashboardController.php

@@ -25,7 +25,7 @@ public function __construct(
         private Environment $twig,
         private ReceiverLocator $receiverLocator,
         private FailedMessageRepository $failedMessageRepository,
-        private StatisticsProcessorInterface $statisticsProcessor
+        private StatisticsProcessorInterface $statisticsProcessor,
     ) {
     }
 

src/Controller/RejectFailedMessageController.php

@@ -18,7 +18,7 @@ final class RejectFailedMessageController
     public function __construct(
         private FailedMessageRejecter $failedMessageRejecter,
         private RequestStack $requestStack,
-        private UrlGeneratorInterface $urlGenerator
+        private UrlGeneratorInterface $urlGenerator,
     ) {
     }
 
@@ -29,9 +29,9 @@ public function __invoke(int $id): RedirectResponse
 
         try {
             $this->failedMessageRejecter->rejectFailedMessage($id);
-            $sessionBag->add('messenger_monitor.success', sprintf('Message with id "%s" correctly rejected.', $id));
+            $sessionBag->add('messenger_monitor.success', \sprintf('Message with id "%s" correctly rejected.', $id));
         } catch (\Exception $exception) {
-            $sessionBag->add('messenger_monitor.error', sprintf('Error while rejecting message with id "%s": %s', $id, $exception->getMessage()));
+            $sessionBag->add('messenger_monitor.error', \sprintf('Error while rejecting message with id "%s": %s', $id, $exception->getMessage()));
         }
 
         return new RedirectResponse($this->urlGenerator->generate('symfonycasts.messenger_monitor.dashboard'));

src/Controller/RetryFailedMessageController.php

@@ -29,9 +29,9 @@ public function __invoke(int $id): RedirectResponse
 
         try {
             $this->failedMessageRetryer->retryFailedMessage($id);
-            $sessionBag->add('messenger_monitor.success', sprintf('Message with id "%s" correctly retried.', $id));
+            $sessionBag->add('messenger_monitor.success', \sprintf('Message with id "%s" correctly retried.', $id));
         } catch (\Exception $exception) {
-            $sessionBag->add('messenger_monitor.error', sprintf('Error while retrying message with id "%s": %s', $id, $exception->getMessage()));
+            $sessionBag->add('messenger_monitor.error', \sprintf('Error while retrying message with id "%s": %s', $id, $exception->getMessage()));
         }
 
         return new RedirectResponse($this->urlGenerator->generate('symfonycasts.messenger_monitor.dashboard'));