PHPLIB-1325 Deprecate setting disableMD5 to false when using GridFS
#1205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmikola
reviewed
Dec 18, 2023
GromNaN
force-pushed
the
PHPLIB-1325
branch
2 times, most recently
from
c2ac9b5 to
4980d54
Compare
GromNaN
changed the title
disableMD5 to false when using GridFS
|
Updated the PR to raise a deprecation notice if user explicitly passes false. |
jmikola
reviewed
Jan 3, 2024
src/GridFS/Bucket.php
Outdated
| @@ -132,6 +133,10 @@ class Bucket | |||
| */ | |||
| public function __construct(Manager $manager, string $databaseName, array $options = []) | |||
| { | |||
| if (isset($options['disableMD5']) && $options['disableMD5'] === false) { | |||
| trigger_deprecation('mongodb/mongodb', '1.10', 'Setting GridFS "disableMD5" option to "false" is deprecated and will not be supported in version 2.0.'); | |||
There was a problem hiding this comment.
"1.10" looks incorrect here. Should it be "1.18", since that will be the version where this change is implemented?
There was a problem hiding this comment.
Fixed. Copilot need to be smarter with package versions. And me at reviewing my own PR.
jmikola
reviewed
Jan 4, 2024
src/GridFS/Bucket.php
Outdated
| @@ -61,6 +61,7 @@ | |||
| use function stream_copy_to_stream; | |||
| use function stream_get_meta_data; | |||
| use function stream_get_wrappers; | |||
| use function trigger_deprecation; | |||
There was a problem hiding this comment.
Is this the first usage of trigger_deprecation() in PHPLIB? If so, I think we should add a dependency on symfony/deprecation-contracts. The function might presently only be available through some indirect dependency.
Apologies for missing this in the last review.
There was a problem hiding this comment.
I switched back to the native @trigger_error as used in other places in the library.
jmikola
approved these changes
Jan 8, 2024
alcaeus
approved these changes
Jan 8, 2024
alcaeus
added a commit
to alcaeus/mongo-php-library
that referenced
this pull request
Jan 15, 2024
* master: PHPLIB-1323 Implement `unlink` for GridFS stream wrapper (mongodb#1206) PHPLIB-1330: Sync tests for failCommand errorLabels reqs (mongodb#1214) PHPLIB-1246: Test PHP 8.3 on Evergreen (mongodb#1213) PHPLIB-1324 Implement `rename` for GridFS stream wrapper (mongodb#1207) PHPLIB-1248 Add examples on GridFS (mongodb#1196) Deprecate setting GridFS disableMD5 to false explicitly (mongodb#1205) PHPLIB-1326: Use more permissive top-level runOnRequirements (mongodb#1210) PHPLIB-1206 Add bucket alises for context resolver using GridFS StreamWrapper (mongodb#1138) Bump actions/upload-artifact from 3 to 4 (mongodb#1208) PHPLIB-1275: Replace apiargs usage in docs with extracts (mongodb#1203) Fix title formatting in Client::removeSubscriber() docs (mongodb#1204) PHPLIB-1304: Pull mongohouse image from ECR repo (mongodb#1202) Fix evergreen failures (mongodb#1200) Enable workflows to run for GitHub Merge Queue (mongodb#1199) PHPLIB-1313 Ensure the GridFS stream is saved when the script ends (mongodb#1197) PHPLIB-1309 Add addSubscriber/removeSubscriber to Client class to ease configuration (mongodb#1195) Master is now 1.18-dev
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix PHPLIB-1325