PHPLIB-477: Deprecate CodeWScope for use within the mapReduce command #690
Conversation
This file contains hidden or 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
approved these changes
Oct 29, 2019
| .. note:: | ||
|
|
||
| Passing a Javascript instance with a scope is deprecated. Put all scope | ||
| variables in the "scope" option of the MapReduce operation. |
There was a problem hiding this comment.
I think our convention for referring to options uses monospace formatting instead of quotes, so we should write scope here. Feel free to double-check, though.
This made we wonder if the scope option for mapReduce was being preserved with the aggregation changes. According to the design document linked from PM-766, it will remain available.
There was a problem hiding this comment.
Monospace formatting is the way to go in the rest of the docs, so I've adjusted it.
The deprecation message was suggested in the DRIVERS ticket, along with the "CodeWScope" wording which I decided to drop. This is why I assumed that the scope option would remain available. Thanks for confirming this.
src/Operation/MapReduce.php
Outdated
| } | ||
|
|
||
| if ($reduce->getScope() !== null) { | ||
| @trigger_error('Use of Javascript with scope in "$map" argument for MapReduce is deprecated. Put all scope variables in the "scope" option of the MapReduce operation.', E_USER_DEPRECATED); |
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.
https://jira.mongodb.org/browse/PHPLIB-477
Contrary to the original wording suggestion, I replaced the usage of "CodeWScope" for "Javascript instance with a scope". I don't think users will be familiar with the internal nomenclature of BSON types, so this may be more understandable to the average user.
Apart from deprecating these in the documentation, we also emit an
E_USER_DEPRECATEDPHP error that can be logged with libraries like symfony/phpunit-bridge.