Skip to content

PHPLIB-454: Fix test failures when startAtOperationTime is unsupported #632

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

Merged
merged 5 commits into from
Jul 2, 2019
Merged

PHPLIB-454: Fix test failures when startAtOperationTime is unsupported #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c3e6dc3
Rename internal constant for startAtOperationTime support
jmikola Jul 2, 2019
db79201
PHPLIB-454: Skip startAtOperationTime test if unsupported
jmikola Jul 2, 2019
8e88c5c
PHPLIB-454: Remove test dependence on startAtOperationTime
jmikola Jul 2, 2019
224033e
Assert operationTime field exists before accessing it
jmikola Jul 2, 2019
8f1f3a3
Fix comment for wire version check
jmikola Jul 2, 2019
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
8 changes: 4 additions & 4 deletions src/Operation/Watch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
*/
class Watch implements Executable, /* @internal */ CommandSubscriber
{
private static $wireVersionForOperationTime = 7;
private static $wireVersionForStartAtOperationTime = 7;

const FULL_DOCUMENT_DEFAULT = 'default';
const FULL_DOCUMENT_UPDATE_LOOKUP = 'updateLookup';
Expand Down Expand Up @@ -267,9 +267,9 @@ private function createResumeCallable(Manager $manager)
private function executeAggregate(Server $server)
{
/* If we've already captured an operation time or the server does not
* support returning an operation time (e.g. MongoDB 3.6), execute the
* aggregation directly and return its cursor. */
if ($this->operationTime !== null || ! \MongoDB\server_supports_feature($server, self::$wireVersionForOperationTime)) {
* support resuming from an operation time (e.g. MongoDB 3.6), execute
* the aggregation directly and return its cursor. */
if ($this->operationTime !== null || ! \MongoDB\server_supports_feature($server, self::$wireVersionForStartAtOperationTime)) {
return $this->aggregate->execute($server);
}

Expand Down
60 changes: 41 additions & 19 deletions tests/Operation/WatchFunctionalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

class WatchFunctionalTest extends FunctionalTestCase
{
private static $wireVersionForStartAtOperationTime = 7;

private $defaultOptions = ['maxAwaitTimeMS' => 500];

public function setUp()
Expand Down Expand Up @@ -134,6 +136,8 @@ function(array $event) use (&$commands) {

public function testResumeBeforeReceivingAnyResultsIncludesStartAtOperationTime()
{
$this->skipIfStartAtOperationTimeNotSupported();

$operation = new Watch($this->manager, $this->getDatabaseName(), $this->getCollectionName(), [], $this->defaultOptions);

$operationTime = null;
Expand All @@ -150,7 +154,9 @@ function (array $event) use (&$events) {

$this->assertCount(1, $events);
$this->assertSame('aggregate', $events[0]['started']->getCommandName());
$operationTime = $events[0]['succeeded']->getReply()->operationTime;
$reply = $events[0]['succeeded']->getReply();
$this->assertObjectHasAttribute('operationTime', $reply);
$operationTime = $reply->operationTime;
$this->assertInstanceOf(TimestampInterface::class, $operationTime);

$this->assertNull($changeStream->current());
Expand Down Expand Up @@ -398,20 +404,29 @@ public function testResumeMultipleTimesInSuccession()

$this->insertDocument(['_id' => 1]);

/* Insert a document and advance the change stream to ensure we capture
* a resume token. This is necessary when startAtOperationTime is not
* supported (i.e. 3.6 server version). */
$changeStream->next();
$this->assertTrue($changeStream->valid());
$this->assertSame(0, $changeStream->key());

$this->insertDocument(['_id' => 2]);

/* Killing the cursor and advancing when there is a result will test
* that next()'s resume attempt picks up the latest change. */
$this->killChangeStreamCursor($changeStream);

$changeStream->next();
$this->assertTrue($changeStream->valid());
$this->assertSame(0, $changeStream->key());
$this->assertSame(1, $changeStream->key());

$expectedResult = [
'_id' => $changeStream->current()->_id,
'operationType' => 'insert',
'fullDocument' => ['_id' => 1],
'fullDocument' => ['_id' => 2],
'ns' => ['db' => $this->getDatabaseName(), 'coll' => $this->getCollectionName()],
'documentKey' => ['_id' => 1],
'documentKey' => ['_id' => 2],
];

$this->assertMatchesDocument($expectedResult, $changeStream->current());
Expand All @@ -424,48 +439,48 @@ public function testResumeMultipleTimesInSuccession()

$changeStream->rewind();
$this->assertTrue($changeStream->valid());
$this->assertSame(0, $changeStream->key());
$this->assertSame(1, $changeStream->key());

$expectedResult = [
'_id' => $changeStream->current()->_id,
'operationType' => 'insert',
'fullDocument' => ['_id' => 1],
'fullDocument' => ['_id' => 2],
'ns' => ['db' => $this->getDatabaseName(), 'coll' => $this->getCollectionName()],
'documentKey' => ['_id' => 1],
'documentKey' => ['_id' => 2],
];

$this->assertMatchesDocument($expectedResult, $changeStream->current());

$this->insertDocument(['_id' => 2]);
$this->insertDocument(['_id' => 3]);

$changeStream->next();
$this->assertTrue($changeStream->valid());
$this->assertSame(1, $changeStream->key());
$this->assertSame(2, $changeStream->key());

$expectedResult = [
'_id' => $changeStream->current()->_id,
'operationType' => 'insert',
'fullDocument' => ['_id' => 2],
'fullDocument' => ['_id' => 3],
'ns' => ['db' => $this->getDatabaseName(), 'coll' => $this->getCollectionName()],
'documentKey' => ['_id' => 2],
'documentKey' => ['_id' => 3],
];

$this->assertMatchesDocument($expectedResult, $changeStream->current());

$this->killChangeStreamCursor($changeStream);

$this->insertDocument(['_id' => 3]);
$this->insertDocument(['_id' => 4]);

$changeStream->next();
$this->assertTrue($changeStream->valid());
$this->assertSame(2, $changeStream->key());
$this->assertSame(3, $changeStream->key());

$expectedResult = [
'_id' => $changeStream->current()->_id,
'operationType' => 'insert',
'fullDocument' => ['_id' => 3],
'fullDocument' => ['_id' => 4],
'ns' => ['db' => $this->getDatabaseName(), 'coll' => $this->getCollectionName()],
'documentKey' => ['_id' => 3],
'documentKey' => ['_id' => 4],
];

$this->assertMatchesDocument($expectedResult, $changeStream->current());
Expand All @@ -476,18 +491,18 @@ public function testResumeMultipleTimesInSuccession()
* we'll see {_id: 3} returned again. */
$this->killChangeStreamCursor($changeStream);

$this->insertDocument(['_id' => 4]);
$this->insertDocument(['_id' => 5]);

$changeStream->next();
$this->assertTrue($changeStream->valid());
$this->assertSame(3, $changeStream->key());
$this->assertSame(4, $changeStream->key());

$expectedResult = [
'_id' => $changeStream->current()->_id,
'operationType' => 'insert',
'fullDocument' => ['_id' => 4],
'fullDocument' => ['_id' => 5],
'ns' => ['db' => $this->getDatabaseName(), 'coll' => $this->getCollectionName()],
'documentKey' => ['_id' => 4],
'documentKey' => ['_id' => 5],
];

$this->assertMatchesDocument($expectedResult, $changeStream->current());
Expand Down Expand Up @@ -944,4 +959,11 @@ private function killChangeStreamCursor(ChangeStream $changeStream)
$operation = new DatabaseCommand($this->getDatabaseName(), $command);
$operation->execute($this->getPrimaryServer());
}

private function skipIfStartAtOperationTimeNotSupported()
{
if (!\MongoDB\server_supports_feature($this->getPrimaryServer(), self::$wireVersionForStartAtOperationTime)) {
$this->markTestSkipped('Operation time is not supported');
}
}
}