[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401]

   1  <?php
   2  /*
   3   * Copyright 2017 MongoDB, Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License");
   6   * you may not use this file except in compliance with the License.
   7   * You may obtain a copy of the License at
   8   *
   9   *   http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS,
  13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   * See the License for the specific language governing permissions and
  15   * limitations under the License.
  16   */
  17  
  18  namespace MongoDB\Operation;
  19  
  20  use MongoDB\BSON\TimestampInterface;
  21  use MongoDB\ChangeStream;
  22  use MongoDB\Driver\Cursor;
  23  use MongoDB\Driver\Exception\RuntimeException;
  24  use MongoDB\Driver\Manager;
  25  use MongoDB\Driver\Monitoring\CommandFailedEvent;
  26  use MongoDB\Driver\Monitoring\CommandStartedEvent;
  27  use MongoDB\Driver\Monitoring\CommandSubscriber;
  28  use MongoDB\Driver\Monitoring\CommandSucceededEvent;
  29  use MongoDB\Driver\ReadPreference;
  30  use MongoDB\Driver\Server;
  31  use MongoDB\Exception\InvalidArgumentException;
  32  use MongoDB\Exception\UnexpectedValueException;
  33  use MongoDB\Exception\UnsupportedException;
  34  use MongoDB\Model\ChangeStreamIterator;
  35  use function array_intersect_key;
  36  use function array_unshift;
  37  use function count;
  38  use function is_array;
  39  use function is_object;
  40  use function is_string;
  41  use function MongoDB\Driver\Monitoring\addSubscriber;
  42  use function MongoDB\Driver\Monitoring\removeSubscriber;
  43  use function MongoDB\select_server;
  44  use function MongoDB\server_supports_feature;
  45  
  46  /**
  47   * Operation for creating a change stream with the aggregate command.
  48   *
  49   * Note: the implementation of CommandSubscriber is an internal implementation
  50   * detail and should not be considered part of the public API.
  51   *
  52   * @api
  53   * @see \MongoDB\Collection::watch()
  54   * @see https://docs.mongodb.com/manual/changeStreams/
  55   */
  56  class Watch implements Executable, /* @internal */ CommandSubscriber
  57  {
  58      const FULL_DOCUMENT_DEFAULT = 'default';
  59      const FULL_DOCUMENT_UPDATE_LOOKUP = 'updateLookup';
  60  
  61      /** @var integer */
  62      private static $wireVersionForStartAtOperationTime = 7;
  63  
  64      /** @var Aggregate */
  65      private $aggregate;
  66  
  67      /** @var array */
  68      private $aggregateOptions;
  69  
  70      /** @var array */
  71      private $changeStreamOptions;
  72  
  73      /** @var string|null */
  74      private $collectionName;
  75  
  76      /** @var string */
  77      private $databaseName;
  78  
  79      /** @var integer|null */
  80      private $firstBatchSize;
  81  
  82      /** @var boolean */
  83      private $hasResumed = false;
  84  
  85      /** @var Manager */
  86      private $manager;
  87  
  88      /** @var TimestampInterface */
  89      private $operationTime;
  90  
  91      /** @var array */
  92      private $pipeline;
  93  
  94      /** @var object|null */
  95      private $postBatchResumeToken;
  96  
  97      /**
  98       * Constructs an aggregate command for creating a change stream.
  99       *
 100       * Supported options:
 101       *
 102       *  * batchSize (integer): The number of documents to return per batch.
 103       *
 104       *  * collation (document): Specifies a collation.
 105       *
 106       *  * fullDocument (string): Determines whether the "fullDocument" field
 107       *    will be populated for update operations. By default, change streams
 108       *    only return the delta of fields during the update operation (via the
 109       *    "updateDescription" field). To additionally return the most current
 110       *    majority-committed version of the updated document, specify
 111       *    "updateLookup" for this option. Defaults to "default".
 112       *
 113       *    Insert and replace operations always include the "fullDocument" field
 114       *    and delete operations omit the field as the document no longer exists.
 115       *
 116       *  * maxAwaitTimeMS (integer): The maximum amount of time for the server to
 117       *    wait on new documents to satisfy a change stream query.
 118       *
 119       *  * readConcern (MongoDB\Driver\ReadConcern): Read concern.
 120       *
 121       *  * readPreference (MongoDB\Driver\ReadPreference): Read preference. This
 122       *    will be used to select a new server when resuming. Defaults to a
 123       *    "primary" read preference.
 124       *
 125       *  * resumeAfter (document): Specifies the logical starting point for the
 126       *    new change stream.
 127       *
 128       *    Using this option in conjunction with "startAfter" and/or
 129       *    "startAtOperationTime" will result in a server error. The options are
 130       *    mutually exclusive.
 131       *
 132       *  * session (MongoDB\Driver\Session): Client session.
 133       *
 134       *    Sessions are not supported for server versions < 3.6.
 135       *
 136       *  * startAfter (document): Specifies the logical starting point for the
 137       *    new change stream. Unlike "resumeAfter", this option can be used with
 138       *    a resume token from an "invalidate" event.
 139       *
 140       *    Using this option in conjunction with "resumeAfter" and/or
 141       *    "startAtOperationTime" will result in a server error. The options are
 142       *    mutually exclusive.
 143       *
 144       *  * startAtOperationTime (MongoDB\BSON\TimestampInterface): If specified,
 145       *    the change stream will only provide changes that occurred at or after
 146       *    the specified timestamp. Any command run against the server will
 147       *    return an operation time that can be used here. Alternatively, an
 148       *    operation time may be obtained from MongoDB\Driver\Server::getInfo().
 149       *
 150       *    Using this option in conjunction with "resumeAfter" and/or
 151       *    "startAfter" will result in a server error. The options are mutually
 152       *    exclusive.
 153       *
 154       *    This option is not supported for server versions < 4.0.
 155       *
 156       *  * typeMap (array): Type map for BSON deserialization. This will be
 157       *    applied to the returned Cursor (it is not sent to the server).
 158       *
 159       * Note: A database-level change stream may be created by specifying null
 160       * for the collection name. A cluster-level change stream may be created by
 161       * specifying null for both the database and collection name.
 162       *
 163       * @param Manager     $manager        Manager instance from the driver
 164       * @param string|null $databaseName   Database name
 165       * @param string|null $collectionName Collection name
 166       * @param array       $pipeline       List of pipeline operations
 167       * @param array       $options        Command options
 168       * @throws InvalidArgumentException for parameter/option parsing errors
 169       */
 170      public function __construct(Manager $manager, $databaseName, $collectionName, array $pipeline, array $options = [])
 171      {
 172          if (isset($collectionName) && ! isset($databaseName)) {
 173              throw new InvalidArgumentException('$collectionName should also be null if $databaseName is null');
 174          }
 175  
 176          $options += [
 177              'fullDocument' => self::FULL_DOCUMENT_DEFAULT,
 178              'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
 179          ];
 180  
 181          if (isset($options['fullDocument']) && ! is_string($options['fullDocument'])) {
 182              throw InvalidArgumentException::invalidType('"fullDocument" option', $options['fullDocument'], 'string');
 183          }
 184  
 185          if (isset($options['resumeAfter']) && ! is_array($options['resumeAfter']) && ! is_object($options['resumeAfter'])) {
 186              throw InvalidArgumentException::invalidType('"resumeAfter" option', $options['resumeAfter'], 'array or object');
 187          }
 188  
 189          if (isset($options['startAfter']) && ! is_array($options['startAfter']) && ! is_object($options['startAfter'])) {
 190              throw InvalidArgumentException::invalidType('"startAfter" option', $options['startAfter'], 'array or object');
 191          }
 192  
 193          if (isset($options['startAtOperationTime']) && ! $options['startAtOperationTime'] instanceof TimestampInterface) {
 194              throw InvalidArgumentException::invalidType('"startAtOperationTime" option', $options['startAtOperationTime'], TimestampInterface::class);
 195          }
 196  
 197          /* In the absence of an explicit session, create one to ensure that the
 198           * initial aggregation and any resume attempts can use the same session
 199           * ("implicit from the user's perspective" per PHPLIB-342). Since this
 200           * is filling in for an implicit session, we default "causalConsistency"
 201           * to false. */
 202          if (! isset($options['session'])) {
 203              try {
 204                  $options['session'] = $manager->startSession(['causalConsistency' => false]);
 205              } catch (RuntimeException $e) {
 206                  /* We can ignore the exception, as libmongoc likely cannot
 207                   * create its own session and there is no risk of a mismatch. */
 208              }
 209          }
 210  
 211          $this->aggregateOptions = array_intersect_key($options, ['batchSize' => 1, 'collation' => 1, 'maxAwaitTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1, 'typeMap' => 1]);
 212          $this->changeStreamOptions = array_intersect_key($options, ['fullDocument' => 1, 'resumeAfter' => 1, 'startAfter' => 1, 'startAtOperationTime' => 1]);
 213  
 214          // Null database name implies a cluster-wide change stream
 215          if ($databaseName === null) {
 216              $databaseName = 'admin';
 217              $this->changeStreamOptions['allChangesForCluster'] = true;
 218          }
 219  
 220          $this->manager = $manager;
 221          $this->databaseName = (string) $databaseName;
 222          $this->collectionName = isset($collectionName) ? (string) $collectionName : null;
 223          $this->pipeline = $pipeline;
 224  
 225          $this->aggregate = $this->createAggregate();
 226      }
 227  
 228      /** @internal */
 229      final public function commandFailed(CommandFailedEvent $event)
 230      {
 231      }
 232  
 233      /** @internal */
 234      final public function commandStarted(CommandStartedEvent $event)
 235      {
 236          if ($event->getCommandName() !== 'aggregate') {
 237              return;
 238          }
 239  
 240          $this->firstBatchSize = null;
 241          $this->postBatchResumeToken = null;
 242      }
 243  
 244      /** @internal */
 245      final public function commandSucceeded(CommandSucceededEvent $event)
 246      {
 247          if ($event->getCommandName() !== 'aggregate') {
 248              return;
 249          }
 250  
 251          $reply = $event->getReply();
 252  
 253          if (! isset($reply->cursor->firstBatch) || ! is_array($reply->cursor->firstBatch)) {
 254              throw new UnexpectedValueException('aggregate command did not return a "cursor.firstBatch" array');
 255          }
 256  
 257          $this->firstBatchSize = count($reply->cursor->firstBatch);
 258  
 259          if (isset($reply->cursor->postBatchResumeToken) && is_object($reply->cursor->postBatchResumeToken)) {
 260              $this->postBatchResumeToken = $reply->cursor->postBatchResumeToken;
 261          }
 262  
 263          if ($this->shouldCaptureOperationTime($event->getServer()) &&
 264              isset($reply->operationTime) && $reply->operationTime instanceof TimestampInterface) {
 265              $this->operationTime = $reply->operationTime;
 266          }
 267      }
 268  
 269      /**
 270       * Execute the operation.
 271       *
 272       * @see Executable::execute()
 273       * @param Server $server
 274       * @return ChangeStream
 275       * @throws UnsupportedException if collation or read concern is used and unsupported
 276       * @throws RuntimeException for other driver errors (e.g. connection errors)
 277       */
 278      public function execute(Server $server)
 279      {
 280          return new ChangeStream(
 281              $this->createChangeStreamIterator($server),
 282              function ($resumeToken, $hasAdvanced) {
 283                  return $this->resume($resumeToken, $hasAdvanced);
 284              }
 285          );
 286      }
 287  
 288      /**
 289       * Create the aggregate command for a change stream.
 290       *
 291       * This method is also used to recreate the aggregate command when resuming.
 292       *
 293       * @return Aggregate
 294       */
 295      private function createAggregate()
 296      {
 297          $pipeline = $this->pipeline;
 298          array_unshift($pipeline, ['$changeStream' => (object) $this->changeStreamOptions]);
 299  
 300          return new Aggregate($this->databaseName, $this->collectionName, $pipeline, $this->aggregateOptions);
 301      }
 302  
 303      /**
 304       * Create a ChangeStreamIterator by executing the aggregate command.
 305       *
 306       * @param Server $server
 307       * @return ChangeStreamIterator
 308       */
 309      private function createChangeStreamIterator(Server $server)
 310      {
 311          return new ChangeStreamIterator(
 312              $this->executeAggregate($server),
 313              $this->firstBatchSize,
 314              $this->getInitialResumeToken(),
 315              $this->postBatchResumeToken
 316          );
 317      }
 318  
 319      /**
 320       * Execute the aggregate command.
 321       *
 322       * The command will be executed using APM so that we can capture data from
 323       * its response (e.g. firstBatch size, postBatchResumeToken).
 324       *
 325       * @param Server $server
 326       * @return Cursor
 327       */
 328      private function executeAggregate(Server $server)
 329      {
 330          addSubscriber($this);
 331  
 332          try {
 333              return $this->aggregate->execute($server);
 334          } finally {
 335              removeSubscriber($this);
 336          }
 337      }
 338  
 339      /**
 340       * Return the initial resume token for creating the ChangeStreamIterator.
 341       *
 342       * @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#updating-the-cached-resume-token
 343       * @return array|object|null
 344       */
 345      private function getInitialResumeToken()
 346      {
 347          if ($this->firstBatchSize === 0 && isset($this->postBatchResumeToken)) {
 348              return $this->postBatchResumeToken;
 349          }
 350  
 351          if (isset($this->changeStreamOptions['startAfter'])) {
 352              return $this->changeStreamOptions['startAfter'];
 353          }
 354  
 355          if (isset($this->changeStreamOptions['resumeAfter'])) {
 356              return $this->changeStreamOptions['resumeAfter'];
 357          }
 358  
 359          return null;
 360      }
 361  
 362      /**
 363       * Resumes a change stream.
 364       *
 365       * @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#resume-process
 366       * @param array|object|null $resumeToken
 367       * @param bool              $hasAdvanced
 368       * @return ChangeStreamIterator
 369       * @throws InvalidArgumentException
 370       */
 371      private function resume($resumeToken = null, $hasAdvanced = false)
 372      {
 373          if (isset($resumeToken) && ! is_array($resumeToken) && ! is_object($resumeToken)) {
 374              throw InvalidArgumentException::invalidType('$resumeToken', $resumeToken, 'array or object');
 375          }
 376  
 377          $this->hasResumed = true;
 378  
 379          /* Select a new server using the original read preference. While watch
 380           * is not usable within transactions, we still check if there is a
 381           * pinned session. This is to avoid an ambiguous error message about
 382           * running a command on the wrong server. */
 383          $server = select_server($this->manager, $this->aggregateOptions);
 384  
 385          $resumeOption = isset($this->changeStreamOptions['startAfter']) && ! $hasAdvanced ? 'startAfter' : 'resumeAfter';
 386  
 387          unset($this->changeStreamOptions['resumeAfter']);
 388          unset($this->changeStreamOptions['startAfter']);
 389          unset($this->changeStreamOptions['startAtOperationTime']);
 390  
 391          if ($resumeToken !== null) {
 392              $this->changeStreamOptions[$resumeOption] = $resumeToken;
 393          }
 394  
 395          if ($resumeToken === null && $this->operationTime !== null) {
 396              $this->changeStreamOptions['startAtOperationTime'] = $this->operationTime;
 397          }
 398  
 399          // Recreate the aggregate command and return a new ChangeStreamIterator
 400          $this->aggregate = $this->createAggregate();
 401  
 402          return $this->createChangeStreamIterator($server);
 403      }
 404  
 405      /**
 406       * Determine whether to capture operation time from an aggregate response.
 407       *
 408       * @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#startatoperationtime
 409       * @param Server $server
 410       * @return boolean
 411       */
 412      private function shouldCaptureOperationTime(Server $server)
 413      {
 414          if ($this->hasResumed) {
 415              return false;
 416          }
 417  
 418          if (isset($this->changeStreamOptions['resumeAfter']) ||
 419              isset($this->changeStreamOptions['startAfter']) ||
 420              isset($this->changeStreamOptions['startAtOperationTime'])) {
 421              return false;
 422          }
 423  
 424          if ($this->firstBatchSize > 0) {
 425              return false;
 426          }
 427  
 428          if ($this->postBatchResumeToken !== null) {
 429              return false;
 430          }
 431  
 432          if (! server_supports_feature($server, self::$wireVersionForStartAtOperationTime)) {
 433              return false;
 434          }
 435  
 436          return true;
 437      }
 438  }