Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extract connection options from query string #116

Merged
merged 2 commits into from
Jun 22, 2016
Merged

Extract connection options from query string #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
490d620
Extract connection options from query string
alcaeus Jun 16, 2016
643efd9
Add changelog entry
alcaeus Jun 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG-1.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ CHANGELOG

This changelog references the relevant changes done in minor version updates.

1.0.4 (xxxx-xx-xx)
1.0.4 (2016-06-22)
------------------

All issues and pull requests under this release may be found under the
Expand All @@ -13,6 +13,9 @@ milestone.
* [#115](https://github.com/alcaeus/mongo-php-adapter/pull/115) fixes an error
where using the alternate syntax for `MongoCollection::aggregate` would lead to
empty aggregation pipelines
* [#116](https://github.com/alcaeus/mongo-php-adapter/pull/116) fixes a bug
where read preference and write concern was not applied if it was passed in the
constructor.

1.0.3 (2016-04-13)
------------------
Expand Down
87 changes: 86 additions & 1 deletion lib/Mongo/MongoClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ public function __construct($server = 'default', array $options = ['connect' =>
$server = 'mongodb://' . self::DEFAULT_HOST . ':' . self::DEFAULT_PORT;
}

$this->applyConnectionOptions($server, $options);

$this->server = $server;
if (false === strpos($this->server, 'mongodb://')) {
$this->server = 'mongodb://'.$this->server;
Expand Down Expand Up @@ -348,5 +350,88 @@ function __sleep()
'connected', 'status', 'server', 'persistent'
];
}
}

/**
* @param $server
* @return array
*/
private function extractUrlOptions($server)
{
$queryOptions = explode('&', parse_url($server, PHP_URL_QUERY));

$options = [];
foreach ($queryOptions as $option) {
if (strpos($option, '=') === false) {
continue;
}

$keyValue = explode('=', $option);
if ($keyValue[0] === 'readPreferenceTags') {
$options[$keyValue[0]][] = $this->getReadPreferenceTags($keyValue[1]);
} else {
$options[$keyValue[0]] = $keyValue[1];
}
}

return $options;
}

/**
* @param $readPreferenceTagString
* @return array
*/
private function getReadPreferenceTags($readPreferenceTagString)
{
$tagSets = [];
foreach (explode(',', $readPreferenceTagString) as $index => $tagSet) {
$tags = explode(':', $tagSet);
$tagSets[$tags[0]] = $tags[1];
}

return $tagSets;
}

/**
* @param string $server
* @param array $options
*/
private function applyConnectionOptions($server, array $options)
{
$urlOptions = $this->extractUrlOptions($server);

if (isset($urlOptions['wTimeout'])) {
$urlOptions['wTimeoutMS'] = $urlOptions['wTimeout'];
unset($urlOptions['wTimeout']);
}

if (isset($options['wTimeout'])) {
$options['wTimeoutMS'] = $options['wTimeout'];
unset($options['wTimeout']);
}

if (isset($options['readPreferenceTags'])) {
$options['readPreferenceTags'] = [$this->getReadPreferenceTags($options['readPreferenceTags'])];

// Special handling for readPreferenceTags which are merged
if (isset($urlOptions['readPreferenceTags'])) {
$options['readPreferenceTags'] = array_merge($urlOptions['readPreferenceTags'], $options['readPreferenceTags']);
}
}

$urlOptions = array_merge($urlOptions, $options);

if (isset($urlOptions['slaveOkay'])) {
$this->setReadPreferenceFromSlaveOkay($urlOptions['slaveOkay']);
} elseif (isset($urlOptions['readPreference']) || isset($urlOptions['readPreferenceTags'])) {
$readPreference = isset($urlOptions['readPreference']) ? $urlOptions['readPreference'] : null;
$tags = isset($urlOptions['readPreferenceTags']) ? $urlOptions['readPreferenceTags'] : null;
$this->setReadPreferenceFromParameters($readPreference, $tags);
}

if (isset($urlOptions['w']) || isset($urlOptions['wTimeoutMs'])) {
$writeConcern = (isset($urlOptions['w'])) ? $urlOptions['w'] : 1;
$wTimeout = (isset($urlOptions['wTimeoutMs'])) ? $urlOptions['wTimeoutMs'] : null;
$this->setWriteConcern($writeConcern, $wTimeout);
}
}
}
122 changes: 122 additions & 0 deletions tests/Alcaeus/MongoDbAdapter/Mongo/MongoClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,126 @@ public function testNoPrefixUri()
$client = $this->getClient(null, 'localhost');
$this->assertNotNull($client);
}

