[Serializer] Deprecate CsvEncoder as_collection false default value #27715
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
|
(rebase needed) |
dunglas
approved these changes
Jun 28, 2018
|
Rebased |
chalasr
approved these changes
Jun 29, 2018
fabpot
previously requested changes
Jun 30, 2018
UPGRADE-4.2.md
Outdated
| -------------- | ||
|
|
||
| * The `lazy` attribute on `doctrine.event_listener` tags was removed. | ||
| Listeners are now lazy by default. So any `lazy` attributes can safely be removed from those tags. |
There was a problem hiding this comment.
Does not seem related to this PR.
There was a problem hiding this comment.
Yes, indeed. It's just to respect the alpha order we use on UPGRADE files.
I can do another PR if you want, but IIRC we already accepted such changes inside unrelated PRs in the past.
fabpot
approved these changes
Jun 30, 2018
sroze
approved these changes
Jun 30, 2018
|
Thank you @ogizanagi. |
fabpot
added a commit
that referenced
this pull request
Jun 30, 2018
…default value (ogizanagi) This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Deprecate CsvEncoder as_collection false default value | Q | A | ------------- | --- | Branch? | master <!-- see below --> | Bug fix? | no | New feature? | no <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | yes <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | N/A <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A As already expressed in #25369 and related issues, this behavior is quite counter-intuitive. It may be fine for write-API with a single document in the body but I think such CSV APIs are way less common than file-based ones, expecting collections. So I think this behavior should be opt-in explicitly in required cases, always dealing with collections by default. This is still an arbitrary decision, but trying to make it based on use-cases and user's experience with CSV. Note: perhaps we could find a better name for this as the semantic of setting `as_collection` to `false` to get the single row directly would not be really obvious. Also, it could throw an exception when getting multiple rows where only one was expected. Commits ------- bce59c8 [Serializer] Deprecate CsvEncoder as_collection false default value
This was referenced Nov 3, 2018
Closed
Merged
nicolas-grekas
added a commit
that referenced
this pull request
May 29, 2019
…on & change default value (ogizanagi) This PR was merged into the 5.0-dev branch. Discussion ---------- [Serializer] Remove CsvEncoder "as_collection" deprecation & change default value | Q | A | ------------- | --- | Branch? | master <!-- see below --> | Bug fix? | no | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes (AppVeyor failure unrelated. See https://github.com/symfony/symfony/pull/31685/files) <!-- please add some, will be required by reviewers --> | Fixed tickets | #27715 <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A <!-- required for new features --> As planned in #27715 Commits ------- 22dd071 [Serializer] Remove CsvEncoder "as_collection" deprecation & change default value
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.
As already expressed in #25369 and related issues, this behavior is quite counter-intuitive. It may be fine for write-API with a single document in the body but I think such CSV APIs are way less common than file-based ones, expecting collections. So I think this behavior should be opt-in explicitly in required cases, always dealing with collections by default.
This is still an arbitrary decision, but trying to make it based on use-cases and user's experience with CSV.
Note: perhaps we could find a better name for this as the semantic of setting
as_collectiontofalseto get the single row directly would not be really obvious.Also, it could throw an exception when getting multiple rows where only one was expected.