PHPLIB-1313 Ensure the GridFS stream is saved when the script ends

Author: GromNaN

CHANGELOG.md

@@ -4,4 +4,4 @@
 ## 1.18.0 (unreleased)
 
  * Add `addSubscriber` and `removeSubscriber` methods to the `Client` class to ease dependency injection configuration
-
+ * Fix GridFS stream closing when the PHP script ends

src/GridFS/StreamWrapper.php

@@ -53,10 +53,11 @@ class StreamWrapper
 
     public function __destruct()
     {
-        /* This destructor is a workaround for PHP trying to use the stream well
-         * after all objects have been destructed. This can cause autoloading
-         * issues and possibly segmentation faults during PHP shutdown. */
-        $this->stream = null;
+        /* Ensure the stream is closed so the last chunk is written. This is
+         * necessary because PHP would close the stream after all objects have
+         * been destructed. This can cause autoloading issues and possibly
+         * segmentation faults during PHP shutdown. */
+        $this->stream_close();
     }
 
     /**

tests/GridFS/StreamWrapperFunctionalTest.php

@@ -5,13 +5,16 @@
 use MongoDB\BSON\Binary;
 use MongoDB\BSON\UTCDateTime;
 
+use function escapeshellarg;
+use function exec;
 use function fclose;
 use function feof;
 use function fread;
 use function fseek;
 use function fstat;
 use function fwrite;
 
+use const PHP_BINARY;
 use const SEEK_CUR;
 use const SEEK_END;
 use const SEEK_SET;
@@ -204,4 +207,18 @@ public function testWritableStreamWrite(): void
 
         $this->assertSame(6, fwrite($stream, 'foobar'));
     }
+
+    public function testAutocloseOnScriptEnd(): void
+    {
+        $command = PHP_BINARY . ' ' . escapeshellarg(__DIR__ . '/scripts/stream-autoclose.php');
+        exec($command, $output, $exitCode);
+
+        $this->assertSame([], $output);
+        $this->assertSame(0, $exitCode);
+
+        $fileDocument = $this->filesCollection->findOne(['filename' => 'hello.txt']);
+
+        $this->assertNotNull($fileDocument);
+        $this->assertSame(14, $fileDocument->length);
+    }
 }

tests/GridFS/scripts/stream-autoclose.php

@@ -0,0 +1,13 @@
+<?php
+
+use MongoDB\Client;
+
+require __DIR__ . '/../../../vendor/autoload.php';
+
+$client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1:27017/?serverSelectionTimeoutMS=100');
+$database = $client->selectDatabase(getenv('MONGODB_DATABASE') ?: 'phplib_test');
+$gridfs = $database->selectGridFSBucket();
+$stream = $gridfs->openUploadStream('hello.txt');
+fwrite($stream, 'Hello MongoDB!');
+
+// The WriteStream must be closed and the file inserted automatically