[HttpFoundation] Add Request::toArray() for JSON content #38224

Nyholm · 2020-09-17T14:50:52Z

Q	A
Branch?	master
Bug fix?	ni
New feature?	yes
Deprecations?	no
Tickets
License	MIT
Doc PR

The past few months I've been working more and more with javascript and APIs. I've written controllers that parse json from the request body. I've found myself copying code between projects so I looked at the possibility to add this code to the Request class itself.

Usage

POST /add-user
Content-Type: application/json

{"name": "Tobias", "email": "[email protected]"}

use Symfony\Component\HttpFoundation\Exception\JsonException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;

class MyController
    // ...
    public function addUser(Request $request): JsonResponse
    {
        try {
            $data = $request->toArray();
        } catch (JsonException $e) {
            return new JsonResponse(['message'=>'Request does not contain valid json'], 415);
        }
        
        $command = new AddUser($data['email'] ?? '', $data['name'] ?? '');
        
        try {
            $this->commandBus->dispatch($command);
        } catch (ValidationFailedException $e) {
            return new JsonResponse(['message' => 'Unexpected JSON body'], 400);
        }
        
        return new JsonResponse(['message' => 'User successfully added']);
    }
}

I've searched but I have not found that this has been proposed before.. With is strange.. ¯\(ツ)/¯

src/Symfony/Component/HttpFoundation/Request.php

src/Symfony/Component/HttpFoundation/Exception/JsonException.php

ro0NL · 2020-09-17T16:28:00Z

what about using an InputBag for return? That way we're effectively decoding the request body (payload) as done when using $request->request .. but lazy.

Which raises another question, can we provide decoded payload from $request->request in a lazy way? The door was opened with #37327, and then a bit closed with #37265 :)

ro0NL · 2020-09-17T16:38:22Z

e.g. InputBag::fromString holding the string itself, then lazy decode it.

if ($_POST) {
   $this->request = new InputBag($_POST);
} elseif($this->getContent()) {
  $this->request = InputBag::fromString($this->getContent()[, $contentType]);
}

ro0NL · 2020-09-17T16:40:44Z

really, we get HTTP 400 for free this way :)

lyrixx · 2020-09-17T21:58:52Z

I don't have so much to say about the implementation but I have the same use case. I added a trait in my application to solve this issue, but having something native / in core would be really nice.

Nyholm · 2020-09-18T06:47:19Z

Thank you for the reviews and feedback.

That way we're effectively decoding the request body (payload) as done when using $request->request .. but lazy.

@ro0NL Im not sure what you mean. How is it lazy and what is the benefit?

Note that there is technically a difference between $_POST and the request body. For once, a HTTP GET request can have a body that wont be parsed into the $_POST super global.

ro0NL · 2020-09-18T08:00:20Z

AFAIK the $_POST vars are obtained from the request content. So this is about providing consistent access, to a decoded request body, using $request->request->get('key').

The lazy part is about decoding JSON only when needed ;)

If $_POST is filled, i think we can assume it always supersedes.

src/Symfony/Component/HttpFoundation/Request.php

yceruto · 2020-09-19T12:28:17Z

Tests failures seems related though https://ci.appveyor.com/project/fabpot/symfony/builds/35272847#L1155.

1) Symfony\Component\HttpFoundation\Tests\RequestTest::testToArrayNonJson
Failed asserting that exception message 'Syntax error' contains 'Could not decode request body.'.

src/Symfony/Component/HttpFoundation/Request.php

OskarStark

The PR header still uses getContentArray() in the example code, can you please rework this to match toArray() ? Thanks

Nyholm · 2020-09-20T08:33:00Z

Oops, Sorry.

The code example in the PR header is updated.

OskarStark · 2020-09-20T18:21:43Z

Thank you! 🙏

nicolas-grekas · 2020-10-01T16:49:56Z

(rebase needed)

Nyholm · 2020-10-01T19:12:39Z

Thank you for the ping. The PR is rebased

lyrixx

👍🏼

fabpot · 2020-10-03T06:14:07Z

Thank you @Nyholm.

Nyholm · 2020-10-03T07:58:15Z

Thank you for merging

This PR was merged into the master branch. Discussion ---------- Adding docs about Request::toArray() This will fix #14323. The related PR is found here: symfony/symfony#38224 Commits ------- fd03b5e Adding docs about Request::toArray()

…Campbell) This PR was merged into the 5.2-dev branch. Discussion ---------- Remove array return type from Request::toArray() | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #38400 | License | MIT | Doc PR | - Laravel already extends Symfony's `Request` class and defines it's own `toArray` method. #38224 added a new `toArray` method to this class with a different signature to the one that is in Laravel, causing fatal errors (laravel/framework#34660). I think the best course of action here is to remove the return type for now, and only add it in Symfony 6. This will allow Symfony 6.0 and Laravel 11 to synchronize adding the return type. Older versions of Laravel can't just change their signature to add an array return type to them, because that would be a breaking change for Laravel users extending Laravel's request class. I'm thinking, in particular, API packages and the like, or just straight up application code. Commits ------- 8b291a4 Remove array return type from Request::toArray()

