[HttpFoundation] Add `ProblemDetailsJsonResponse` for HTTP APIs #61208

abdellahrk · 2025-07-22T20:53:56Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	no
License	MIT

This PR introduces the ProblemDetailJsonResponse which is an implementation of RFC 9457 to describe the specifics of a problem encountered:

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit.",
  "detail": "Your current balance is 30, but that costs 50.",
  "instance": "/account/12345/msgs/abc",
  "balance": 30,
  "accounts": ["/account/12345", "/account/67890"]
}

carsonbot · 2025-07-22T20:54:02Z

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (see https://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
Features and deprecations must be submitted against the 7.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse.php

abdellahrk · 2025-07-23T06:05:38Z

Thank you very much @smnandre

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

src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse.php

abdellahrk · 2025-07-24T13:44:53Z

Thank you @OskarStark

src/Symfony/Component/HttpFoundation/CHANGELOG.md

src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse.php

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

src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse.php

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

This feature adds more detail to the HTTP response errors as specified by RFC 7807 and completed by RFC 9457

….php Co-authored-by: Simon André <smn.andre@gmail.com>

…onResponseException.php Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

….php Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

mahono · 2025-07-29T05:45:39Z

The RFC also supports “errors”. Would it make sense to also support these in the class?

abdellahrk · 2025-07-29T08:31:40Z

The RFC also supports “errors”. Would it make sense to also support these in the class?

@mahono sure. The "errors" can be added as an extension as indicated here

This is an example with the errors extension

mahono · 2025-07-31T11:56:02Z

Great. I missed that one because I was only scanning for „error“.

OskarStark · 2025-07-31T12:33:19Z

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

+/**
+ * @author Abdellah Ramadan <ramadanabdel24@gmail.com>
+ */
+class ProblemDetailsJsonResponseException extends \Exception


Can we be more specific for the class we extend?

Okay @OskarStark.
As a first timer, I am still trying to get things right. Should I get rid of the entire exception class?

OskarStark · 2025-07-31T12:34:07Z

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php

+     * @throws ProblemDetailsJsonResponseException
+     * @throws \JsonException
+     */
+    protected function setProblemContent(): string


any reason to not make it private?

No reason. I can make it private.

OskarStark · 2025-07-31T12:34:20Z

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

+    public function testNewProblemWithNoParams()
+    {
+        $problemDetails = new ProblemDetailsJsonResponse();
+        $this->assertEquals(520, $problemDetails->getStatusCode());


assertSame wherever possible please

nicolas-grekas

I feel like everything should be in the constructor, or, if we split in methods, computed lazily (but not sure that'd be useful here)

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

nicolas-grekas · 2025-07-31T12:35:00Z

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php

+        $this->setProblemContent();
+    }
+
+    private function setHeaders(): void


we should get rid of those unusual private setters IMHO

Okay @nicolas-grekas.
I am doing that then.

nicolas-grekas · 2025-07-31T12:35:37Z

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php

+     * @throws ProblemDetailsJsonResponseException
+     * @throws \JsonException
+     */
+    protected function setProblemContent(): string


protected means this is an extension point. I don't think that's legit.

Should it be made private?
Sorry for being silly on this one. Still trying to get everything right.

…esponseTest.php Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

carsonbot added Status: Needs Review Feature HttpFoundation labels Jul 22, 2025

carsonbot added this to the 7.4 milestone Jul 22, 2025

abdellahrk force-pushed the feature/problem_detail_response branch from 2bbb577 to 7cecc40 Compare July 22, 2025 22:01

smnandre reviewed Jul 23, 2025

View reviewed changes

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

smnandre reviewed Jul 23, 2025

View reviewed changes

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

smnandre reviewed Jul 23, 2025

View reviewed changes

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

abdellahrk requested a review from smnandre July 23, 2025 07:14

OskarStark reviewed Jul 24, 2025

View reviewed changes

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

OskarStark reviewed Jul 24, 2025

View reviewed changes

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

OskarStark changed the title ~~[HttpFoundation] Add Problem Details for HTTP APIs~~ [HttpFoundation] Add ProblemDetailJsonResponse for HTTP APIs Jul 24, 2025

OskarStark reviewed Jul 24, 2025

View reviewed changes

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

OskarStark changed the title ~~[HttpFoundation] Add ProblemDetailJsonResponse for HTTP APIs~~ [HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs Jul 24, 2025

OskarStark reviewed Jul 24, 2025

View reviewed changes

abdellahrk and others added 10 commits July 24, 2025 19:47

[HttpFoundation] Add Problem Details for HTTP APIs

31844e7

This feature adds more detail to the HTTP response errors as specified by RFC 7807 and completed by RFC 9457

Fix typos and correct formatting

73d00ce

Fix format

53337d0

Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…

9cfd308

….php Co-authored-by: Simon André <smn.andre@gmail.com>

Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…

d41f18e

….php Co-authored-by: Simon André <smn.andre@gmail.com>

Update ProblemDetailJsonResponse.php

a82447f

Update src/Symfony/Component/HttpFoundation/Exception/ProblemDetailJs…

ab0699c

…onResponseException.php Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…

c64d664

….php Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

Update src/Symfony/Component/HttpFoundation/CHANGELOG.md

0963c3e

Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

Rename ProblemDetail to ProblemDetails

a51dabd

abdellahrk force-pushed the feature/problem_detail_response branch from 8befed4 to a51dabd Compare July 24, 2025 18:48

OskarStark reviewed Jul 31, 2025

View reviewed changes

nicolas-grekas reviewed Jul 31, 2025

View reviewed changes

Update src/Symfony/Component/HttpFoundation/Tests/ProblemDetailsJsonR…

49d5149

…esponseTest.php Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

Uh oh!

[HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs #61208

Are you sure you want to change the base?

[HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs #61208

Conversation

abdellahrk commented Jul 22, 2025 • edited by OskarStark Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carsonbot commented Jul 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abdellahrk commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

abdellahrk commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mahono commented Jul 29, 2025

Uh oh!

abdellahrk commented Jul 29, 2025

Uh oh!

mahono commented Jul 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abdellahrk Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

[HttpFoundation] Add `ProblemDetailsJsonResponse` for HTTP APIs #61208

[HttpFoundation] Add `ProblemDetailsJsonResponse` for HTTP APIs #61208

abdellahrk commented Jul 22, 2025 •

edited by OskarStark

Loading

abdellahrk Jul 31, 2025 •

edited

Loading