Add additional details in HTTP 500 error page message#9762
Merged
ahukkanen merged 16 commits intodecidim:developfrom Sep 2, 2022
Merged
Conversation
ahukkanen
requested changes
Aug 25, 2022
Contributor
ahukkanen
left a comment
There was a problem hiding this comment.
Overall this looks quite good but there are some problems regarding some formatting and also how we lay out the error information on the page and in the text copied to the clipboard.
The HTTP referer information is also incorrect as the "current" URL. And there was some missing information as defined in the original proposal.
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
ahukkanen
requested changes
Aug 31, 2022
Contributor
ahukkanen
left a comment
There was a problem hiding this comment.
Looking good already!
I have just a couple more refinement requests but from functionality perspective it seems great now.
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/spec/services/decidim/log_reference_generator_spec.rb
Outdated
Show resolved
Hide resolved
decidim-core/spec/services/decidim/log_reference_generator_spec.rb
Outdated
Show resolved
Hide resolved
The followings have been changed: - Moved the plain information creatio from view to controller - Moved reference generation to the controller - Remove extra spacing generated by the textarea
The following changed: - Id of the copy link - Unused allows in spec files
ahukkanen
requested changes
Sep 2, 2022
Contributor
ahukkanen
left a comment
There was a problem hiding this comment.
Looking good, just few more cleanups for generating the table.
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
ahukkanen
reviewed
Sep 2, 2022
ahukkanen
reviewed
Sep 2, 2022
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
ahukkanen
requested changes
Sep 2, 2022
Contributor
ahukkanen
left a comment
There was a problem hiding this comment.
Sorry I missed this on the previous review but there is one more layout issue with this.
Please see below.
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
ahukkanen
reviewed
Sep 2, 2022
decidim-core/app/views/decidim/errors/internal_server_error.html.erb
Outdated
Show resolved
Hide resolved
ahukkanen
approved these changes
Sep 2, 2022
eliegaboriau
pushed a commit
to eliegaboriau/decidim
that referenced
this pull request
Oct 25, 2022
* Add detail to the error page * Undo a mistakenly commented out file * Add additional details to the error page and log file * Complete logger feature with testing * Normalize en locale * Fix reviewers' comments * Fix linter error * Apply reviewers' comments The followings have been changed: - Moved the plain information creatio from view to controller - Moved reference generation to the controller - Remove extra spacing generated by the textarea * Fix remaining issues The following changed: - Id of the copy link - Unused allows in spec files * Revert unnecessary chamge of a file to the original state * Move info_hash to the controller * Dynamically generate the info table * Remove extra space in an erb file * Fix copy button in view * Remove unnecessary wrappers from the view * Empty-Commit
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
🎩 What? Why?
Currently when an unexpected situation (i.e. a bug) happens in Decidim, we don't get much details about the situation from the users. We generally have to filter the logs by utilizing the "about" time when the situation happened.
This pull requests add described details here.
After merging to the core, this pull request adds the following details to server error:
Also, users are able to copy all these information by clicking on "copy to clipboard" button, and paste it to their emails:
These information, including the reference can be utilized to track down the cause of error in the log file, should the user report it:
📌 Related Issues
Testing
Tests added to the core tests; No prerequisite is needed