Remove support for legacy mongoDb extension, added more typehints

Author: TavoNiievez

src/Codeception/Lib/Driver/MongoDb.php

@@ -7,21 +7,14 @@
 use Codeception\Exception\ModuleConfigException;
 use Codeception\Exception\ModuleException;
 use Exception;
-use MongoClient;
-use MongoConnectionException;
 use MongoDB\Database;
-use MongoException;
 
 class MongoDb
 {
     /**
      * @var int
      */
     const DEFAULT_PORT = 27017;
-    /**
-     * @var bool
-     */
-    private $isLegacy;
     /**
      * @var \Codeception\Lib\Driver\MongoDB|null
      */
@@ -34,23 +27,18 @@ class MongoDb
     private $user;
     private $password;
     /**
-     * @var \MongoDB\Client|MongoClient|null
+     * @var \MongoDB\Client|null
      */
     private $client;
     /**
      * @var string
      */
     private $quiet = '';
 
-    public static function connect($dsn, $user, $password): void
-    {
-        throw new Exception(__CLASS__ . '::connect() - hm, it looked like this method had become obsolete...');
-    }
-
     /**
      * Connect to the Mongo server using the MongoDB extension.
      */
-    protected function setupMongoDB($dsn, $options): void
+    protected function setupMongoDB(string $dsn, array $options): void
     {
         try {
             $this->client = new \MongoDB\Client($dsn, $options);
@@ -60,19 +48,6 @@ protected function setupMongoDB($dsn, $options): void
         }
     }
 
-    /**
-     * Connect to the Mongo server using the legacy mongo extension.
-     */
-    protected function setupMongo($dsn, $options): void
-    {
-        try {
-            $this->client = new MongoClient($dsn, $options);
-            $this->dbh    = $this->client->selectDB($this->dbName);
-        } catch (MongoConnectionException $e) {
-            throw new ModuleException($this, sprintf('Failed to open Mongo connection: %s', $e->getMessage()));
-        }
-    }
-
     /**
      * Clean up the Mongo database using the MongoDB extension.
      */
@@ -85,43 +60,16 @@ protected function cleanupMongoDB(): void
         }
     }
 
-    /**
-     * Clean up the Mongo database using the legacy Mongo extension.
-     */
-    protected function cleanupMongo(): void
-    {
-        try {
-            $list = $this->dbh->listCollections();
-        } catch (MongoException $e) {
-            throw new Exception(sprintf('Failed to list collections of the DB: %s', $e->getMessage()), $e->getCode(), $e);
-        }
-        foreach ($list as $collection) {
-            try {
-                $collection->drop();
-            } catch (MongoException $e) {
-                throw new Exception(sprintf('Failed to drop collection: %s', $e->getMessage()), $e->getCode(), $e);
-            }
-        }
-    }
-
     /**
      * $dsn has to contain db_name after the host. E.g. "mongodb://localhost:27017/mongo_test_db"
      *
      * @static
      *
-     * @param $dsn
-     * @param $user
-     * @param $password
-     *
      * @throws ModuleConfigException
      * @throws Exception
      */
-    public function __construct($dsn, $user, $password)
+    public function __construct(string $dsn, string $user, string $password)
     {
-        $this->isLegacy = !extension_loaded('mongodb') &&
-            class_exists('\\MongoClient') &&
-            strpos(MongoClient::VERSION, 'mongofill') === false;
-
         /* defining DB name */
         $this->dbName = preg_replace('#\?.*#', '', substr($dsn, strrpos($dsn, '/') + 1));
 
@@ -148,35 +96,31 @@ class_exists('\\MongoClient') &&
             ];
         }
 
-        $this->{$this->isLegacy ? 'setupMongo' : 'setupMongoDB'}($dsn, $options);
+        $this->setupMongoDB($dsn, $options);
         $this->user = $user;
         $this->password = $password;
     }
 
     /**
      * @static
-     *
-     * @param $dsn
-     * @param $user
-     * @param $password
      */
-    public static function create($dsn, $user, $password): \Codeception\Lib\Driver\MongoDb
+    public static function create(string $dsn, string $user, string $password): \Codeception\Lib\Driver\MongoDb
     {
         return new MongoDb($dsn, $user, $password);
     }
 
     public function cleanup(): void
     {
-        $this->{$this->isLegacy ? 'cleanupMongo' : 'cleanupMongoDB'}();
+        $this->cleanupMongoDB();
     }
 
     /**
      * dump file has to be a javascript document where one can use all the mongo shell's commands
      * just FYI: this file can be easily created be RockMongo's export button
      *
-     * @param $dumpFile
+     * @param string $dumpFile
      */
