Skip to content

[HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs #61208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 15 commits into
base: 7.4
Choose a base branch
from
Open

[HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs #61208

wants to merge 15 commits into from
+164 −0

Conversation

abdellahrk
Copy link

@abdellahrk abdellahrk commented Jul 22, 2025 •
edited by OskarStark
Loading

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 carsonbot added this to the 7.4 milestone Jul 22, 2025
@carsonbot
Copy link

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

@abdellahrk abdellahrk force-pushed the feature/problem_detail_response branch from 2bbb577 to 7cecc40 Compare July 22, 2025 22:01
smnandre
smnandre reviewed Jul 23, 2025
View reviewed changes
smnandre
smnandre reviewed Jul 23, 2025
View reviewed changes
smnandre
smnandre reviewed Jul 23, 2025
View reviewed changes
@abdellahrk
Copy link
Author

Thank you very much @smnandre

@abdellahrk abdellahrk requested a review from smnandre July 23, 2025 07:14
@abdellahrk
Copy link
Author

Thank you @OskarStark

@OskarStark OskarStark changed the title [HttpFoundation] Add Problem Details for HTTP APIs [HttpFoundation] Add ProblemDetailJsonResponse for HTTP APIs Jul 24, 2025
OskarStark
OskarStark reviewed Jul 24, 2025
View reviewed changes
@OskarStark OskarStark changed the title [HttpFoundation] Add ProblemDetailJsonResponse for HTTP APIs [HttpFoundation] Add ProblemDetailsJsonResponse for HTTP APIs Jul 24, 2025
OskarStark
OskarStark reviewed Jul 24, 2025
View reviewed changes
@abdellahrk abdellahrk force-pushed the feature/problem_detail_response branch from 8befed4 to a51dabd Compare July 24, 2025 18:48
@mahono
Copy link

mahono commented Jul 29, 2025

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

@abdellahrk
Copy link
Author

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
image

@mahono
Copy link

mahono commented Jul 31, 2025

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

nicolas-grekas
nicolas-grekas reviewed Jul 31, 2025
View reviewed changes
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@abdellahrk abdellahrk force-pushed the feature/problem_detail_response branch from 49d5149 to 03299c5 Compare July 31, 2025 17:46
nicolas-grekas
nicolas-grekas reviewed Aug 1, 2025
View reviewed changes
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry I may miss a lot, so here are quick questions to help me understand

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php Outdated
class ProblemDetailsJsonResponse extends Response
{
public function __construct(
private ?int $status = null,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about making this not nullable and default to 500?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh thank you @nicolas-grekas.
I seriously have to do this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the RFC does not specify a default status code. I just think it'll be wise to have a default and I don't know if 500 is okay.

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php Outdated
Comment on lines 40 to 41
if ($this->title && null === $this->type) {
$this->title = Response::$statusTexts[$this->status];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks strange to me to override the title if it's already set before

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the problem type is not specified, the status code text is used as the title

When "about:blank" is used, the title SHOULD be the same as the recommended HTTP status phrase for that code (e.g., "Not Found" for 404, and so on), although it MAY be localized to suit client preferences (expressed with the Accept-Language request header)

Per the RFC

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php Outdated
$this->title = Response::$statusTexts[$this->status];
}

if (null === $this->title && null === $this->detail) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the check about details?

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php Outdated

$problemDetails = [
'type' => $this->type ?? 'about:blank',
'title' => $this->title ?? Response::$statusTexts[$this->statusCode] ?? 'Unknown Error',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why didn't we do $this->title ??= Response::$statusTexts[$this->statusCode] ?? 'Unknown Error' earlier?

src/Symfony/Component/HttpFoundation/ProblemDetailsJsonResponse.php Outdated
private readonly ?string $type = null,
private readonly ?string $detail = null,
private readonly ?string $instance = null,
private readonly ?array $extensions = [],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need to have all these properties if we never access them after the constructor?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicolas-grekas any recommended way to handle them? We are using these properties in the constructor.
Is the problem their visibility?
Thank you for the guidance.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If they're not used after construct then they can be regular parameters

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @chalasr

@abdellahrk
[HttpFoundation] Add Problem Details for HTTP APIs
799b080 
This feature adds more detail to the HTTP response errors as specified by RFC 7807 and completed by RFC 9457
@abdellahrk
Fix typos and correct formatting
118662b
abdellahrk and others added 12 commits August 1, 2025 19:08
@abdellahrk
Fix format
b551944
@abdellahrk @smnandre
Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…
00b5757 
….php

Co-authored-by: Simon André <smn.andre@gmail.com>
@abdellahrk @smnandre
Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…
30d294e 
….php

Co-authored-by: Simon André <smn.andre@gmail.com>
@abdellahrk
Update ProblemDetailJsonResponse.php
e6e0fe1
@abdellahrk @OskarStark
Update src/Symfony/Component/HttpFoundation/Exception/ProblemDetailJs…
a09e7a8 
…onResponseException.php

Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
@abdellahrk @OskarStark
Update src/Symfony/Component/HttpFoundation/ProblemDetailJsonResponse…
95227d4 
….php

Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
@abdellahrk @OskarStark
Update src/Symfony/Component/HttpFoundation/CHANGELOG.md
20d3703 
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
@abdellahrk
Rename ProblemDetail to ProblemDetails
b4b37c6
@abdellahrk
Refactor base on maintainers' comments
4fa08cd
@abdellahrk
fix style issues
65a8082
@abdellahrk
Refactors from static analysis result
ea0d4a8
@abdellahrk
Refactor: refactor of title setting, set default type per RFC
3f25fa6
@abdellahrk abdellahrk force-pushed the feature/problem_detail_response branch from 4c366c3 to 3f25fa6 Compare August 1, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas left review comments

@OskarStark OskarStark OskarStark left review comments

@chalasr chalasr chalasr left review comments

@smnandre smnandre Awaiting requested review from smnandre

Assignees
No one assigned
Labels
Feature HttpFoundation Status: Needs Review
Projects
None yet
Milestone
7.4
Development

Successfully merging this pull request may close these issues.
7 participants
@abdellahrk @carsonbot @mahono @nicolas-grekas @OskarStark @smnandre @chalasr
pFad - Phonifier reborn

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

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy