feat: Upgrade PHPStan and fix new errors

Upgraded PHPStan to version 2.1 to resolve a static analysis issue with outdated MongoDB stubs.

This upgrade introduced stricter type checks, which revealed a redundant PHPDoc in `MongoTransport.php`. The PHPDoc has been removed.

Also includes minor code style improvements in tests and updates to the Docker environment to match the current development setup.

Author: Iosif Chiriluta | eMAG, Technology

GEMINI.md

@@ -0,0 +1,55 @@
+# Project Overview
+
+This project is a Symfony Bundle that provides a MongoDB transport for the Symfony Messenger component. It allows developers to use MongoDB as a message queue for their Symfony applications. This is particularly useful when an application already uses MongoDB and wants to avoid adding another dependency for a message queue.
+
+The core of the bundle is the `MongoTransport` class, which implements the Symfony `TransportInterface`. This class handles the sending, receiving, acknowledging, and rejecting of messages using a MongoDB collection.
+
+The project uses Composer for dependency management, PHPUnit for testing, Infection for mutation testing, and PHPStan for static analysis.
+
+# Building and Running
+
+## Dependencies
+
+Install dependencies using Composer:
+
+```bash
+composer install
+```
+
+## Running Tests
+
+Run the test suite using PHPUnit:
+
+```bash
+vendor/bin/phpunit
+```
+
+## Static Analysis
+
+Run PHPStan for static analysis:
+
+```bash
+vendor/bin/phpstan analyse src tests
+```
+
+## Mutation Testing
+
+Run Infection for mutation testing:
+
+```bash
+vendor/bin/infection
+```
+
+# Development Conventions
+
+## Coding Style
+
+The project follows the PSR-12 coding style guide.
+
+## Testing
+
+The project has a comprehensive test suite using PHPUnit. Tests are located in the `tests` directory and are separated into unit and integration tests.
+
+## Contribution
+
+Contributions are welcome. Please open an issue or create a pull request on the [GitHub repository](https://github.com/eMAGTechLabs/messenger-mongo-bundle).

composer.json

@@ -19,18 +19,18 @@
     "require": {
         "php": "^8.1",
         "ext-json": "*",
-        "ext-mongodb": "*",
-        "symfony/messenger": "^5.0 || ^6.0 || ^7.0",
+        "ext-mongodb": "^2.1.4",
+        "symfony/messenger": "^6.0 || ^7.0",
         "mongodb/mongodb": "^2.1"
     },
     "require-dev": {
-        "symfony/serializer": "^5.0 || ^6.0 || ^7.0",
-        "symfony/property-access": "^5.0 || ^6.0 || ^7.0",
-        "symfony/var-dumper": "^5.0 || ^6.0 || ^7.0",
-        "symfony/framework-bundle": "^5.0 || ^6.0 || ^7.0",
+        "symfony/serializer": "^6.0 || ^7.0",
+        "symfony/property-access": "^6.0 || ^7.0",
+        "symfony/var-dumper": "^6.0 || ^7.0",
+        "symfony/framework-bundle": "^6.0 || ^7.0",
         "phpunit/phpunit": "^10.5",
         "infection/infection": "^0.27.9",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^2.1"
     },
     "autoload": {
         "psr-4": {

docker-compose.yaml

@@ -1,4 +1,3 @@
-version: '3.6'
 services:
     php:
         build:
@@ -14,5 +13,3 @@ services:
         environment:
             - MONGO_INITDB_ROOT_USERNAME=root
             - MONGO_INITDB_ROOT_PASSWORD=rootpass
-
-

docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.3-alpine
+FROM php:8.4-alpine
 
 WORKDIR /var/www/html
 
@@ -7,7 +7,7 @@ RUN apk update \
   && apk add --no-cache git zip make autoconf g++ openssl-dev linux-headers \
   && apk add --no-cache --virtual .build-deps $PHPIZE_DEPS
 
-RUN pecl -q install mongodb-1.17.2  \
+RUN pecl -q install mongodb-2.1.4  \
   && docker-php-ext-enable mongodb \
   && pecl -q install xdebug  \
   && docker-php-ext-enable xdebug
@@ -18,4 +18,4 @@ RUN curl --silent --show-error https://getcomposer.org/installer | php \
   && mv composer.phar /usr/local/bin/composer \
   && chmod o+x /usr/local/bin/composer
 
-ENTRYPOINT ["tail", "-f", "/dev/null"]
+ENTRYPOINT ["tail", "-f", "/dev/null"]

phpstan.neon.dist

@@ -1,8 +1,5 @@
 parameters:
     level: 5
-    checkMissingIterableValueType: false
     paths:
         - src
         - tests
-    ignoreErrors:
-        - '#Access to an undefined property MongoDB\\Collection::\$documents.#'

src/MongoTransport.php

@@ -102,7 +102,6 @@ public function get(): iterable
      */
     private function removeMessage(Envelope $envelope): void
     {
-        /** @var TransportMessageIdStamp $transportMessageIdStamp */
         $transportMessageIdStamp = $envelope->last(TransportMessageIdStamp::class);
 
         if (!$transportMessageIdStamp instanceof TransportMessageIdStamp) {
@@ -161,7 +160,7 @@ public function send(Envelope $envelope): Envelope
         return $envelope->with(new TransportMessageIdStamp($objectId));
     }
 
-    public function all(int $limit = null): iterable
+    public function all(?int $limit = null): iterable
     {
         $documents = $this->collection->find([], ['limit' => $limit]);
 
@@ -170,7 +169,7 @@ public function all(int $limit = null): iterable
         }
     }
 
-    public function find($id): ?Envelope
+    public function find(mixed $id): ?Envelope
     {
         $document = $this->collection->findOne(['_id' => is_string($id) ? new ObjectId($id) : $id]);
 

tests/Unit/MongoTransportTest.php

@@ -6,11 +6,15 @@
 
 use EmagTechLabs\MessengerMongoBundle\MongoTransport;
 use EmagTechLabs\MessengerMongoBundle\Tests\Unit\Fixtures\HelloMessage;
+use MongoDB\BSON\Int64;
 use MongoDB\BSON\ObjectId;
 use MongoDB\Collection;
+use MongoDB\Driver\CursorInterface;
+use MongoDB\Driver\Server;
 use MongoDB\InsertOneResult;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
@@ -195,7 +199,24 @@ public function itShouldReturnNothingIfIdCouldNotBeFound(): void
     #[Test]
     public function itShouldSendAMessage(): void
     {
-        $collection = $this->createCollection();
+        $collection = new class extends Collection {
+            public array $documents = [];
+
+            public function __construct()
+            {
+            }
+
+            public function insertOne($document, array $options = []): InsertOneResult
+            {
+                $this->documents[] = $document;
+
+                return new class extends InsertOneResult {
+                    public function __construct()
+                    {
+                    }
+                };
+            }
+        };
 
         $transport = new MongoTransport(
             $collection,
@@ -252,28 +273,6 @@ public function itShouldDeleteTheDocumentOnAckOrReject(): void
         $transport->reject($envelope);
     }
 
-    private function createCollection(array $documents = []): Collection
-    {
-        return new class extends Collection {
-            public array $documents = [];
-
-            public function __construct()
-            {
-            }
-
-            public function insertOne($document, array $options = []): InsertOneResult
-            {
-                $this->documents[] = $document;
-
-                return new class extends InsertOneResult {
-                    public function __construct()
-                    {
-                    }
-                };
-            }
-        };
-    }
-
     private function createDocument(): array
     {
         return [
@@ -291,9 +290,9 @@ private function createSerializer(): SerializerInterface
         return new Serializer();
     }
 
-    private function createCursor(array $documents): \MongoDB\Driver\CursorInterface
+    private function createCursor(array $documents): CursorInterface
     {
-        return new class($documents) implements \MongoDB\Driver\CursorInterface
+        return new class($documents) implements CursorInterface
         {
             private array $data;
             private int $position = 0;
@@ -342,14 +341,14 @@ public function setTypeMap(array $typemap): void
             {
             }
 
-            public function getId(): \MongoDB\BSON\Int64
+            public function getId(): Int64
             {
-                throw new \RuntimeException('Not implemented in test cursor.');
+                throw new RuntimeException('Not implemented in test cursor.');
             }
 
-            public function getServer(): \MongoDB\Driver\Server
+            public function getServer(): Server
             {
-                throw new \RuntimeException('Not implemented in test cursor.');
+                throw new RuntimeException('Not implemented in test cursor.');
             }
         };
     }