PHPC-1021: Remove support for ReadPreference integer modes #1666
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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(const mongoc_read_prefs_t* read_prefs) | ||
| { | ||
| switch (mongoc_read_prefs_get_mode(read_prefs)) { | ||
| case MONGOC_READ_PRIMARY: | ||
| return PHONGO_READ_PRIMARY; | ||
| case MONGOC_READ_PRIMARY_PREFERRED: | ||
|
|
@@ -167,19 +167,15 @@ static const char* php_phongo_readpreference_get_mode_string(mongoc_read_mode_t | |
| case MONGOC_READ_NEAREST: | ||
| return PHONGO_READ_NEAREST; | ||
| default: | ||
| return ""; | ||
| } | ||
| } | ||
|
|
||
| /* Constructs a new ReadPreference */ | ||
| static PHP_METHOD(MongoDB_Driver_ReadPreference, __construct) | ||
| { | ||
| php_phongo_readpreference_t* intern; | ||
| zend_string* mode; | ||
| zval* tagSets = NULL; | ||
| zval* options = NULL; | ||
|
|
||
|
|
@@ -188,44 +184,24 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, __construct) | |
| /* Separate the tagSets zval, since we may end up modifying it in | ||
| * php_phongo_read_preference_prep_tagsets() below. */ | ||
| PHONGO_PARSE_PARAMETERS_START(1, 3) | ||
| Z_PARAM_STR(mode) | ||
| Z_PARAM_OPTIONAL | ||
| Z_PARAM_ARRAY_EX(tagSets, 1, 1) | ||
| Z_PARAM_ARRAY_OR_NULL(options) | ||
| PHONGO_PARSE_PARAMETERS_END(); | ||
|
|
||
| if (zend_string_equals_literal_ci(mode, PHONGO_READ_PRIMARY)) { | ||
|
There was a problem hiding this comment. I was delighted to find this in |
||
| intern->read_preference = mongoc_read_prefs_new(MONGOC_READ_PRIMARY); | ||
| } else if (zend_string_equals_literal_ci(mode, PHONGO_READ_PRIMARY_PREFERRED)) { | ||
| intern->read_preference = mongoc_read_prefs_new(MONGOC_READ_PRIMARY_PREFERRED); | ||
| } else if (zend_string_equals_literal_ci(mode, PHONGO_READ_SECONDARY)) { | ||
| intern->read_preference = mongoc_read_prefs_new(MONGOC_READ_SECONDARY); | ||
| } else if (zend_string_equals_literal_ci(mode, PHONGO_READ_SECONDARY_PREFERRED)) { | ||
| intern->read_preference = mongoc_read_prefs_new(MONGOC_READ_SECONDARY_PREFERRED); | ||
| } else if (zend_string_equals_literal_ci(mode, PHONGO_READ_NEAREST)) { | ||
| intern->read_preference = mongoc_read_prefs_new(MONGOC_READ_NEAREST); | ||
| } else { | ||
| phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Invalid mode: '%s'", ZSTR_VAL(mode)); | ||
| return; | ||
| } | ||
|
|
||
|
|
@@ -366,35 +342,16 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, getMaxStalenessSeconds) | |
| RETURN_LONG(mongoc_read_prefs_get_max_staleness_seconds(intern->read_preference)); | ||
| } | ||
|
|
||
| /* Returns the ReadPreference mode as string */ | ||
| static PHP_METHOD(MongoDB_Driver_ReadPreference, getModeString) | ||
| { | ||
| php_phongo_readpreference_t* intern; | ||
|
|
||
| intern = Z_READPREFERENCE_OBJ_P(getThis()); | ||
|
|
||
| PHONGO_PARSE_PARAMETERS_NONE(); | ||
|
|
||
| RETURN_STRING(php_phongo_readpreference_get_mode_string(intern->read_preference)); | ||
| } | ||
|
|
||
| /* Returns the ReadPreference tag sets */ | ||
|
|
@@ -429,10 +386,8 @@ static HashTable* php_phongo_readpreference_get_properties_hash(zend_object* obj | |
| { | ||
| php_phongo_readpreference_t* intern; | ||
| HashTable* props; | ||
| const bson_t* tags; | ||
| const bson_t* hedge; | ||
|
|
||
| intern = Z_OBJ_READPREFERENCE(object); | ||
|
|
||
|
|
@@ -442,15 +397,13 @@ static HashTable* php_phongo_readpreference_get_properties_hash(zend_object* obj | |
| return props; | ||
| } | ||
|
|
||
| tags = mongoc_read_prefs_get_tags(intern->read_preference); | ||
| hedge = mongoc_read_prefs_get_hedge(intern->read_preference); | ||
|
|
||
| { | ||
| zval z_mode; | ||
|
|
||
| ZVAL_STRING(&z_mode, php_phongo_readpreference_get_mode_string(intern->read_preference)); | ||
| zend_hash_str_update(props, "mode", sizeof("mode") - 1, &z_mode); | ||
| } | ||
|
|
||
|
|
@@ -510,12 +463,10 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, serialize) | |
| php_phongo_readpreference_t* intern; | ||
| zval retval; | ||
| php_serialize_data_t var_hash; | ||
| smart_str buf = { 0 }; | ||
| const bson_t* tags; | ||
| const bson_t* hedge; | ||
| int64_t maxStalenessSeconds; | ||
|
|
||
| intern = Z_READPREFERENCE_OBJ_P(getThis()); | ||
|
|
||
|
|
@@ -526,16 +477,12 @@ static PHP_METHOD(MongoDB_Driver_ReadPreference, serialize) | |
| } | ||
|
|
||
| tags = mongoc_read_prefs_get_tags(intern->read_preference); | ||
|
There was a problem hiding this comment. Note: this will conflict with #1663, depending on which gets merged first. |
||
| maxStalenessSeconds = mongoc_read_prefs_get_max_staleness_seconds(intern->read_preference); | ||
| hedge = mongoc_read_prefs_get_hedge(intern->read_preference); | ||
|
|
||
| array_init_size(&retval, 4); | ||
|
|
||
| ADD_ASSOC_STRING(&retval, "mode", php_phongo_readpreference_get_mode_string(intern->read_preference)); | ||
|
|
||
| if (!bson_empty0(tags)) { | ||
| php_phongo_bson_state state; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.