V5.x to master (#29)

* Added support for Laravel 10.x (#15)

* Updated mongodb/laravel-mongodb package (#16)

* Refactor method signatures in MongoDbSessionHandler for clarity and type safety. Add .editorconfig for consistent coding style across files. Update composer.json to include ext-mongodb requirement. (#23)

* V5.x rebase (#25)

* v5.x to master (#17)

* Added support for Laravel 10.x (#15)

* Updated mongodb/laravel-mongodb package (#16)
# Conflicts:
#	composer.json

* Update laravel mongodb to rc1 (#18)

* Added support for Laravel 10.x (#15)

* Updated mongodb/laravel-mongodb package (#16)

* Updated mongodb/laravel-mongodb to rc1.

* Updated mongodb/laravel-mongodb to stable version 4. (#19)

* Changed package version

* Update deprecated MongoDB read preference constants to use current values (#28)

* Update deprecated MongoDB read preference constants to use current values

* Bump version to 5.0.5 in composer.json for updated dependencies

* Update session testing suite, add MongoDB test cases, and configure PHPUnit

- Enhance `.gitignore` to exclude `.phpunit.cache`.
- Update GitHub workflow to include Testbench version for Laravel 10.x.
- Create new feature tests: `TestHelperIntegrationTest`, `HttpSessionTest`, and `MongoDbSessionHandlerTest` to validate session handling with MongoDB.
- Refactor MongoDB session command files to remove unnecessary docblocks.
- Document testing process in `README.md`, including setup and expected results.
- Add basic PHPUnit configuration file.
- Define session environment in the base `TestCase`.
- Ensure session operations like reading, writing, and destruction are tested against MongoDB.

* Update GitHub Actions workflow to use MongoDB 7 and improve caching

- Add MongoDB 7 service to CI workflow
- Upgrade checkout action to v3
- Include MongoDB extension in PHP setup
- Implement Composer dependency caching for faster builds
- Modify composer install command for better performance
- Set environment variables for MongoDB connection during test execution
- Update README.md to reflect changes in the CI process

* Remove deprecated MongoDB version constraint from composer.json

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

* Update mongodb/laravel-mongodb package to version 5.0 in composer.json

* Update MongoDB commands and improve session handling

Refactor the command to use `getDatabase()` instead of `getMongoDB()`. Update payload access in `MongoDbSessionHandler` from array syntax to object syntax for better readability. Adjust test assertions to match the new access methodology and ensure compatibility with Carbon instances for expiration and last activity timestamps. Clean up formatting inconsistencies throughout the code.

* Update MongoDB connection method to use getDatabase() instead of getMongoDB() in MongodbSessionIndex command

* Update GitHub Actions workflow to trigger on the master branch

---------

Co-authored-by: Ivaylo Mutafov <[email protected]>

Author: DevquasarX9

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

@@ -2,34 +2,66 @@ name: "Run Tests - Laravel 10"
 
 on:
   push:
-    branches: [ v5.x ]
+    branches: [ v5.x, master ]
 
   pull_request:
-    branches: [ v5.x ]
+    branches: [ v5.x, master ]
 
 jobs:
   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@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: pdo, sqlite, pdo_sqlite
+          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
+        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_session_test

.gitignore

@@ -1,2 +1,3 @@
 /vendor
-composer.lock
+composer.lock
+.phpunit.cache

README.md

@@ -34,3 +34,71 @@ Advantages
 
 Enjoy!
 ------
+
+## Testing
+
+This package includes a comprehensive test suite to ensure the MongoDB session handler works correctly. The tests cover:
+
+1. Basic session operations (read, write, destroy)
+2. Integration with Laravel's session system
+3. HTTP session functionality
+4. Laravel's testing helpers integration
+
+### Running the Tests
+
+To run the tests, follow these steps:
+
+1. Make sure MongoDB is installed and running on your system
+2. Install the package dependencies with Composer:
+
+```bash
+composer install
+```
+
+3. Run the tests with PHPUnit:
+
+```bash
+vendor/bin/phpunit
+```
+
+### Continuous Integration
+
+The package includes a GitHub Actions workflow that automatically runs tests on PHP 8.1 with Laravel 10.x against MongoDB 7. The workflow:
+
+1. Sets up a MongoDB service container
+2. Installs PHP with MongoDB extension
+3. Caches Composer dependencies for faster builds
+4. Runs the test suite
+
+This ensures all tests pass before merging new changes.
+
+### Expected Test Results
+
+When all tests are passing, you should see output similar to:
+
+```
+PHPUnit 10.x.x by Sebastian Bergmann and contributors.
+
+...............                                                   15 / 15 (100%)
+
+Time: 00:00.444, Memory: 32.00 MB
+
+OK (15 tests, 41 assertions)
+```
+
+### Testing Environments
+
+The tests are compatible with:
+
+- PHP 8.1+
+- Laravel 10.x
+- MongoDB 4.0+
+
+### Test Coverage
+
+- **Unit Tests**: These test the `MongoDbSessionHandler` methods directly (open, close, read, write, destroy, gc)
+- **Feature Tests**: These test the integration with Laravel's session functionality
+- **HTTP Tests**: These test session handling in HTTP requests and session persistence
+- **Laravel Helper Tests**: These test integration with Laravel's testing helpers like `withSession` and `flushSession`
+
+If you encounter any issues with the tests, please submit an issue on the GitHub repository.

composer.json

@@ -2,14 +2,16 @@
     "name": "1ff/laravel-mongodb-session",
     "description": "A mongodb session driver for laravel",
     "type": "library",
-    "version": "5.0.4",
     "require": {
         "php": "^8.1",
         "illuminate/session": "^10.0",
-        "mongodb/laravel-mongodb": "^4.0",
+        "mongodb/laravel-mongodb": "^5.0",
         "ext-mongodb": "*"
     },
-
+    "require-dev": {
+        "phpunit/phpunit": "^10.0",
+        "orchestra/testbench": "^8.0"
+    },
     "license": "MIT",
     "authors": [
         {
@@ -27,11 +29,19 @@
             "ForFit\\Session\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "ForFit\\Session\\Tests\\": "tests"
+        }
+    },
     "extra": {
         "laravel": {
             "providers": [
                 "ForFit\\Session\\SessionServiceProvider"
             ]
         }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
     }
 }

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    backupGlobals="false"
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="MONGODB_HOST" value="127.0.0.1"/>
+        <env name="MONGODB_PORT" value="27017"/>
+        <env name="MONGODB_DATABASE" value="laravel_session_test"/>
+    </php>
+</phpunit> 

src/Console/Commands/MongodbSessionDropIndex.php

@@ -4,42 +4,30 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
-use \MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\ReadPreference;
 
 /**
  * Drop the indexes created by MongodbSessionIndex
  */
 class MongodbSessionDropIndex extends Command
 {
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** The name and signature of the console command. */
     protected $signature = 'mongodb:session:dropindex {index}';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** The console command description. */
     protected $description = 'Drops the passed index from the mongodb `sessions` collection';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
+    /** Execute the console command. */
+    public function handle(): void
     {
         $collection = config('session.table');
 
-        DB::connection('mongodb')->getMongoDB()->command([
+        DB::connection('mongodb')->getDatabase()->command([
             'dropIndexes' => $collection,
             'index' => $this->argument('index'),
         ], [
-            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY)
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
         ]);
     }
 }

src/Console/Commands/MongodbSessionIndex.php

@@ -4,38 +4,26 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
-use \MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\ReadPreference;
 
 /**
  * Create indexes for the Session collection
  */
 class MongodbSessionIndex extends Command
 {
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** The name and signature of the console command. */
     protected $signature = 'mongodb:session:index';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** The console command description. */
     protected $description = 'Create indexes on the mongodb `sessions` collection';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
+    /** Execute the console command. */
+    public function handle(): void
     {
         $collection = config('session.table');
 
-        DB::connection('mongodb')->getMongoDB()->command([
+        DB::connection('mongodb')->getDatabase()->command([
             'createIndexes' => $collection,
             'indexes' => [
                 [
@@ -46,7 +34,7 @@ public function handle()
                 ]
             ]
         ], [
-            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY)
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
         ]);
     }
 }

src/Database/Migrations/2019_08_01_000000_index_mongodb_sessions_collection.php

@@ -11,7 +11,7 @@ class IndexMongodbSessionsCollection extends Migration
      *
      * @return void
      */
-    public function up()
+    public function up(): void
     {
         Artisan::call('mongodb:session:index');
     }
@@ -21,7 +21,7 @@ public function up()
      *
      * @return void
      */
-    public function down()
+    public function down(): void
     {
         Artisan::call('mongodb:session:dropindex', ['index' => 'expires_at_ttl']);
     }

src/MongoDbSessionHandler.php

@@ -2,8 +2,8 @@
 
 namespace ForFit\Session;
 
-use MongoDB\BSON\UTCDateTime;
 use MongoDB\BSON\Binary;
+use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\Exception\BulkWriteException;
 use SessionHandlerInterface;
 
@@ -14,14 +14,14 @@ class MongoDbSessionHandler implements SessionHandlerInterface
     protected $table;
 
     /**
-     * @param  \Illuminate\Database\ConnectionInterface  $connection
+     * @param \Illuminate\Database\ConnectionInterface $connection
      * @param string $table
      * @param integer $minutes
      */
     public function __construct($connection, $table = 'sessions', $minutes = 60)
     {
         $this->connection = $connection;
-        $this->minutes = (int) $minutes;
+        $this->minutes = (int)$minutes;
         $this->table = $table;
     }
 
@@ -48,7 +48,7 @@ public function read($id): false|string
     {
         $session = $this->query()->find($id);
 
-        return $session ? $session['payload'] : '';
+        return $session ? $session->payload : '';
     }
 
     /**
@@ -57,7 +57,7 @@ public function read($id): false|string
     public function write($id, $data): bool
     {
         try {
-            return (bool) $this->query()
+            return (bool)$this->query()
                 ->where('_id', $id)
                 ->update($this->buildPayload($data), ['upsert' => true]);
         } catch (BulkWriteException $exception) {