/**
* @dataProvider dataReadPreferenceOptionsAreInherited
*/
public function testReadPreferenceOptionsAreInherited($options, $uri, $expectedTagsets)
{
$client = $this->getClient($options, $uri);
$collection = $client->selectCollection('test', 'foo');

$this->assertSame(
[
'type' => \MongoClient::RP_SECONDARY_PREFERRED,
'tagsets' => $expectedTagsets
],
$collection->getReadPreference()
);
}

public static function dataReadPreferenceOptionsAreInherited()
{
$options = [
'readPreference' => \MongoClient::RP_SECONDARY_PREFERRED,
'readPreferenceTags' => 'a:b',
];

$overriddenOptions = [
'readPreference' => \MongoClient::RP_NEAREST,
'readPreferenceTags' => 'c:d',
];

$multipleTagsets = [
'readPreference' => \MongoClient::RP_SECONDARY_PREFERRED,
'readPreferenceTags' => 'a:b,c:d',
];

return [
'optionsArray' => [
'options' => $options,
'uri' => 'mongodb://localhost',
'expectedTagsets' => [['a' => 'b']],
],
'queryString' => [
'options' => [],
'uri' => 'mongodb://localhost/?' . self::makeOptionString($options),
'expectedTagsets' => [['a' => 'b']],
],
'multipleInQueryString' => [
'options' => [],
'uri' => 'mongodb://localhost/?' . self::makeOptionString($options) . '&readPreferenceTags=c:d',
'expectedTagsets' => [['a' => 'b'], ['c' => 'd']],
],
'overridden' => [
'options' => $options,
'uri' => 'mongodb://localhost/?' . self::makeOptionString($overriddenOptions),
'expectedTagsets' => [['c' => 'd'], ['a' => 'b']],
],
'multipleTagsetsOptions' => [
'options' => $multipleTagsets,
'uri' => 'mongodb://localhost',
'expectedTagsets' => [['a' => 'b', 'c' => 'd']],
],
'multipleTagsetsQueryString' => [
'options' => null,
'uri' => 'mongodb://localhost/?' . self::makeOptionString($multipleTagsets),
'expectedTagsets' => [['a' => 'b', 'c' => 'd']],
],
];
}

/**
* @dataProvider dataWriteConcernOptionsAreInherited
*/
public function testWriteConcernOptionsAreInherited($options, $uri)
{
$client = $this->getClient($options, $uri);
$collection = $client->selectCollection('test', 'foo');

$this->assertSame(['w' => 'majority', 'wtimeout' => 666], $collection->getWriteConcern());
}

public static function dataWriteConcernOptionsAreInherited()
{
$options = [
'w' => 'majority',
'wTimeoutMs' => 666,
];

$overriddenOptions = [
'w' => '2',
'wTimeoutMs' => 333,
];

return [
'optionsArray' => [
'options' => $options,
'uri' => 'mongodb://localhost',
],
'queryString' => [
'options' => [],
'uri' => 'mongodb://localhost/?' . self::makeOptionString($options),
],
'overridden' => [
'options' => $options,
'uri' => 'mongodb://localhost/?' . self::makeOptionString($overriddenOptions),
]
];
}

/**
* @param array $options
* @return string
*/
private static function makeOptionString(array $options)
{
return implode('&', array_map(
function ($key, $value) {
return $key . '=' . $value;
},
array_keys($options),
array_values($options)
));
}
}