Skip to content

PHPLIB-1218 Remove deprecated fields from GridFS files #1398

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 7 commits into from
Sep 16, 2024
Merged

PHPLIB-1218 Remove deprecated fields from GridFS files #1398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0fe0d1f
PHPLIB-1218 Remove derecated "md5" field from GridFS files
GromNaN Sep 13, 2024
513f269
PHPLIB-1218 Remove GridFS fields contentType and aliases
GromNaN Sep 13, 2024
0c5bab1
Remove spec test with md5 field
GromNaN Sep 13, 2024
346c4f6
Remove HashContext and dependency
GromNaN Sep 13, 2024
ba7dded
Add UPGRADE instructions
GromNaN Sep 13, 2024
9278b6b
Skip unified test with removed field
GromNaN Sep 13, 2024
08e18c9
Remove deprecated fields from tests
GromNaN Sep 16, 2024
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
28 changes: 28 additions & 0 deletions UPGRADE-2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
UPGRADE FROM 1.x to 2.0
========================

GridFS
------

* The `md5` is no longer calculated when a file is uploaded to GridFS.
Applications that require a file digest should implement it outside GridFS
and store in metadata.

```php
$hash = hash_file('sha256', $filename);
$bucket->openUploadStream($fileId, ['metadata' => ['hash' => $hash]]);
```

* The fields `contentType` and `aliases` are no longer stored in the `files`
collection. Applications that require this information should store it in
metadata.

**Before:**
```php
$bucket->openUploadStream($fileId, ['contentType' => 'image/png']);
```

