Add transaction support

.github/workflows/build-ci.yml

@@ -42,44 +42,57 @@ jobs:
           MYSQL_ROOT_PASSWORD:
 
     steps:
-    - uses: actions/checkout@v2
-    - name: "Installing php"
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        extensions: curl,mbstring,xdebug
-        coverage: xdebug
-        tools: composer
-    - name: Show PHP version
-      run: php -v && composer -V
-    - name: Show Docker version
-      run: if [[ "$DEBUG" == "true" ]]; then docker version && env; fi
-      env:
-        DEBUG: ${{secrets.DEBUG}}
-    - name: Download Composer cache dependencies from cache
-      if: (!startsWith(matrix.php, '7.2'))
-      id: composer-cache
-      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-    - name: Cache Composer dependencies
-      if: (!startsWith(matrix.php, '7.2'))
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ matrix.os }}-composer-${{ hashFiles('**/composer.json') }}
-        restore-keys: ${{ matrix.os }}-composer-
-    - name: Install dependencies
-      if: (!startsWith(matrix.php, '7.2'))
-      run: |
-        composer install --no-interaction
-    - name: Run tests
-      if: (!startsWith(matrix.php, '7.2'))
-      run: |
-        ./vendor/bin/phpunit --coverage-clover coverage.xml
-      env:
-        MONGO_HOST: 0.0.0.0
-        MYSQL_HOST: 0.0.0.0
-        MYSQL_PORT: 3307
-    - uses: codecov/codecov-action@v1
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        fail_ci_if_error: false
+      - uses: actions/checkout@v2
+      - name: Creating MongoDB replica
+        if: matrix.mongodb == '4.0' || matrix.mongodb == '4.2' || matrix.mongodb == '4.4'
+        run: |
+          docker run --name mongodb_repl -e MONGO_INITDB_DATABASE=unittest --publish 27018:27018 --detach mongo:${{ matrix.mongodb }} mongod --port 27018 --replSet rs
+          until docker exec --tty mongodb_repl mongo 127.0.0.1:27018 --eval "db.serverStatus()"; do
+          sleep 1
+          done
+          sudo docker exec --tty mongodb_repl mongo 127.0.0.1:27018 --eval "rs.initiate({\"_id\":\"rs\",\"members\":[{\"_id\":0,\"host\":\"127.0.0.1:27018\" }]})"
+        env:
+          MONGO_HOST: 0.0.0.0
+          MONGO_REPL_HOST: 0.0.0.0
+      - name: "Installing php"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl,mbstring,xdebug
+          coverage: xdebug
+          tools: composer
+      - name: Show PHP version
+        run: php -v && composer -V
+      - name: Show Docker version
+        run: if [[ "$DEBUG" == "true" ]]; then docker version && env; fi
+        env:
+          DEBUG: ${{secrets.DEBUG}}
+      - name: Download Composer cache dependencies from cache
+        if: (!startsWith(matrix.php, '7.2'))
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+      - name: Cache Composer dependencies
+        if: (!startsWith(matrix.php, '7.2'))
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ matrix.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ matrix.os }}-composer-
+      - name: Install dependencies
+        if: (!startsWith(matrix.php, '7.2'))
+        run: |
+          composer install --no-interaction
+      - name: Run tests
+        if: (!startsWith(matrix.php, '7.2'))
+        run: |
+          ./vendor/bin/phpunit --coverage-clover coverage.xml
+        env:
+          MONGO_VERSION: ${{ matrix.mongodb }})
+          MONGO_HOST: 0.0.0.0
+          MONGO_REPL_HOST: 0.0.0.0
+          MYSQL_HOST: 0.0.0.0
+          MYSQL_PORT: 3307
+      - uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false

README.md

