[HttpFoundation] Add `ParameterBag::getString()` and deprecate accepting invalid values #48525

GromNaN · Dec 6, 2022

Q	A
Branch?	6.3
Bug fix?	no
New feature?	yes
Deprecations?	yes
Tickets	Fix #44787 #48219
License	MIT
Doc PR	symfony/symfony-docs#...

There were a lot of discussions on #44787 regarding the implementation. The main debate is to determine the right behavior when the value is invalid: try to convert the value, throw an exception, return the default value or the falsy?

I added plenty of test cases for the methods getAlpha, getAlnum, getDigits, getInt, ~~getInteger~~, getString so that we can discuss the expected result for each input value.

My goals:

Provide safe methods to get values in the expected type. Example: The parameters being generally of type string, the getString method is useful to be sure we don't get an array.
Reduce deprecations on methods that exist since Symfony 2.0, in one of the most popular Symfony component.

How are these getter methods used?

Most of the time, parameter values are string (from routing, query string, request payload). get is used but does not validate the return type.
getInt is used for pagination (UX Autocomplete) or getting an index (EasyAdmin)
I think there was an unidentified breaking change when we introduced return types #42507. Methods getAlpha, getAlnum and getDigits could return an array, but their return type have been modified to string, resulting in a TypeError. example of use

src/Symfony/Component/HttpFoundation/InputBag.php

src/Symfony/Component/HttpFoundation/ParameterBag.php

src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php

src/Symfony/Component/HttpFoundation/ParameterBag.php

src/Symfony/Component/HttpFoundation/CHANGELOG.md

src/Symfony/Component/HttpFoundation/InputBag.php

UPGRADE-6.3.md

src/Symfony/Component/HttpFoundation/ParameterBag.php

src/Symfony/Component/HttpFoundation/InputBag.php

UPGRADE-6.3.md

src/Symfony/Component/HttpFoundation/CHANGELOG.md

src/Symfony/Component/HttpFoundation/InputBag.php

GromNaN · Dec 22, 2022

I don't really like the extra argument to handle the BC layer because it means we're going to have to deprecate it in 7.1 + remove it in 8.0. Looks like a costly change. But I don't have a better idea other than just changing the behavior on 6.3 without this layer...

I'll take care of this process 😃.

But I am also tempted to change the behavior directly in 6.3. The modification to keep the current behavior is to replace $parameters->getInt('page') by (int) $parameters->get('page'). This change in user code is compatible with all previous version of Symfony and could be applied as a bugfix in all existing codebase that want to fallback to 0 in case of invalid value.

UPGRADE-6.3.md

src/Symfony/Component/HttpFoundation/CHANGELOG.md

src/Symfony/Component/HttpFoundation/ParameterBag.php

GromNaN · Mar 16, 2023

or better: we (plan to) throw unless FILTER_NULL_ON_FAILURE is explicitly set, and we drop the error_on_failure option

This is a brilliant idea, let me explain it for the readers.
Historically, filter_var returns false in case of invalid data. But this is a design problem because you can't tell a false from FILTER_VALIDATE_BOOLEAN from a false from an invalid value. So FILTER_NULL_ON_FAILURE was introduced in PHP 5.2 to allow differentiating errors. So we should always use this flag.
We will use the absence of this flag to define our default behavior in Symfony 7.0: throw an exception in case of invalid data.

src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php

…ing invalid values

nicolas-grekas

(I improved the deprecation message)

src/Symfony/Component/HttpFoundation/InputBag.php

fabpot · Mar 19, 2023

Thank you @GromNaN.

… behaviors (GromNaN) This PR was squashed before being merged into the 7.0 branch. Discussion ---------- [HttpFoundation] Remove deprecated classes, method and behaviors | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | n/a Clean `symfony/http-foundation` from all its legacy. - Remove `RequestMatcher` and `ExpressionRequestMatcher`, deprecated since #47595 - Remove `Request::getContentType()`, deprecated since #45034 - Throw a `UnexpectedValueException` or `BadRequestException` when `ParameterBag::filter()` or `InputBag::filter()` reads an invalid value and the flag `FILTER_NULL_ON_FAILURE` is not set. new behavior announced since #48525 - Throw a `InvalidArgumentException` when calling `Request::create()` with a malformed URI, deprecated since #49376 Commits ------- 665a775 [HttpFoundation] Remove deprecated classes, method and behaviors

GromNaN added Feature HttpFoundation labels Dec 6, 2022

carsonbot added Status: Needs Review Deprecation labels Dec 6, 2022

carsonbot changed the title ~~[HttpFoundation] Add ParameterBag::getString and replace getInt with getInteger~~ [HttpFoundation] Add ParameterBag::getString and replace getInt with getInteger Dec 6, 2022

carsonbot added this to the 6.3 milestone Dec 6, 2022

GromNaN commented Dec 6, 2022

View reviewed changes

src/Symfony/Component/HttpFoundation/InputBag.php Show resolved Hide resolved

src/Symfony/Component/HttpFoundation/ParameterBag.php Show resolved Hide resolved

src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php Outdated Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch from b65b7fc to ce6910d Compare December 6, 2022 23:52

ro0NL reviewed Dec 7, 2022

View reviewed changes

src/Symfony/Component/HttpFoundation/ParameterBag.php Outdated Show resolved Hide resolved

alamirault reviewed Dec 7, 2022

View reviewed changes

src/Symfony/Component/HttpFoundation/CHANGELOG.md Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch 2 times, most recently from 0446360 to 231f96c Compare December 9, 2022 15:38