**After:**
```php
$bucket->openUploadStream($fileId, ['metadata' => ['contentType' => 'image/png']]);
```
1 change: 0 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
],
"require": {
"php": "^8.1",
"ext-hash": "*",
"ext-json": "*",
"ext-mongodb": "^1.20.0",
"composer-runtime-api": "^2.0",
Expand Down
34 changes: 3 additions & 31 deletions src/GridFS/Bucket.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
use function get_resource_type;
use function in_array;
use function is_array;
use function is_bool;
use function is_integer;
use function is_object;
use function is_resource;
Expand All @@ -59,11 +58,8 @@
use function stream_copy_to_stream;
use function stream_get_meta_data;
use function stream_get_wrappers;
use function trigger_error;
use function urlencode;

use const E_USER_DEPRECATED;

/**
* Bucket provides a public API for interacting with the GridFS files and chunks
* collections.
Expand All @@ -88,8 +84,6 @@ class Bucket

private string $bucketName;

private bool $disableMD5;

private int $chunkSizeBytes;

private ReadConcern $readConcern;
Expand All @@ -111,9 +105,6 @@ class Bucket
* * chunkSizeBytes (integer): The chunk size in bytes. Defaults to
* 261120 (i.e. 255 KiB).
*
* * disableMD5 (boolean): When true, no MD5 sum will be generated for
* each stored file. Defaults to "false".
*
* * readConcern (MongoDB\Driver\ReadConcern): Read concern.
*
* * readPreference (MongoDB\Driver\ReadPreference): Read preference.
Expand All @@ -129,14 +120,9 @@ class Bucket
*/
public function __construct(private Manager $manager, private string $databaseName, array $options = [])
{
if (isset($options['disableMD5']) && $options['disableMD5'] === false) {
@trigger_error('Setting GridFS "disableMD5" option to "false" is deprecated since mongodb/mongodb 1.18 and will not be supported in version 2.0.', E_USER_DEPRECATED);
}

$options += [
'bucketName' => self::DEFAULT_BUCKET_NAME,
'chunkSizeBytes' => self::DEFAULT_CHUNK_SIZE_BYTES,
'disableMD5' => false,
];

if (! is_string($options['bucketName'])) {
Expand All @@ -155,10 +141,6 @@ public function __construct(private Manager $manager, private string $databaseNa
throw InvalidArgumentException::invalidType('"codec" option', $options['codec'], DocumentCodec::class);
}

if (! is_bool($options['disableMD5'])) {
throw InvalidArgumentException::invalidType('"disableMD5" option', $options['disableMD5'], 'boolean');
}

if (isset($options['readConcern']) && ! $options['readConcern'] instanceof ReadConcern) {
throw InvalidArgumentException::invalidType('"readConcern" option', $options['readConcern'], ReadConcern::class);
}
Expand All @@ -182,7 +164,6 @@ public function __construct(private Manager $manager, private string $databaseNa
$this->bucketName = $options['bucketName'];
$this->chunkSizeBytes = $options['chunkSizeBytes'];
$this->codec = $options['codec'] ?? null;
$this->disableMD5 = $options['disableMD5'];
$this->readConcern = $options['readConcern'] ?? $this->manager->getReadConcern();
$this->readPreference = $options['readPreference'] ?? $this->manager->getReadPreference();
$this->typeMap = $options['typeMap'] ?? self::DEFAULT_TYPE_MAP;
Expand Down Expand Up @@ -211,7 +192,6 @@ public function __debugInfo()
'bucketName' => $this->bucketName,
'codec' => $this->codec,
'databaseName' => $this->databaseName,
'disableMD5' => $this->disableMD5,
'manager' => $this->manager,
'chunkSizeBytes' => $this->chunkSizeBytes,
'readConcern' => $this->readConcern,
Expand Down Expand Up @@ -565,9 +545,6 @@ public function openDownloadStreamByName(string $filename, array $options = [])
* * chunkSizeBytes (integer): The chunk size in bytes. Defaults to the
* bucket's chunk size.
*
* * disableMD5 (boolean): When true, no MD5 sum will be generated for
* the stored file. Defaults to "false".
*
* * metadata (document): User data for the "metadata" field of the files
* collection document.
*
Expand All @@ -579,7 +556,6 @@ public function openUploadStream(string $filename, array $options = [])
{
$options += [
'chunkSizeBytes' => $this->chunkSizeBytes,
'disableMD5' => $this->disableMD5,
];

$path = $this->createPathForUpload();
Expand Down Expand Up @@ -658,9 +634,6 @@ public function rename(mixed $id, string $newFilename)
* * chunkSizeBytes (integer): The chunk size in bytes. Defaults to the
* bucket's chunk size.
*
* * disableMD5 (boolean): When true, no MD5 sum will be generated for
* the stored file. Defaults to "false".
*
* * metadata (document): User data for the "metadata" field of the files
* collection document.
*
Expand Down Expand Up @@ -792,9 +765,9 @@ private function registerStreamWrapper(): void
*
* @see StreamWrapper::setContextResolver()
*
* @param string $path The full url provided to fopen(). It contains the filename.
* gridfs://database_name/collection_name.files/file_name
* @param array{revision?: int, chunkSizeBytes?: int, disableMD5?: bool} $context The options provided to fopen()
* @param string $path The full url provided to fopen(). It contains the filename.
* gridfs://database_name/collection_name.files/file_name
* @param array{revision?: int, chunkSizeBytes?: int} $context The options provided to fopen()
*
* @return array{collectionWrapper: CollectionWrapper, file: object}|array{collectionWrapper: CollectionWrapper, filename: string, options: array}
*
Expand Down Expand Up @@ -825,7 +798,6 @@ private function resolveStreamContext(string $path, string $mode, array $context
'filename' => $filename,
'options' => $context + [
'chunkSizeBytes' => $this->chunkSizeBytes,
'disableMD5' => $this->disableMD5,
],
];
}
Expand Down
50 changes: 1 addition & 49 deletions src/GridFS/WritableStream.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,15 @@

namespace MongoDB\GridFS;

use HashContext;
use MongoDB\BSON\Binary;
use MongoDB\BSON\ObjectId;
use MongoDB\BSON\UTCDateTime;
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
use MongoDB\Exception\InvalidArgumentException;

use function array_intersect_key;
use function hash_final;
use function hash_init;
use function hash_update;
use function is_bool;
use function is_integer;
use function is_string;
use function MongoDB\is_document;
use function MongoDB\is_string_array;
use function sprintf;
use function strlen;
use function substr;
Expand All @@ -52,12 +45,8 @@ class WritableStream

private int $chunkSize;

private bool $disableMD5;

private array $file;

private ?HashContext $hashCtx = null;

private bool $isClosed = false;

private int $length = 0;
Expand All @@ -69,19 +58,9 @@ class WritableStream
*
* * _id (mixed): File document identifier. Defaults to a new ObjectId.
*
* * aliases (array of strings): DEPRECATED An array of aliases.
* Applications wishing to store aliases should add an aliases field to
* the metadata document instead.
*
* * chunkSizeBytes (integer): The chunk size in bytes. Defaults to
* 261120 (i.e. 255 KiB).
*
* * disableMD5 (boolean): When true, no MD5 sum will be generated.
* Defaults to "false".
*
* * contentType (string): DEPRECATED content type to be stored with the
* file. This information should now be added to the metadata.
*
* * metadata (document): User data for the "metadata" field of the files
* collection document.
*
Expand All @@ -95,13 +74,8 @@ public function __construct(private CollectionWrapper $collectionWrapper, string
$options += [
'_id' => new ObjectId(),
'chunkSizeBytes' => self::DEFAULT_CHUNK_SIZE_BYTES,
'disableMD5' => false,
];

if (isset($options['aliases']) && ! is_string_array($options['aliases'])) {
throw InvalidArgumentException::invalidType('"aliases" option', $options['aliases'], 'array of strings');
}

if (! is_integer($options['chunkSizeBytes'])) {
throw InvalidArgumentException::invalidType('"chunkSizeBytes" option', $options['chunkSizeBytes'], 'integer');
}
Expand All @@ -110,32 +84,18 @@ public function __construct(private CollectionWrapper $collectionWrapper, string
throw new InvalidArgumentException(sprintf('Expected "chunkSizeBytes" option to be >= 1, %d given', $options['chunkSizeBytes']));
}

if (! is_bool($options['disableMD5'])) {
throw InvalidArgumentException::invalidType('"disableMD5" option', $options['disableMD5'], 'boolean');
}

if (isset($options['contentType']) && ! is_string($options['contentType'])) {
throw InvalidArgumentException::invalidType('"contentType" option', $options['contentType'], 'string');
}

if (isset($options['metadata']) && ! is_document($options['metadata'])) {
throw InvalidArgumentException::expectedDocumentType('"metadata" option', $options['metadata']);
}

$this->chunkSize = $options['chunkSizeBytes'];
$this->disableMD5 = $options['disableMD5'];

if (! $this->disableMD5) {
$this->hashCtx = hash_init('md5');
}

$this->file = [
'_id' => $options['_id'],
'chunkSize' => $this->chunkSize,
'filename' => $filename,
'length' => null,
'uploadDate' => null,
] + array_intersect_key($options, ['aliases' => 1, 'contentType' => 1, 'metadata' => 1]);
] + array_intersect_key($options, ['metadata' => 1]);
}

/**
Expand Down Expand Up @@ -248,10 +208,6 @@ private function fileCollectionInsert(): void
$this->file['length'] = $this->length;
$this->file['uploadDate'] = new UTCDateTime();

if (! $this->disableMD5 && $this->hashCtx) {
$this->file['md5'] = hash_final($this->hashCtx);
}

try {
$this->collectionWrapper->insertFile($this->file);
} catch (DriverRuntimeException $e) {
Expand All @@ -276,10 +232,6 @@ private function insertChunkFromBuffer(): void
'data' => new Binary($data),
];

if (! $this->disableMD5 && $this->hashCtx) {
hash_update($this->hashCtx, $data);
}

try {
$this->collectionWrapper->insertChunk($chunk);
} catch (DriverRuntimeException $e) {
Expand Down
38 changes: 3 additions & 35 deletions tests/GridFS/BucketFunctionalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ public function testValidConstructorOptions(): void
'readConcern' => new ReadConcern(ReadConcern::LOCAL),
'readPreference' => new ReadPreference(ReadPreference::PRIMARY),
'writeConcern' => new WriteConcern(WriteConcern::MAJORITY, 1000),
'disableMD5' => true,
]);
}

Expand All @@ -77,7 +76,6 @@ public static function provideInvalidConstructorOptions()
'bucketName' => self::getInvalidStringValues(true),
'chunkSizeBytes' => self::getInvalidIntegerValues(true),
'codec' => self::getInvalidDocumentCodecValues(),
'disableMD5' => self::getInvalidBooleanValues(true),
'readConcern' => self::getInvalidReadConcernValues(),
'readPreference' => self::getInvalidReadPreferenceValues(),
'typeMap' => self::getInvalidArrayValues(),
Expand Down Expand Up @@ -762,46 +760,16 @@ public function testUploadingAnEmptyFile(): void
[
'projection' => [
'length' => 1,
'md5' => 1,
'_id' => 0,
],
],
);

$expected = [
'length' => 0,
'md5' => 'd41d8cd98f00b204e9800998ecf8427e',
];
$expected = ['length' => 0];

$this->assertSameDocument($expected, $fileDocument);
}

public function testDisableMD5(): void
{
$options = ['disableMD5' => true];
$id = $this->bucket->uploadFromStream('filename', self::createStream('data'), $options);

$fileDocument = $this->filesCollection->findOne(
['_id' => $id],
);

$this->assertArrayNotHasKey('md5', $fileDocument);
}

public function testDisableMD5OptionInConstructor(): void
{
$options = ['disableMD5' => true];

$this->bucket = new Bucket($this->manager, $this->getDatabaseName(), $options);
$id = $this->bucket->uploadFromStream('filename', self::createStream('data'));

$fileDocument = $this->filesCollection->findOne(
['_id' => $id],
);

$this->assertArrayNotHasKey('md5', $fileDocument);
}

public function testUploadingFirstFileCreatesIndexes(): void
{
$this->bucket->uploadFromStream('filename', self::createStream('foo'));
Expand Down Expand Up @@ -863,7 +831,7 @@ public function testDanglingOpenWritableStream(): void
$client = MongoDB\Tests\FunctionalTestCase::createTestClient();
$database = $client->selectDatabase(getenv('MONGODB_DATABASE') ?: 'phplib_test');
$gridfs = $database->selectGridFSBucket();
$stream = $gridfs->openUploadStream('hello.txt', ['disableMD5' => true]);
$stream = $gridfs->openUploadStream('hello.txt');
fwrite($stream, 'Hello MongoDB!');
PHP;

Expand Down Expand Up @@ -970,7 +938,7 @@ public function testResolveStreamContextForWrite(): void
$this->assertArrayHasKey('filename', $context);
$this->assertSame('filename', $context['filename']);
$this->assertArrayHasKey('options', $context);
$this->assertSame(['chunkSizeBytes' => 261120, 'disableMD5' => false], $context['options']);
$this->assertSame(['chunkSizeBytes' => 261120], $context['options']);
}

/**
Expand Down
Loading