Include more information on AlreadySentError errors #6000
Conversation
This file contains 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
Adzz
force-pushed
the
give_more_info_for_not_sent_error
branch
2 times, most recently
from
ad557ca to
ad5174a
Compare
josevalim
reviewed
Dec 21, 2024
lib/phoenix/controller.ex
Outdated
| @@ -642,7 +642,9 @@ defmodule Phoenix.Controller do | |||
| if state in @unsent do | |||
| put_private_layout(conn, :phoenix_layout, :replace, layout) | |||
| else | |||
| raise AlreadySentError | |||
| raise AlreadySentError, """ | |||
| The response was already sent. Request was to `#{conn.request_path}` using #{inspect(layout)}\ | |||
There was a problem hiding this comment.
the request path should be in your logs/error handler anyway. Suggestion is to add information like the status code instead and response information.
There was a problem hiding this comment.
Ah sorry, thanks for the reminder! I have pushed a thing see what you think :)
Adds more information to the AlreadySentError to help make debugging them easier.
Adzz
force-pushed
the
give_more_info_for_not_sent_error
branch
from
ad5174a to
ad5136a
Compare
josevalim
reviewed
Feb 19, 2025
lib/phoenix/controller.ex
Outdated
Comment on lines
592
to
597
| The response was already sent. | ||
|
|
||
| Status code: `#{conn.status}` | ||
| Request path: `#{conn.request_path}` | ||
| Method: `#{conn.method}` | ||
| View module: `#{inspect(module)}` |
There was a problem hiding this comment.
Error messages start in lowercase and I think the backticks would make things harder to read, so I suggest removing them:
Suggested change
| The response was already sent. | |
| Status code: `#{conn.status}` | |
| Request path: `#{conn.request_path}` | |
| Method: `#{conn.method}` | |
| View module: `#{inspect(module)}` | |
| the response was already sent. | |
| Status code: #{conn.status} | |
| Request path: #{conn.request_path} | |
| Method: #{conn.method} | |
| View module: #{inspect(module)} |
Adzz
changed the title
Adzz
force-pushed
the
give_more_info_for_not_sent_error
branch
from
ad51317 to
ad56eef
Compare
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.
We have an app that is getting a lot of AlreadySentErrors. Likely somewhere we have missed an
halt(), but tracking that down is tricky. I wonder if we could supply some more information in the various places the error gets raised to help someone debug the issue? I have supplied a small example, but the exact wording and contents can be discussed.I'm happy to roll this out to more places if we agree it's a good idea.