Specify callable explicitly in ChangeStream

Author: alcaeus

psalm-baseline.xml

@@ -1,10 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="4.x-dev@5108834088c1d8cae3698df6ef6bf15fe6e76c53">
-  <file src="src/ChangeStream.php">
-    <MixedAssignment occurrences="1">
-      <code>$this-&gt;iterator</code>
-    </MixedAssignment>
-  </file>
   <file src="src/Client.php">
     <MixedArgument occurrences="1">
       <code>$driverOptions['driver'] ?? []</code>
@@ -747,14 +742,8 @@
     <DocblockTypeContradiction occurrences="1">
       <code>isset($resumeToken) &amp;&amp; ! is_array($resumeToken) &amp;&amp; ! is_object($resumeToken)</code>
     </DocblockTypeContradiction>
-    <MissingClosureParamType occurrences="2">
-      <code>$hasAdvanced</code>
-      <code>$resumeToken</code>
-    </MissingClosureParamType>
-    <MixedArgument occurrences="3">
-      <code>$hasAdvanced</code>
+    <MixedArgument occurrences="1">
       <code>$reply-&gt;cursor-&gt;firstBatch</code>
-      <code>$resumeToken</code>
     </MixedArgument>
     <MixedAssignment occurrences="1">
       <code>$this-&gt;postBatchResumeToken</code>

src/ChangeStream.php

@@ -24,7 +24,6 @@
 use MongoDB\Driver\Exception\ServerException;
 use MongoDB\Exception\BadMethodCallException;
 use MongoDB\Exception\ResumeTokenException;
-use MongoDB\Exception\UnexpectedValueException;
 use MongoDB\Model\ChangeStreamIterator;
 use ReturnTypeWillChange;
 
@@ -34,6 +33,8 @@
 /**
  * Iterator for a change stream.
  *
+ * @psalm-type ResumeCallable = callable(array|object|null, bool): ChangeStreamIterator
+ *
  * @api
  * @see \MongoDB\Collection::watch()
  * @see https://mongodb.com/docs/manual/reference/method/db.watch/#mongodb-method-db.watch
@@ -73,7 +74,7 @@ class ChangeStream implements Iterator
     /** @var int */
     private static $wireVersionForResumableChangeStreamError = 9;
 
-    /** @var callable|null */
+    /** @var ResumeCallable|null */
     private $resumeCallable;
 
     /** @var ChangeStreamIterator */
@@ -92,6 +93,8 @@ class ChangeStream implements Iterator
 
     /**
      * @internal
+     *
+     * @param ResumeCallable $resumeCallable
      */
     public function __construct(ChangeStreamIterator $iterator, callable $resumeCallable)
     {
@@ -257,9 +260,6 @@ private function resume(): void
         }
 
         $this->iterator = call_user_func($this->resumeCallable, $this->getResumeToken(), $this->hasAdvanced);
-        if (! $this->iterator instanceof ChangeStreamIterator) {
-            throw new UnexpectedValueException('Expected change stream iterator from callable');
-        }
 
         $this->iterator->rewind();
 

src/Operation/Watch.php

@@ -326,7 +326,7 @@ public function execute(Server $server)
     {
         return new ChangeStream(
             $this->createChangeStreamIterator($server),
-            function ($resumeToken, $hasAdvanced) {
+            function ($resumeToken, $hasAdvanced): ChangeStreamIterator {
                 return $this->resume($resumeToken, $hasAdvanced);
             }
         );