Update mongodb/laravel-mongodb package to version 5.0 in composer.json (#40)

* Refactor StoreTest to use attributes for test annotations, update PHPUnit configuration and improve code type hints. Adjust .gitignore for PHPUnit cache directory and add ext-mongodb requirement in composer.json.

* Stop using deprecated RP_PRIMARY and replace it with PRIMARY in MongoDB read preferences.

* Update mongodb/laravel-mongodb package to version 5.0

* Add test script to composer.json for PHPUnit execution

* Update MongoDB package to ensure compatibility with v5

Refactor `first` method in Builder to handle object and array scenarios effectively. Adjust queries in Store and command files to use `getDatabase()` instead of `getMongoDB()`. Update property accessors for cache data to support object dereferencing.

* Remove deprecated MongoDB builder and helper classes, and refactor tests to use direct database connections. Update GitHub Actions to ensure MongoDB service is available during testing.

* Update MongoDB package and enhance test suite

- Add PHP attribute to require the MongoDB extension in tests.
- Refactor the `TestCase` class for improved environment setup.
- Introduce new test classes: `AdvancedCacheFeaturesTest`, `TaggedCacheTest`, and `LaravelIntegrationTest` to cover various aspects of the MongoDB cache driver.
- Implement tests for incrementing, decrementing, storing arrays/objects, and tagged cache functionality.
- Document test structure in README for clarity on test organization and coverage.

Author: DevquasarX9

.github/workflows/run-tests-l10.yml

@@ -2,38 +2,67 @@ name: "Run Tests - Laravel 10"
 
 on:
     push:
-        branches: [ v6.x, master ]
+        branches: [ v6.x ]
 
     pull_request:
-        branches: [ v6.x, master ]
+        branches: [ v6.x ]
 
 jobs:
-  tests:
-
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        php: [8.1]
-        laravel: [10.*]
-        include:
-          - laravel: 10.*
-            testbench: 8.*
-
-    name: P${{ matrix.php }} - L${{ matrix.laravel }}
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        extensions: pdo, sqlite, pdo_sqlite
-
-    - name: Install Dependencies
-      run: composer install
-
-    - name: Execute tests
-      run: vendor/bin/phpunit
+    tests:
+
+        runs-on: ubuntu-latest
+
+        services:
+            mongodb:
+                image: mongo:7
+                ports:
+                    - 27017:27017
+                options: >-
+                    --health-cmd="mongosh --quiet --eval 'db.runCommand({ping:1})'"
+                    --health-interval 10s
+                    --health-timeout 5s
+                    --health-retries 3
+
+        strategy:
+            fail-fast: false
+            matrix:
+                php: [ 8.1 ]
+                laravel: [ 10.* ]
+                include:
+                    -   laravel: 10.*
+                        testbench: 10.*
+
+        name: P${{ matrix.php }} - L${{ matrix.laravel }}
+
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v3
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php }}
+                    extensions: pdo, sqlite, pdo_sqlite, mongodb
+                    coverage: none
+
+            -   name: Get composer cache directory
+                id: composer-cache
+                run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+            -   name: Cache dependencies
+                uses: actions/cache@v3
+                with:
+                    path: ${{ steps.composer-cache.outputs.dir }}
+                    key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+                    restore-keys: ${{ runner.os }}-composer-
+
+            -   name: Install Dependencies
+                run: composer install --prefer-dist --no-interaction --no-progress
+
+
+            -   name: Execute tests
+                run: vendor/bin/phpunit
+                env:
+                    MONGODB_HOST: 127.0.0.1
+                    MONGODB_PORT: 27017
+                    MONGODB_DATABASE: laravel_mongodb_cache_test

README.md

@@ -66,6 +66,59 @@ Advantages
 
         php artisan mongodb:cache:dropindex
 
