Skip to content

Commit 7b463d7

Browse files
GromNaNGromNaN
authored
PHPLIB-475: Use ReadPreference string constant consistently in the code and the doc (#1082)
* ReadPreference::RP_* constants are deprecated in favor of the string constants * Use ReadPreference::getModeString to compare with string constants * Use $manager->selectServer() default primary
1 parent f6551ed commit 7b463d7

19 files changed

+59
-62
lines changed

‎src/Collection.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -968,7 +968,7 @@ public function mapReduce(JavascriptInterface $map, JavascriptInterface $reduce,
968968

969969
// Check if the out option is inline because we will want to coerce a primary read preference if not
970970
if ($hasOutputCollection) {
971-
$options['readPreference'] = new ReadPreference(ReadPreference::RP_PRIMARY);
971+
$options['readPreference'] = new ReadPreference(ReadPreference::PRIMARY);
972972
}
973973

974974
$server = select_server($this->manager, $options);

‎src/GridFS/CollectionWrapper.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ private function indexKeysMatch(array $expectedKeys, array $actualKeys): bool
359359
private function isFilesCollectionEmpty(): bool
360360
{
361361
return null === $this->filesCollection->findOne([], [
362-
'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
362+
'readPreference' => new ReadPreference(ReadPreference::PRIMARY),
363363
'projection' => ['_id' => 1],
364364
'typeMap' => [],
365365
]);

‎src/Operation/Watch.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ public function __construct(Manager $manager, ?string $databaseName, ?string $co
208208
}
209209

210210
$options += [
211-
'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
211+
'readPreference' => new ReadPreference(ReadPreference::PRIMARY),
212212
];
213213

214214
if (array_key_exists('fullDocument', $options) && ! is_string($options['fullDocument'])) {

‎src/functions.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ function select_server(Manager $manager, array $options): Server
558558
$readPreference = extract_read_preference_from_options($options);
559559
if (! $readPreference instanceof ReadPreference) {
560560
// TODO: PHPLIB-476: Read transaction read preference once PHPC-1439 is implemented
561-
$readPreference = new ReadPreference(ReadPreference::RP_PRIMARY);
561+
$readPreference = new ReadPreference(ReadPreference::PRIMARY);
562562
}
563563

564564
return $manager->selectServer($readPreference);
@@ -578,7 +578,7 @@ function select_server_for_aggregate_write_stage(Manager $manager, array &$optio
578578

579579
/* If there is either no read preference or a primary read preference, there
580580
* is no special server selection logic to apply. */
581-
if ($readPreference === null || $readPreference->getMode() === ReadPreference::RP_PRIMARY) {
581+
if ($readPreference === null || $readPreference->getModeString() === ReadPreference::PRIMARY) {
582582
return select_server($manager, $options);
583583
}
584584

@@ -594,7 +594,7 @@ function select_server_for_aggregate_write_stage(Manager $manager, array &$optio
594594
* preference and repeat server selection if it previously failed or
595595
* selected a secondary. */
596596
if (! all_servers_support_write_stage_on_secondary($manager->getServers())) {
597-
$options['readPreference'] = new ReadPreference(ReadPreference::RP_PRIMARY);
597+
$options['readPreference'] = new ReadPreference(ReadPreference::PRIMARY);
598598

599599
if ($server === null || $server->isSecondary()) {
600600
return select_server($manager, $options);

‎tests/ClientTest.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public function testSelectCollectionInheritsOptions(): void
9595
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
9696
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
9797
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
98-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
98+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
9999
$this->assertIsArray($debug['typeMap']);
100100
$this->assertSame(['root' => 'array'], $debug['typeMap']);
101101
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -106,7 +106,7 @@ public function testSelectCollectionPassesOptions(): void
106106
{
107107
$collectionOptions = [
108108
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
109-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
109+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
110110
'typeMap' => ['root' => 'array'],
111111
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
112112
];
@@ -118,7 +118,7 @@ public function testSelectCollectionPassesOptions(): void
118118
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
119119
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
120120
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
121-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
121+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
122122
$this->assertIsArray($debug['typeMap']);
123123
$this->assertSame(['root' => 'array'], $debug['typeMap']);
124124
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -142,7 +142,7 @@ public function testSelectDatabaseInheritsOptions(): void
142142
{
143143
$uriOptions = [
144144
'readConcernLevel' => ReadConcern::LOCAL,
145-
'readPreference' => 'secondaryPreferred',
145+
'readPreference' => ReadPreference::SECONDARY_PREFERRED,
146146
'w' => WriteConcern::MAJORITY,
147147
];
148148

@@ -157,7 +157,7 @@ public function testSelectDatabaseInheritsOptions(): void
157157
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
158158
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
159159
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
160-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
160+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
161161
$this->assertIsArray($debug['typeMap']);
162162
$this->assertSame(['root' => 'array'], $debug['typeMap']);
163163
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -168,7 +168,7 @@ public function testSelectDatabasePassesOptions(): void
168168
{
169169
$databaseOptions = [
170170
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
171-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
171+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
172172
'typeMap' => ['root' => 'array'],
173173
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
174174
];
@@ -180,7 +180,7 @@ public function testSelectDatabasePassesOptions(): void
180180
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
181181
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
182182
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
183-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
183+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
184184
$this->assertIsArray($debug['typeMap']);
185185
$this->assertSame(['root' => 'array'], $debug['typeMap']);
186186
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);

‎tests/Collection/CollectionFunctionalTest.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ public function testWithOptionsInheritsOptions(): void
371371
{
372372
$collectionOptions = [
373373
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
374-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
374+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
375375
'typeMap' => ['root' => 'array'],
376376
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
377377
];
@@ -386,7 +386,7 @@ public function testWithOptionsInheritsOptions(): void
386386
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
387387
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
388388
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
389-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
389+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
390390
$this->assertIsArray($debug['typeMap']);
391391
$this->assertSame(['root' => 'array'], $debug['typeMap']);
392392
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -397,7 +397,7 @@ public function testWithOptionsPassesOptions(): void
397397
{
398398
$collectionOptions = [
399399
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
400-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
400+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
401401
'typeMap' => ['root' => 'array'],
402402
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
403403
];
@@ -408,7 +408,7 @@ public function testWithOptionsPassesOptions(): void
408408
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
409409
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
410410
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
411-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
411+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
412412
$this->assertIsArray($debug['typeMap']);
413413
$this->assertSame(['root' => 'array'], $debug['typeMap']);
414414
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);

‎tests/Database/DatabaseFunctionalTest.php‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public function testCommand(): void
8686
{
8787
$command = ['ping' => 1];
8888
$options = [
89-
'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
89+
'readPreference' => new ReadPreference(ReadPreference::PRIMARY),
9090
];
9191

9292
$cursor = $this->database->command($command, $options);
@@ -105,7 +105,7 @@ public function testCommandDoesNotInheritReadPreference(): void
105105
$this->markTestSkipped('Test only applies to replica sets');
106106
}
107107

108-
$this->database = new Database($this->manager, $this->getDatabaseName(), ['readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY)]);
108+
$this->database = new Database($this->manager, $this->getDatabaseName(), ['readPreference' => new ReadPreference(ReadPreference::SECONDARY)]);
109109

110110
$command = ['ping' => 1];
111111

@@ -119,7 +119,7 @@ public function testCommandAppliesTypeMapToCursor(): void
119119
{
120120
$command = ['ping' => 1];
121121
$options = [
122-
'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
122+
'readPreference' => new ReadPreference(ReadPreference::PRIMARY),
123123
'typeMap' => ['root' => 'array'],
124124
];
125125

@@ -286,7 +286,7 @@ public function testSelectCollectionInheritsOptions(): void
286286
{
287287
$databaseOptions = [
288288
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
289-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
289+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
290290
'typeMap' => ['root' => 'array'],
291291
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
292292
];
@@ -301,7 +301,7 @@ public function testSelectCollectionInheritsOptions(): void
301301
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
302302
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
303303
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
304-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
304+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
305305
$this->assertIsArray($debug['typeMap']);
306306
$this->assertSame(['root' => 'array'], $debug['typeMap']);
307307
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -312,7 +312,7 @@ public function testSelectCollectionPassesOptions(): void
312312
{
313313
$collectionOptions = [
314314
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
315-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
315+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
316316
'typeMap' => ['root' => 'array'],
317317
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
318318
];
@@ -323,7 +323,7 @@ public function testSelectCollectionPassesOptions(): void
323323
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
324324
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
325325
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
326-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
326+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
327327
$this->assertIsArray($debug['typeMap']);
328328
$this->assertSame(['root' => 'array'], $debug['typeMap']);
329329
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -334,7 +334,7 @@ public function testSelectGridFSBucketInheritsOptions(): void
334334
{
335335
$databaseOptions = [
336336
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
337-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
337+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
338338
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
339339
];
340340

@@ -349,7 +349,7 @@ public function testSelectGridFSBucketInheritsOptions(): void
349349
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
350350
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
351351
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
352-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
352+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
353353
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
354354
$this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
355355
}
@@ -360,7 +360,7 @@ public function testSelectGridFSBucketPassesOptions(): void
360360
'bucketName' => 'custom_fs',
361361
'chunkSizeBytes' => 8192,
362362
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
363-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
363+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
364364
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
365365
];
366366

@@ -374,7 +374,7 @@ public function testSelectGridFSBucketPassesOptions(): void
374374
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
375375
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
376376
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
377-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
377+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
378378
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
379379
$this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
380380
}
@@ -383,7 +383,7 @@ public function testWithOptionsInheritsOptions(): void
383383
{
384384
$databaseOptions = [
385385
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
386-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
386+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
387387
'typeMap' => ['root' => 'array'],
388388
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
389389
];
@@ -397,7 +397,7 @@ public function testWithOptionsInheritsOptions(): void
397397
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
398398
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
399399
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
400-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
400+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
401401
$this->assertIsArray($debug['typeMap']);
402402
$this->assertSame(['root' => 'array'], $debug['typeMap']);
403403
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);
@@ -408,7 +408,7 @@ public function testWithOptionsPassesOptions(): void
408408
{
409409
$databaseOptions = [
410410
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
411-
'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
411+
'readPreference' => new ReadPreference(ReadPreference::SECONDARY_PREFERRED),
412412
'typeMap' => ['root' => 'array'],
413413
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
414414
];
@@ -419,7 +419,7 @@ public function testWithOptionsPassesOptions(): void
419419
$this->assertInstanceOf(ReadConcern::class, $debug['readConcern']);
420420
$this->assertSame(ReadConcern::LOCAL, $debug['readConcern']->getLevel());
421421
$this->assertInstanceOf(ReadPreference::class, $debug['readPreference']);
422-
$this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
422+
$this->assertSame(ReadPreference::SECONDARY_PREFERRED, $debug['readPreference']->getModeString());
423423
$this->assertIsArray($debug['typeMap']);
424424
$this->assertSame(['root' => 'array'], $debug['typeMap']);
425425
$this->assertInstanceOf(WriteConcern::class, $debug['writeConcern']);

0 commit comments

Comments
 (0)