carsonbot added Status: Needs Review HttpFoundation Feature labels Sep 17, 2020

noniagriconomie reviewed Sep 17, 2020

View reviewed changes

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

src/Symfony/Component/HttpFoundation/Exception/JsonException.php Outdated Show resolved Hide resolved

Nyholm force-pushed the get-content-array branch from cdf866d to cf4ed5a Compare September 18, 2020 06:36

Nyholm force-pushed the get-content-array branch from cf4ed5a to bc52f2d Compare September 18, 2020 06:48

Nyholm changed the title ~~[HttpFoundation] Add Request::getContentArray()~~ [HttpFoundation] Add Request::toArray() for JSON content Sep 18, 2020

Nyholm force-pushed the get-content-array branch from e6ae8c8 to 899ef81 Compare September 18, 2020 06:55

nicolas-grekas added this to the next milestone Sep 18, 2020

michaljusiega reviewed Sep 19, 2020

View reviewed changes

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

yceruto approved these changes Sep 19, 2020

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 19, 2020

yceruto reviewed Sep 19, 2020

View reviewed changes

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

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

OskarStark reviewed Sep 20, 2020

View reviewed changes

nicolas-grekas approved these changes Sep 24, 2020

View reviewed changes

Nyholm force-pushed the get-content-array branch from 9881df2 to 1a24974 Compare October 1, 2020 19:12

lyrixx approved these changes Oct 2, 2020

View reviewed changes

fabpot approved these changes Oct 3, 2020

View reviewed changes

[HttpFoundation] Add Request::toArray() for JSON content

83c1a26

fabpot force-pushed the get-content-array branch from 1a24974 to 83c1a26 Compare October 3, 2020 06:14

fabpot mentioned this pull request Oct 3, 2020

[HttpFoundation] Add Request::toArray() for JSON content symfony/symfony-docs#14323

Closed

fabpot merged commit f589ff4 into symfony:master Oct 3, 2020

Nyholm deleted the get-content-array branch October 3, 2020 07:58

Nyholm mentioned this pull request Oct 3, 2020

Adding docs about Request::toArray() symfony/symfony-docs#14325

Merged

GrahamCampbell mentioned this pull request Oct 3, 2020

Remove array return type from Request::toArray() #38403

Merged

nicolas-grekas modified the milestones: next, 5.2 Oct 5, 2020

fabpot mentioned this pull request Oct 5, 2020

Release v5.2.0-BETA1 #38417

Merged

derrabus mentioned this pull request Oct 14, 2020

[FrameworkBundle] Deserialize json in AbstractController #38572

Closed

ro0NL mentioned this pull request Oct 16, 2020

Types of request param in KernelBrowser are now string instead of integer #38591

Closed

vhenzl mentioned this pull request Aug 22, 2021

InputBag::get() should be smarter phpstan/phpstan-symfony#177

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HttpFoundation] Add Request::toArray() for JSON content #38224

[HttpFoundation] Add Request::toArray() for JSON content #38224

Nyholm commented Sep 17, 2020 •

edited

Loading

ro0NL commented Sep 17, 2020

ro0NL commented Sep 17, 2020 •

edited

Loading

ro0NL commented Sep 17, 2020

lyrixx commented Sep 17, 2020

Nyholm commented Sep 18, 2020

ro0NL commented Sep 18, 2020

yceruto commented Sep 19, 2020 •

edited

Loading

OskarStark left a comment

Nyholm commented Sep 20, 2020

OskarStark commented Sep 20, 2020

nicolas-grekas commented Oct 1, 2020

Nyholm commented Oct 1, 2020

lyrixx left a comment

fabpot commented Oct 3, 2020

Nyholm commented Oct 3, 2020

[HttpFoundation] Add Request::toArray() for JSON content #38224

[HttpFoundation] Add Request::toArray() for JSON content #38224

Conversation

Nyholm commented Sep 17, 2020 • edited Loading

Usage

ro0NL commented Sep 17, 2020

ro0NL commented Sep 17, 2020 • edited Loading

ro0NL commented Sep 17, 2020

lyrixx commented Sep 17, 2020

Nyholm commented Sep 18, 2020

ro0NL commented Sep 18, 2020

yceruto commented Sep 19, 2020 • edited Loading

OskarStark left a comment

Choose a reason for hiding this comment

Nyholm commented Sep 20, 2020

OskarStark commented Sep 20, 2020

nicolas-grekas commented Oct 1, 2020

Nyholm commented Oct 1, 2020

lyrixx left a comment

Choose a reason for hiding this comment

fabpot commented Oct 3, 2020

Nyholm commented Oct 3, 2020

Nyholm commented Sep 17, 2020 •

edited

Loading

ro0NL commented Sep 17, 2020 •

edited

Loading

yceruto commented Sep 19, 2020 •

edited

Loading