Remove usage of deprecated BSON functions (#1361)

alcaeus · web-flow · commit f4815a11a233 · 2024-07-16T14:51:07.000Z
* Remove usage of deprecated BSON functions

* Fix psalm issues

* Refactor test
diff --git a/docs/tutorial/custom-types.txt b/docs/tutorial/custom-types.txt
@@ -151,8 +151,8 @@ back to ``LocalDateTime``.
 .. code-block:: php
 
     <?php
-    $bson = MongoDB\BSON\fromPHP(['date' => new LocalDateTime]);
-    $document = MongoDB\BSON\toPHP($bson);
+    $bson = MongoDB\BSON\Document::fromPHP(['date' => new LocalDateTime]);
+    $document = $bson->toPHP();
 
     var_dump($document);
     var_dump($document->date->toDateTime());
diff --git a/docs/tutorial/example-data.txt b/docs/tutorial/example-data.txt
@@ -22,8 +22,8 @@ example imports the ``zips.json`` file into a ``test.zips`` collection using the
    $bulk = new MongoDB\Driver\BulkWrite;
 
    foreach ($lines as $line) {
-       $bson = MongoDB\BSON\fromJSON($line);
-       $document = MongoDB\BSON\toPHP($bson);
+       $bson = MongoDB\BSON\Document::fromJSON($line);
+       $document = $bson->toPHP();
        $bulk->insert($document);
    }
 
diff --git a/examples/aggregate.php b/examples/aggregate.php
@@ -3,21 +3,20 @@
 
 namespace MongoDB\Examples\Aggregate;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 
 use function assert;
 use function getenv;
 use function is_object;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
 use function random_int;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 function toJSON(object $document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 $client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1/');
diff --git a/examples/bulk.php b/examples/bulk.php
@@ -3,21 +3,20 @@
 
 namespace MongoDB\Examples\Bulk;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 use MongoDB\Driver\WriteConcern;
 
 use function assert;
 use function getenv;
 use function is_object;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 function toJSON(object $document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 $client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1/');
diff --git a/examples/changestream.php b/examples/changestream.php
@@ -3,21 +3,20 @@
 
 namespace MongoDB\Examples\ChangeStream;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 
 use function assert;
 use function getenv;
 use function is_object;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
 use function time;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 function toJSON(object $document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 // Change streams require a replica set or sharded cluster
diff --git a/examples/command_logger.php b/examples/command_logger.php
@@ -3,6 +3,7 @@
 
 namespace MongoDB\Examples\CommandLogger;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 use MongoDB\Driver\Monitoring\CommandFailedEvent;
 use MongoDB\Driver\Monitoring\CommandStartedEvent;
@@ -13,15 +14,13 @@
 use function get_class;
 use function getenv;
 use function is_object;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 function toJSON(object $document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 class CommandLogger implements CommandSubscriber
diff --git a/examples/sdam_logger.php b/examples/sdam_logger.php
@@ -3,6 +3,7 @@
 
 namespace MongoDB\Examples;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 use MongoDB\Driver\Monitoring\SDAMSubscriber;
 use MongoDB\Driver\Monitoring\ServerChangedEvent;
@@ -17,16 +18,14 @@
 
 use function get_class;
 use function getenv;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 /** @param array|object $document */
 function toJSON($document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 class SDAMLogger implements SDAMSubscriber
diff --git a/examples/with_transaction.php b/examples/with_transaction.php
@@ -3,22 +3,21 @@
 
 namespace MongoDB\Examples\WithTransaction;
 
+use MongoDB\BSON\Document;
 use MongoDB\Client;
 use MongoDB\Driver\Session;
 
 use function assert;
 use function getenv;
 use function is_object;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function MongoDB\with_transaction;
 use function printf;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 function toJSON(object $document): string
 {
-    return toRelaxedExtendedJSON(fromPHP($document));
+    return Document::fromPHP($document)->toRelaxedExtendedJSON();
 }
 
 // Transactions require a replica set (MongoDB >= 4.0) or sharded cluster (MongoDB >= 4.2)
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -135,19 +135,6 @@
       <code>stdClass</code>
     </MoreSpecificReturnType>
   </file>
-  <file src="src/Model/BSONIterator.php">
-    <MixedArgument>
-      <code>$documentLength</code>
-      <code>$documentLength</code>
-      <code><![CDATA[$this->options['typeMap']]]></code>
-    </MixedArgument>
-    <MixedAssignment>
-      <code><![CDATA[$this->position]]></code>
-    </MixedAssignment>
-    <MixedOperand>
-      <code>$documentLength</code>
-    </MixedOperand>
-  </file>
   <file src="src/Model/ChangeStreamIterator.php">
     <MixedArgument>
       <code><![CDATA[$reply->cursor->nextBatch]]></code>
diff --git a/src/GridFS/Bucket.php b/src/GridFS/Bucket.php
@@ -52,8 +52,6 @@
 use function is_string;
 use function method_exists;
 use function MongoDB\apply_type_map_to_document;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toJSON;
 use function property_exists;
 use function sprintf;
 use function str_contains;
@@ -705,7 +703,7 @@ public function uploadFromStream(string $filename, $source, array $options = [])
     private function createPathForFile(object $file): string
     {
         if (is_array($file->_id) || (is_object($file->_id) && ! method_exists($file->_id, '__toString'))) {
-            $id = toJSON(fromPHP(['_id' => $file->_id]));
+            $id = Document::fromPHP(['_id' => $file->_id])->toRelaxedExtendedJSON();
         } else {
             $id = (string) $file->_id;
         }
diff --git a/src/GridFS/Exception/FileNotFoundException.php b/src/GridFS/Exception/FileNotFoundException.php
@@ -17,10 +17,9 @@
 
 namespace MongoDB\GridFS\Exception;
 
+use MongoDB\BSON\Document;
 use MongoDB\Exception\RuntimeException;
 
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toJSON;
 use function sprintf;
 
 class FileNotFoundException extends RuntimeException
@@ -58,7 +57,7 @@ public static function byFilenameAndRevision(string $filename, int $revision, st
      */
     public static function byId($id, string $namespace)
     {
-        $json = toJSON(fromPHP(['_id' => $id]));
+        $json = Document::fromPHP(['_id' => $id])->toRelaxedExtendedJSON();
 
         return new self(sprintf('File "%s" not found in "%s"', $json, $namespace));
     }
diff --git a/src/GridFS/Exception/StreamException.php b/src/GridFS/Exception/StreamException.php
@@ -2,10 +2,9 @@
 
 namespace MongoDB\GridFS\Exception;
 
+use MongoDB\BSON\Document;
 use MongoDB\Exception\RuntimeException;
 
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toJSON;
 use function sprintf;
 use function stream_get_meta_data;
 
@@ -30,7 +29,7 @@ public static function downloadFromFilenameFailed(string $filename, $source, $de
      */
     public static function downloadFromIdFailed($id, $source, $destination): self
     {
-        $idString = toJSON(fromPHP(['_id' => $id]));
+        $idString = Document::fromPHP(['_id' => $id])->toRelaxedExtendedJSON();
         $sourceMetadata = stream_get_meta_data($source);
         $destinationMetadata = stream_get_meta_data($destination);
 
diff --git a/src/Model/BSONIterator.php b/src/Model/BSONIterator.php
@@ -18,12 +18,14 @@
 namespace MongoDB\Model;
 
 use Iterator;
+use MongoDB\BSON\Document;
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Exception\UnexpectedValueException;
 use ReturnTypeWillChange;
 
+use function assert;
 use function is_array;
-use function MongoDB\BSON\toPHP;
+use function is_int;
 use function sprintf;
 use function strlen;
 use function substr;
@@ -49,6 +51,7 @@ class BSONIterator implements Iterator
 
     private int $position = 0;
 
+    /** @var array{typeMap: array, ...} */
     private array $options;
 
     /**
@@ -142,12 +145,13 @@ private function advance(): void
         }
 
         [, $documentLength] = unpack('V', substr($this->buffer, $this->position, self::BSON_SIZE));
+        assert(is_int($documentLength));
 
         if ($this->bufferLength - $this->position < $documentLength) {
             throw new UnexpectedValueException(sprintf('Expected %d bytes; %d remaining', $documentLength, $this->bufferLength - $this->position));
         }
 
-        $this->current = toPHP(substr($this->buffer, $this->position, $documentLength), $this->options['typeMap']);
+        $this->current = Document::fromBSON(substr($this->buffer, $this->position, $documentLength))->toPHP($this->options['typeMap']);
         $this->position += $documentLength;
     }
 }
diff --git a/src/functions.php b/src/functions.php
@@ -43,8 +43,6 @@
 use function is_array;
 use function is_object;
 use function is_string;
-use function MongoDB\BSON\fromPHP;
-use function MongoDB\BSON\toPHP;
 use function str_ends_with;
 use function substr;
 
@@ -115,7 +113,7 @@ function apply_type_map_to_document($document, array $typeMap)
         throw InvalidArgumentException::expectedDocumentType('$document', $document);
     }
 
-    return toPHP(fromPHP($document), $typeMap);
+    return Document::fromPHP($document)->toPHP($typeMap);
 }
 
 /**
diff --git a/tests/Model/BSONIteratorTest.php b/tests/Model/BSONIteratorTest.php
diff --git a/tests/SpecTests/DocumentsMatchConstraintTest.php b/tests/SpecTests/DocumentsMatchConstraintTest.php
diff --git a/tests/SpecTests/FunctionalTestCase.php b/tests/SpecTests/FunctionalTestCase.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/UnifiedSpecTests/Constraint/IsBsonTypeTest.php b/tests/UnifiedSpecTests/Constraint/IsBsonTypeTest.php
diff --git a/tests/UnifiedSpecTests/UnifiedTestCase.php b/tests/UnifiedSpecTests/UnifiedTestCase.php

Original file line number	Diff line number	Diff line change
@@ -22,8 +22,8 @@ example imports the ``zips.json`` file into a ``test.zips`` collection using the
`22`	`22`	`$bulk = new MongoDB\Driver\BulkWrite;`
`23`	`23`
`24`	`24`	`foreach ($lines as $line) {`
`25`		`- $bson = MongoDB\BSON\fromJSON($line);`
`26`		`- $document = MongoDB\BSON\toPHP($bson);`
	`25`	`+ $bson = MongoDB\BSON\Document::fromJSON($line);`
	`26`	`+ $document = $bson->toPHP();`
`27`	`27`	`$bulk->insert($document);`
`28`	`28`	`}`
`29`	`29`