GromNaN changed the title ~~[HttpFoundation] Add ParameterBag::getString and replace getInt with getInteger~~ [HttpFoundation] Add ParameterBag::getString and add 3rd argument to make getInt more strict Dec 9, 2022

GromNaN force-pushed the parameter-bag-get-string branch 2 times, most recently from 880f74d to 9717f40 Compare December 9, 2022 16:36

alamirault reviewed Dec 10, 2022

View reviewed changes

src/Symfony/Component/HttpFoundation/InputBag.php Outdated Show resolved Hide resolved

UPGRADE-6.3.md Outdated Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch 2 times, most recently from 522a590 to b5c7ee3 Compare December 14, 2022 21:56

nicolas-grekas reviewed Dec 15, 2022

View reviewed changes

Seldaek mentioned this pull request Dec 15, 2022

[HttpFoundation] Add method getString to ParameterBag #44787

Closed

Growiel reviewed Dec 15, 2022

View reviewed changes

src/Symfony/Component/HttpFoundation/InputBag.php Outdated Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch 2 times, most recently from 910e200 to 166e0ad Compare December 15, 2022 19:40

GromNaN requested review from nicolas-grekas, ro0NL and fabpot and removed request for ro0NL December 15, 2022 19:40

This comment was marked as outdated.

Sign in to view

GromNaN force-pushed the parameter-bag-get-string branch from 166e0ad to 8862249 Compare December 23, 2022 19:04

nicolas-grekas reviewed Mar 16, 2023

View reviewed changes

UPGRADE-6.3.md Outdated Show resolved Hide resolved

nicolas-grekas reviewed Mar 16, 2023

View reviewed changes

UPGRADE-6.3.md Show resolved Hide resolved

nicolas-grekas reviewed Mar 16, 2023

View reviewed changes

src/Symfony/Component/HttpFoundation/CHANGELOG.md Outdated Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch 2 times, most recently from c5b893e to bb1bf04 Compare March 16, 2023 15:05

nicolas-grekas reviewed Mar 16, 2023

View reviewed changes

src/Symfony/Component/HttpFoundation/ParameterBag.php Outdated Show resolved Hide resolved

GromNaN force-pushed the parameter-bag-get-string branch from ccea2a3 to 70261b3 Compare March 16, 2023 16:39

GromNaN commented Mar 16, 2023

View reviewed changes

src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php Outdated Show resolved Hide resolved

nicolas-grekas changed the title ~~[HttpFoundation] Add ParameterBag::getString and add 3rd argument to make getInt more strict~~ [HttpFoundation] Add ParameterBag::getString() and deprecate accepting invalid values Mar 16, 2023

nicolas-grekas force-pushed the parameter-bag-get-string branch 2 times, most recently from ce97141 to 2fff7e5 Compare March 17, 2023 09:51

[HttpFoundation] Add ParameterBag::getString() and deprecate accept…

172f0a7

…ing invalid values

nicolas-grekas force-pushed the parameter-bag-get-string branch from 2fff7e5 to 172f0a7 Compare March 17, 2023 10:04

nicolas-grekas approved these changes Mar 17, 2023

View reviewed changes

src/Symfony/Component/HttpFoundation/InputBag.php Outdated Show resolved Hide resolved

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 17, 2023

nicolas-grekas added the Ready label Mar 17, 2023

fabpot approved these changes Mar 19, 2023

View reviewed changes

src/Symfony/Component/HttpFoundation/InputBag.php Show resolved Hide resolved

fabpot mentioned this pull request Mar 19, 2023

[HttpFoundation] Add ParameterBag::getString() and deprecate acceptin… symfony/symfony-docs#18089

Closed

fabpot merged commit 6adba59 into symfony:6.3 Mar 19, 2023

GromNaN deleted the parameter-bag-get-string branch March 20, 2023 07:51

nicolas-grekas mentioned this pull request Mar 20, 2023

[HttpKernel] Add #[MapQueryParameter] to map and validate individual query parameters to controller arguments #49134

Merged

This was referenced Apr 12, 2023

[HttpFoundation] Adds various return-typed getters to ParameterBag #49972

Closed

Add various return-typed getters to ParameterBag #45775

Closed

blankse mentioned this pull request Jun 27, 2023

Service::copyAsChild() - $language param should be a string or null pimcore/admin-ui-classic-bundle#143

Merged

GromNaN mentioned this pull request Jun 29, 2023

[HttpFoundation] Remove deprecated classes, method and behaviors #50826

Merged

VincentLanglet mentioned this pull request Jul 31, 2023

Prefer BadRequestException over native exception in ParameterBag #51196

Closed

Search code, repositories, users, issues, pull requests...

Uh oh!

[HttpFoundation] Add ParameterBag::getString() and deprecate accepting invalid values #48525

[HttpFoundation] Add ParameterBag::getString() and deprecate accepting invalid values #48525

Uh oh!

Conversation

GromNaN commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

GromNaN commented Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN commented Mar 16, 2023

Uh oh!

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fabpot commented Mar 19, 2023

Uh oh!

Uh oh!

[HttpFoundation] Add `ParameterBag::getString()` and deprecate accepting invalid values #48525

[HttpFoundation] Add `ParameterBag::getString()` and deprecate accepting invalid values #48525

GromNaN commented Dec 6, 2022 •

edited

Loading

GromNaN commented Dec 22, 2022 •

edited

Loading