-    public function load($dumpFile): void
+    public function load(string $dumpFile): void
     {
         $cmd = sprintf(
             'mongo %s %s%s',
@@ -187,7 +131,7 @@ public function load($dumpFile): void
         shell_exec($cmd);
     }
 
-    public function loadFromMongoDump($dumpFile): void
+    public function loadFromMongoDump(string $dumpFile): void
     {
         [$host, $port] = $this->getHostPort();
         $cmd = sprintf(
@@ -202,7 +146,7 @@ public function loadFromMongoDump($dumpFile): void
         shell_exec($cmd);
     }
 
-    public function loadFromTarGzMongoDump($dumpFile): void
+    public function loadFromTarGzMongoDump(string $dumpFile): void
     {
         [$host, $port] = $this->getHostPort();
         $getDirCmd = sprintf(
@@ -251,9 +195,9 @@ public function getDbh()
         return $this->dbh;
     }
 
-    public function setDatabase($dbName): void
+    public function setDatabase(string $dbName): void
     {
-        $this->dbh = $this->client->{$this->isLegacy ? 'selectDB' : 'selectDatabase'}($dbName);
+        $this->dbh = $this->client->selectDatabase($dbName);
     }
 
     public function getDbHash()
@@ -267,14 +211,6 @@ public function getDbHash()
         return $result[0]->md5 ?? null;
     }
 
-    /**
-     * Determine if this driver is using the legacy extension or not.
-     */
-    public function isLegacy(): bool
-    {
-        return $this->isLegacy;
-    }
-
     /**
      * @return string[]|int[]
      */
@@ -290,7 +226,7 @@ private function getHostPort(): array
         throw new ModuleException($this, '$dsn MUST be like (mongodb://)<host>:<port>/<db name>');
     }
 
-    public function setQuiet($quiet): void
+    public function setQuiet(bool $quiet): void
     {
         $this->quiet = $quiet ? '--quiet' : '';
     }

src/Codeception/Module/MongoDb.php

@@ -96,10 +96,11 @@ class MongoDb extends Module implements RequiresPackage
     protected $config = [
         'populate'  => true,
         'cleanup'   => true,
+        'dsn'       => '',
         'dump'      => null,
         'dump_type' => self::DUMP_TYPE_JS,
-        'user'      => null,
-        'password'  => null,
+        'user'      => '',
+        'password'  => '',
         'quiet'     => false,
     ];
 
@@ -120,7 +121,6 @@ class MongoDb extends Module implements RequiresPackage
 
     public function _initialize()
     {
-
         try {
             $this->driver = MongoDbDriver::create(
                 $this->config['dsn'],
@@ -280,37 +280,34 @@ protected function loadDump(): void
     /**
      * Specify the database to use
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->useDatabase('db_1');
      * ```
      *
-     * @param $dbName
+     * @param string $dbName
      */
-    public function useDatabase($dbName): void
+    public function useDatabase(string $dbName): void
     {
         $this->driver->setDatabase($dbName);
     }
 
     /**
      * Inserts data into collection
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->haveInCollection('users', ['name' => 'John', 'email' => 'john@coltrane.com']);
      * $user_id = $I->haveInCollection('users', ['email' => 'john@coltrane.com']);
      * ```
      *
-     * @param $collection
-     * @return mixed|string
+     * @param string $collection
+     * @param array $data
+     * @return string
      */
-    public function haveInCollection($collection, array $data)
+    public function haveInCollection(string $collection, array $data): string
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
-        if ($this->driver->isLegacy()) {
-            $collection->insert($data);
-            return $data['_id'];
-        }
 
         $response = $collection->insertOne($data);
         return (string) $response->getInsertedId();
@@ -319,14 +316,14 @@ public function haveInCollection($collection, array $data)
     /**
      * Checks if collection contains an item.
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->seeInCollection('users', ['name' => 'miles']);
      * ```
      *
-     * @param $collection
+     * @param string $collection
      */
-    public function seeInCollection($collection, array $criteria = []): void
+    public function seeInCollection(string $collection, array $criteria = []): void
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
         $res = $collection->count($criteria);
@@ -336,14 +333,14 @@ public function seeInCollection($collection, array $criteria = []): void
     /**
      * Checks if collection doesn't contain an item.
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->dontSeeInCollection('users', ['name' => 'miles']);
      * ```
      *
-     * @param $collection
+     * @param string $collection
      */
-    public function dontSeeInCollection($collection, array $criteria = []): void
+    public function dontSeeInCollection(string $collection, array $criteria = []): void
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
         $res = $collection->count($criteria);
@@ -353,15 +350,15 @@ public function dontSeeInCollection($collection, array $criteria = []): void
     /**
      * Grabs a data from collection
      *
-     * ``` php
+     * ```php
      * <?php
      * $user = $I->grabFromCollection('users', ['name' => 'miles']);
      * ```
      *
-     * @param $collection
+     * @param string $collection
      * @return \MongoDB\Model\BSONDocument|mixed
      */
-    public function grabFromCollection($collection, array $criteria = [])
+    public function grabFromCollection(string $collection, array $criteria = [])
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
         return $collection->findOne($criteria);
@@ -370,16 +367,16 @@ public function grabFromCollection($collection, array $criteria = [])
     /**
      * Grabs the documents count from a collection
      *
-     * ``` php
+     * ```php
      * <?php
      * $count = $I->grabCollectionCount('users');
      * // or
      * $count = $I->grabCollectionCount('users', ['isAdmin' => true]);
      * ```
      *
-     * @param $collection
+     * @param string $collection
      */
-    public function grabCollectionCount($collection, array $criteria = []): int
+    public function grabCollectionCount(string $collection, array $criteria = []): int
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
         return $collection->count($criteria);
@@ -388,7 +385,7 @@ public function grabCollectionCount($collection, array $criteria = []): int
     /**
      * Asserts that an element in a collection exists and is an Array
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->seeElementIsArray('users', ['name' => 'John Doe'], 'data.skills');
      * ```
@@ -417,7 +414,7 @@ public function seeElementIsArray(string $collection, array $criteria = [], stri
     /**
      * Asserts that an element in a collection exists and is an Object
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->seeElementIsObject('users', ['name' => 'John Doe'], 'data');
      * ```
@@ -446,15 +443,15 @@ public function seeElementIsObject(string $collection, array $criteria = [], str
     /**
      * Count number of records in a collection
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->seeNumElementsInCollection('users', 2);
      * $I->seeNumElementsInCollection('users', 1, ['name' => 'miles']);
      * ```
      *
-     * @param $collection
+     * @param string $collection
      */
-    public function seeNumElementsInCollection($collection, int $expected, array $criteria = []): void
+    public function seeNumElementsInCollection(string $collection, int $expected, array $criteria = []): void
     {
         $collection = $this->driver->getDbh()->selectCollection($collection);
         $res = $collection->count($criteria);