PHPC-1021: Remove support for ReadPreference integer modes #1666
Conversation
| @@ -526,16 +477,12 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, serialize) | ||
| } | ||
|
|
||
| tags = mongoc_read_prefs_get_tags(intern->read_preference); | ||
| mode = mongoc_read_prefs_get_mode(intern->read_preference); |
There was a problem hiding this comment.
Note: this will conflict with #1663, depending on which gets merged first.
| phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Invalid mode: '%s'", Z_STRVAL_P(mode)); | ||
| return; | ||
| } | ||
| if (zend_string_equals_literal_ci(mode, PHONGO_READ_PRIMARY)) { |
There was a problem hiding this comment.
I was delighted to find this in zend_string.h.
| @@ -153,9 +153,9 @@ static bool php_phongo_readpreference_init_from_hash(php_phongo_readpreference_t | ||
| return false; | ||
| } | ||
|
|
||
| static const char* php_phongo_readpreference_get_mode_string(mongoc_read_mode_t mode) | ||
| static const char* php_phongo_readpreference_get_mode_string(const mongoc_read_prefs_t* read_prefs) |
There was a problem hiding this comment.
This lets us eliminate some mongoc_read_prefs_get_mode() calls in parent contexts.
Additionally, I changed this function to return an empty string instead of throwing in the very unlikely event that the RP mode is invalid. _mongoc_read_mode_as_str() does the same, and libmongoc uses that for appending read preferences to command payloads. In our case, this is used for serialization and debugging, and the change allowed us to clean up the parent contexts.
| @@ -1,18 +0,0 @@ | ||
| --TEST-- | ||
| MongoDB\Driver\ReadPreference construction (invalid string mode) |
There was a problem hiding this comment.
This test was redundant as readpreference-ctor_error-001.phpt uses an invalid string value.
| require_once __DIR__ . '/../utils/basic.inc'; | ||
|
|
||
| echo throws(function() { | ||
| new MongoDB\Driver\ReadPreference(3.14); |
There was a problem hiding this comment.
Since we replaced string|int with string in the constructor signature, type coercion is now applied outside of strict mode and this would be implicitly cast to '3.14'. I didn't see any reason to use a different type (or declare strict types) just to assert a TypeError.
c617ef4 to
3db8799
Compare
This removes the deprecated integer constants, constructor support, and getMode(). Error-checking in php_phongo_readpreference_get_mode_string() has also been removed. ReadPreference only uses mongoc_read_prefs_new() internally, and we should not need to worry about libmongoc feeding us mongoc_read_prefs_t with an invalid mode.
cd321e0 to
2a8feb7
Compare
* v2.x: (22 commits) PHPC-2441: Remove deprecated Manager constructor options (#1719) PHPC-990: Strict type validation for boolean URI options (#1713) PHPC-2440: Remove deprecated Query constructor options (#1707) PHPC-2459: Remove support for float arg in UTCDateTime ctor (#1709) Remove obsolete test PHPC-2344 Remove SSLConnectionException (#1696) PHPC-2144 Throw a LogicException when getting info from unacknowledged write result (#1687) PHPC-2454: Remove --enable-system-ciphers configure option (#1681) PHPC-2348 Remove `WriteException` and move `getWriteResult` to `BulkWriteException` (#1685) PHPC-2417 Add UTCDateTimeInterface::toDateTimeImmutable() (#1684) PHPC-2309: Remove --with-openssl-dir configure option (#1676) PHPC-2444: Remove support for string arguments in UTCDateTime constructor (#1662) PHPC-2248: Remove Serializable implementations (#1663) Update version for 2.x branch (#1672) PHPC-1021: Remove support for ReadPreference integer modes (#1666) PHPC-2342: Remove --with-libbson and --with-libmongoc configure options (#1667) PHPC-2351: Remove CursorId class (#1664) PHPC-2140: Make tentative return types definitive (#1658) PHPC-2402: Remove range_preview constants (#1665) PHPC-2346: Remove deprecated BSON functions (#1653) ...
https://jira.mongodb.org/browse/PHPC-1021
This removes the deprecated integer constants, constructor support, and getMode().
Error-checking in php_phongo_readpreference_get_mode_string() has also been removed. ReadPreference only uses mongoc_read_prefs_new() internally, and we should not need to worry about libmongoc feeding us mongoc_read_prefs_t with an invalid mode.