PHPC-1489: Deprecate integer readPreference constants (#1604)

* PHPC-1489: Deprecate integer readPreference constants

* Add tests for creating ReadPreference with integer values

Author: alcaeus

src/MongoDB/ReadPreference.c

@@ -195,6 +195,8 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, __construct)
 	PHONGO_PARSE_PARAMETERS_END();
 
 	if (Z_TYPE_P(mode) == IS_LONG) {
+		php_error_docref(NULL, E_DEPRECATED, "Passing an integer mode to \"MongoDB\\Driver\\ReadPreference::__construct\" is deprecated and will be removed in a future release.");
+
 		switch (Z_LVAL_P(mode)) {
 			case MONGOC_READ_PRIMARY:
 			case MONGOC_READ_SECONDARY:

src/MongoDB/ReadPreference.stub.php

@@ -12,30 +12,35 @@ final class ReadPreference implements \MongoDB\BSON\Serializable, \Serializable
     /**
      * @var int
      * @cvalue MONGOC_READ_PRIMARY
+     * @deprecated
      */
     public const RP_PRIMARY = UNKNOWN;
 
     /**
      * @var int
      * @cvalue MONGOC_READ_PRIMARY_PREFERRED
+     * @deprecated
      */
     public const RP_PRIMARY_PREFERRED = UNKNOWN;
 
     /**
      * @var int
      * @cvalue MONGOC_READ_SECONDARY
+     * @deprecated
      */
     public const RP_SECONDARY = UNKNOWN;
 
     /**
      * @var int
      * @cvalue MONGOC_READ_SECONDARY_PREFERRED
+     * @deprecated
      */
     public const RP_SECONDARY_PREFERRED = UNKNOWN;
 
     /**
      * @var int
      * @cvalue MONGOC_READ_NEAREST
+     * @deprecated
      */
     public const RP_NEAREST = UNKNOWN;
 
@@ -92,6 +97,7 @@ final public function getHedge(): ?object {}
 
     final public function getMaxStalenessSeconds(): int {}
 
+    /** @deprecated */
     final public function getMode(): int {}
 
     final public function getModeString(): string {}

src/MongoDB/ReadPreference_arginfo.h

@@ -17,7 +17,7 @@ PHPC-1015: Initial DNS Seedlist test
 require_once __DIR__ . "/../utils/basic.inc";
 
 $m = create_test_manager("mongodb+srv://test1.test.build.10gen.cc/");
-$s = $m->selectServer( new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_NEAREST ) );
+$s = $m->selectServer( new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST ) );
 $servers = $m->getServers();
 
 foreach ( $servers as $server )

tests/connect/bug1015.phpt

@@ -5,11 +5,11 @@ MongoDB\Driver\Manager::__construct() with duplicate read preference option
 
 $manager = new MongoDB\Driver\Manager(null, ['readPreference' => 'primary', 'readpreference' => 'secondary']);
 
-echo $manager->getReadPreference()->getMode(), "\n";
+echo $manager->getReadPreference()->getModeString(), "\n";
 
 ?>
 ===DONE===
 <?php exit(0); ?>
 --EXPECT--
-2
+secondary
 ===DONE===

tests/manager/manager-ctor-duplicate-option-001.phpt

@@ -11,8 +11,8 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = create_test_manager();
 
-$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
-$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY);
+$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
+$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
 
 echo "Testing primary:\n";
 $command = new MongoDB\Driver\Command(['ping' => 1]);

tests/manager/manager-executeCommand-002.phpt

@@ -11,8 +11,8 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = create_test_manager();
 
-$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
-$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY);
+$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
+$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
 
 echo "Testing primary:\n";
 $command = new MongoDB\Driver\Command(['ping' => 1]);

tests/manager/manager-executeCommand-003.phpt

@@ -24,7 +24,7 @@ $manager = create_test_manager();
                 DATABASE_NAME,
                 $command,
                 [
-                    'readPreference' => new \MongoDB\Driver\ReadPreference(\MongoDB\Driver\ReadPreference::RP_SECONDARY),
+                    'readPreference' => new \MongoDB\Driver\ReadPreference(\MongoDB\Driver\ReadPreference::SECONDARY),
                     'readConcern' => new \MongoDB\Driver\ReadConcern(\MongoDB\Driver\ReadConcern::LOCAL),
                     'writeConcern' => new \MongoDB\Driver\WriteConcern(\MongoDB\Driver\WriteConcern::MAJORITY),
                 ]

tests/manager/manager-executeCommand-004.phpt

@@ -16,8 +16,8 @@ $bulk = new MongoDB\Driver\BulkWrite();
 $bulk->insert(['_id' => 1, 'x' => 2, 'y' => 3]);
 $manager->executeBulkWrite(NS, $bulk);
 
-$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
-$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY);
+$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
+$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
 
 echo "Testing primary:\n";
 $query = new MongoDB\Driver\Query(['x' => 3], ['projection' => ['y' => 1]]);

tests/manager/manager-executeQuery-003.phpt

@@ -16,8 +16,8 @@ $bulk = new MongoDB\Driver\BulkWrite();
 $bulk->insert(['_id' => 1, 'x' => 2, 'y' => 3]);
 $manager->executeBulkWrite(NS, $bulk);
 
-$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
-$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY);
+$primary   = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
+$secondary = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
 
 echo "Testing primary:\n";
 $query = new MongoDB\Driver\Query(['x' => 3], ['projection' => ['y' => 1]]);