@@ -36,6 +36,7 @@ This package adds functionalities to the Eloquent model and Query builder for Mo
   - [Query Builder](#query-builder)
     - [Basic Usage](#basic-usage-2)
     - [Available operations](#available-operations)
+  - [Transaction](#transaction)
   - [Schema](#schema)
     - [Basic Usage](#basic-usage-3)
     - [Geospatial indexes](#geospatial-indexes)
@@ -968,6 +969,46 @@ If you are familiar with [Eloquent Queries](http://laravel.com/docs/queries), th
 ### Available operations
 To see the available operations, check the [Eloquent](#eloquent) section.
 
+Transaction
+-------
+Transaction requires MongoDB version ^4.0 as well as deployment of replica set or sharded clusters. You can find more information [in the MongoDB docs](https://docs.mongodb.com/manual/core/transactions/)
+
+### Basic Usage
+
+Transaction supports CREATE/INSERT/UPDATE/DELETE operations.
+
+```php
+DB::transaction(function () {
+    User::create(['name' => 'john', 'age' => 19, 'title' => 'admin', 'email' => '[email protected]']);
+    DB::collection('users')->where('name', 'john')->update(['age' => 20]);
+    DB::collection('users')->where('name', 'john')->delete();
+});
+```
+
+```php
+// begin a transaction
+DB::beginTransaction();
+User::create(['name' => 'john', 'age' => 19, 'title' => 'admin', 'email' => '[email protected]']);
+DB::collection('users')->where('name', 'john')->update(['age' => 20]);
+DB::collection('users')->where('name', 'john')->delete();
+
+// you can commit your changes
+DB::commit();
+
+// you can also rollback them
+//DB::rollBack();
+```
+
+**NOTE:** Transaction supports infinite-level of nested transactions, but outside transaction rollbacks do not affect the commits of inside transactions.
+```php
+DB::beginTransaction();
+User::create(['name' => 'john', 'age' => 20, 'title' => 'admin']);
+DB::transaction(function () {
+    DB::collection('users')->where('name', 'john')->update(['age' => 20]);
+});
+DB::rollBack();
+```
+
 Schema
 ------
 The database driver also has (limited) schema builder support. You can easily manipulate collections and set indexes.

docker-compose.yml

@@ -10,8 +10,14 @@ services:
             - .:/code
         working_dir: /code
         depends_on:
-          - mongodb
-          - mysql
+            - mongodb
+            - mongodb_repl
+            - mongodb_repl_2
+            - mongodb_repl_3
+            - mongo_repl_init
+            - mysql
+        stdin_open: true
+        tty: true
 
     mysql:
         container_name: mysql
@@ -32,3 +38,55 @@ services:
             - 27017:27017
         logging:
             driver: none
+
+    mongodb_repl:
+        container_name: mongodb_repl
+        image: mongo:4.2.5
+        restart: always
+        ports:
+            - "27018:27018"
+        entrypoint: [ "/usr/bin/mongod", "--quiet", "--bind_ip_all",  "--port",  "27018", "--replSet", "rs" ]
+        depends_on:
+            - mongodb_repl_2
+            - mongodb_repl_3
+        logging:
+            driver: none
+
+    mongodb_repl_2:
+        container_name: mongodb_repl_2
+        image: mongo:4.2.5
+        restart: always
+        ports:
+            - "27019:27018"
+        entrypoint: [ "/usr/bin/mongod", "--quiet", "--bind_ip_all", "--port",  "27018", "--replSet", "rs" ]
+        depends_on:
+            - mongodb_repl_3
+        logging:
+            driver: none
+
+    mongodb_repl_3:
+        container_name: mongodb_repl_3
+        image: mongo:4.2.5
+        restart: always
+        ports:
+            - "27020:27018"
+        entrypoint: [ "/usr/bin/mongod", "--quiet", "--bind_ip_all",  "--port",  "27018", "--replSet", "rs" ]
+        logging:
+            driver: none
+
+    mongo_repl_init:
+        image: mongo:4.2.5
+        depends_on:
+            - mongodb_repl
+            - mongodb_repl_2
+            - mongodb_repl_3
+        environment:
+            - MONGO1=mongodb_repl
+            - MONGO2=mongodb_repl_2
+            - MONGO3=mongodb_repl_3
+            - RS=rs
+        volumes:
+            - ./:/scripts
+        entrypoint: [ "sh", "-c", "/scripts/mongo-repl-init.sh" ]
+        logging:
+            driver: none

mongo-replset-init.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+mongodb1=`getent hosts ${MONGO1} | awk '{ print $1 }'`
+
+port=${PORT:-27018}
+
+echo "Waiting for startup.."
+until mongo --host ${mongodb1}:${port} --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 2)' &>/dev/null; do
+  printf '.'
+  sleep 1
+done
+
+echo "Started.."
+
+echo setup.sh time now: `date +"%T" `
+mongo --host ${mongodb1}:${port} <<EOF
+   var cfg = {
+        "_id": "${RS}",
+        "protocolVersion": 1,
+        "members": [
+            {
+                "_id": 0,
+                "host": "${MONGO1}:${port}",
+                "priority": 2
+            },
+            {
+                "_id": 1,
+                "host": "${MONGO2}:${port}",
+                "priority": 0
+            },
+            {
+                "_id": 2,
+                "host": "${MONGO3}:${port}",
+                "priority": 0
+            }
+        ]
+    };
+    rs.initiate(cfg, { force: true });
+    rs.reconfig(cfg, { force: true });
+EOF

phpunit.xml.dist

@@ -19,6 +19,10 @@
             <file>tests/QueryBuilderTest.php</file>
             <file>tests/QueryTest.php</file>
         </testsuite>
+        <testsuite name="transaction">
+            <file>tests/TransactionBuilderTest.php</file>
+            <file>tests/TransactionTest.php</file>
+        </testsuite>
         <testsuite name="model">
             <file>tests/ModelTest.php</file>
             <file>tests/RelationsTest.php</file>
@@ -36,6 +40,7 @@
     </testsuites>
     <php>
         <env name="MONGO_HOST" value="mongodb"/>
+        <env name="MONGO_REPL_HOST" value="mongodb_repl"/>
         <env name="MONGO_DATABASE" value="unittest"/>
         <env name="MONGO_PORT" value="27017"/>
         <env name="MYSQL_HOST" value="mysql"/>

src/Jenssegers/Mongodb/Connection.php

@@ -6,6 +6,9 @@
 use Illuminate\Support\Arr;
 use InvalidArgumentException;
 use MongoDB\Client;
+use MongoDB\Driver\ReadConcern;
+use MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\WriteConcern;
 
 class Connection extends BaseConnection
 {
@@ -21,6 +24,17 @@ class Connection extends BaseConnection
      */
     protected $connection;
 
+    /**
+     * A random unique id for identification of transaction.
+     * @var string
+     */
+    protected $session_key;
+    /**
+     * A list of transaction sessions.
+     * @var array
+     */
+    protected $sessions = [];
+
     /**
      * Create a new database connection instance.
      * @param array $config
@@ -277,4 +291,78 @@ public function __call($method, $parameters)
     {
         return call_user_func_array([$this->db, $method], $parameters);
     }
+
+    /**
+     * create a session and start a transaction in session
+     *
+     * In version 4.0, MongoDB supports multi-document transactions on replica sets.
+     * In version 4.2, MongoDB introduces distributed transactions, which adds support for multi-document transactions on sharded clusters and incorporates the existing support for multi-document transactions on replica sets.
+     * To use transactions on MongoDB 4.2 deployments(replica sets and sharded clusters), clients must use MongoDB drivers updated for MongoDB 4.2.
+     *
+     * @see https://docs.mongodb.com/manual/core/transactions/
+     * @return void
+     */
+    public function beginTransaction()
+    {
+        $this->session_key = uniqid();
+        $this->sessions[$this->session_key] = $this->connection->startSession();
+
+        $this->sessions[$this->session_key]->startTransaction([
+            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
+            'writeConcern' => new WriteConcern(1),
+            'readConcern' => new ReadConcern(ReadConcern::LOCAL)
+        ]);
+    }
+
+    /**
+     * commit transaction in this session and close this session
+     * @return void
+     */
+    public function commit()
+    {
+        if ($session = $this->getSession()) {
+            $session->commitTransaction();
+            $this->setLastSession();
+        }
+    }
+
+    /**
+     * rollback transaction in this session and close this session
+     * @return void
+     */
+    public function rollBack($toLevel = null)
+    {
+        if ($session = $this->getSession()) {
+            $session->abortTransaction();
+            $this->setLastSession();
+        }
+    }
+
+    /**
+     * close this session and get last session key to session_key
+     * Why do it ? Because nested transactions
+     * @return void
+     */
+    protected function setLastSession()
+    {
+        if ($session = $this->getSession()) {
+            $session->endSession();
+            unset($this->sessions[$this->session_key]);
+            if (empty($this->sessions)) {
+                $this->session_key = null;
+            } else {
+                end($this->sessions);
+                $this->session_key = key($this->sessions);
+            }
+        }
+    }
+
+    /**
+     * get now session if it has session
+     * @return \MongoDB\Driver\Session|null
+     */
+    public function getSession()
+    {
+        return $this->sessions[$this->session_key] ?? null;
+    }
 }