+Testing
+-------
+
+This package includes tests that interact with a real MongoDB database to verify the functionality of the cache driver. The tests require a MongoDB instance to run successfully.
+
+To run the tests:
+
+1. Make sure you have MongoDB installed and running on your local machine
+2. The test configuration is set in `phpunit.xml`:
+
+```xml
+<php>
+    <env name="MONGODB_HOST" value="127.0.0.1"/>
+    <env name="MONGODB_PORT" value="27017"/>
+    <env name="MONGODB_DATABASE" value="laravel_mongodb_cache_test"/>
+    <env name="MONGODB_USERNAME" value=""/>
+    <env name="MONGODB_PASSWORD" value=""/>
+</php>
+```
+
+3. Run the tests with:
+
+```
+composer test
+```
+
+or
+
+```
+vendor/bin/phpunit
+```
+
+### Test Structure
+
+The test suite is organized into multiple files to test various aspects of the MongoDB cache driver:
+
+- `StoreTest.php`: Tests basic Store class functionality (get, put, forget, flush)
+- `AdvancedCacheFeaturesTest.php`: Tests advanced Store features like increment/decrement, forever storage, and handling arrays/objects
+- `TaggedCacheTest.php`: Tests tagged cache functionality
+- `LaravelIntegrationTest.php`: Tests integration with Laravel's Cache facade
+
+Some functionality (like increment/decrement, forever storage) is intentionally tested in multiple contexts:
+1. At the low-level Store implementation
+2. Through Laravel's Cache facade
+3. With tagged cache operations
+
+This multi-layered approach ensures that all feature functionality works correctly at all levels of integration.
+
+GitHub Actions
+-------------
+
+The package includes GitHub Actions workflows that automatically run tests against a MongoDB service. The MongoDB service is started as part of the CI workflow, ensuring tests are executed in an environment with a real MongoDB database.
+
 Warning
 -------
 

composer.json

@@ -5,7 +5,7 @@
     "require": {
         "php": "^8.1",
         "illuminate/cache": "^10.0",
-        "mongodb/laravel-mongodb": "^4.1",
+        "mongodb/laravel-mongodb": "^5.0",
         "ext-mongodb": "*"
     },
     "require-dev": {
@@ -39,5 +39,8 @@
                 "ForFit\\Mongodb\\Cache\\ServiceProvider"
             ]
         }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
     }
 }

phpunit.xml

@@ -10,5 +10,10 @@
     </testsuites>
     <php>
         <env name="CACHE_DRIVER" value="array"/>
+        <env name="MONGODB_HOST" value="127.0.0.1"/>
+        <env name="MONGODB_PORT" value="27017"/>
+        <env name="MONGODB_DATABASE" value="laravel_mongodb_cache_test"/>
+        <env name="MONGODB_USERNAME" value=""/>
+        <env name="MONGODB_PASSWORD" value=""/>
     </php>
 </phpunit>

src/Console/Commands/MongodbCacheDropIndex.php

@@ -23,7 +23,7 @@ public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
-        DB::connection('mongodb')->getMongoDB()->command([
+        DB::connection('mongodb')->getDatabase()->command([
             'dropIndexes' => $cacheCollectionName,
             'index' => $this->argument('index'),
         ], [

src/Console/Commands/MongodbCacheIndex.php

@@ -23,7 +23,7 @@ public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
-        DB::connection('mongodb')->getMongoDB()->command([
+        DB::connection('mongodb')->getDatabase()->command([
             'createIndexes' => $cacheCollectionName,
             'indexes' => [
                 [

src/Console/Commands/MongodbCacheIndexTags.php

@@ -23,7 +23,7 @@ public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
-        DB::connection('mongodb')->getMongoDB()->command([
+        DB::connection('mongodb')->getDatabase()->command([
             'createIndexes' => $cacheCollectionName,
             'indexes' => [
                 [

src/Store.php

@@ -7,9 +7,9 @@
 use Illuminate\Contracts\Cache\Store as StoreInterface;
 use Illuminate\Database\ConnectionInterface;
 use Illuminate\Support\InteractsWithTime;
-use Jenssegers\Mongodb\Query\Builder;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\Exception\BulkWriteException;
+use MongoDB\Laravel\Query\Builder;
 
 class Store implements StoreInterface
 {
@@ -59,7 +59,7 @@ public function get($key)
     {
         $cacheData = $this->table()->where('key', $this->getKeyWithPrefix($key))->first();
 
-        return $cacheData ? unserialize($cacheData['value']) : null;
+        return $cacheData ? unserialize($cacheData->value) : null;
     }
 
     /**
@@ -165,11 +165,11 @@ public function getExpiration($key): ?float
     {
         $cacheData = $this->table()->where('key', $this->getKeyWithPrefix($key))->first();
 
-        if (empty($cacheData['expiration'])) {
+        if (empty($cacheData->expiration)) {
             return null;
         }
 
-        $expirationSeconds = $cacheData['expiration']->toDateTime()->getTimestamp();
+        $expirationSeconds = $cacheData->expiration->toDateTime()->getTimestamp();
 
         return round($expirationSeconds - $this->currentTime());
     }