Create MissingExactTemplate exception with separate template #29286

vinistock · 2017-05-30T14:20:53Z

This PR is supposed to address issue #29280.

Create new exception class MissingExactTemplate with it's own HTML template and raise it in the implicit_render class.

This is my first contribution, so please let me know if I'm missing something or if I'm breaking any code style standards.

rails-bot · 2017-05-30T14:21:07Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @schneems (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

matthewd

This is looking about the right shape 👍🏻

Still need this bit:

Turn the long exception message into a custom HTML template

matthewd · 2017-05-30T15:34:19Z

actionpack/lib/action_controller/metal/exceptions.rb

Inherit from UnknownFormat, so the new exception is still rescued by anything that currently matches it

vinistock · 2017-05-30T16:47:23Z

@matthewd Thanks for reviewing the PR. I addressed your comment about the inheritance and fixed the respective tests.

Although I must say I don't quite understand the bit about turning the message into an html template. Is the entire message moving to a template? Will the exception not use it for instantiation anymore? Sorry, not really sure what is expected on this portion.

kaspth · 2017-05-30T19:03:14Z

@vinistock try triggering the exception in a newly generated Rails 5.1 app. Notice how the exception is just blurted out as one big chunk of text? We want to do better.

We want the custom template to communicate what the exception means better than what the one paragraph exception message can do. To "show" rather than "tell".

The existing exception message can be a spring board, but you can almost do with it as you please, it's not required for instantiation anymore (that's not fully true, but lets get the template going first then we can hone details).

vinistock · 2017-06-01T17:01:55Z

@kaspth I've customized the template a bit and changed the message. I also added what the expected path for the template would be, I thought that would make the exception cause more obvious to the user.

Let me know if this is aligned with the expectations and if the exception messages / explanations are as descriptive and concise as they should be.

The layout remains similar to the majority of Rails error pages. If any changes concerning this are wanted, give me a heads up.

matthewd

Sorry, I spectacularly dropped the ball on this 😟

I've added a few small notes, but this seems to be just about good to go. I haven't yet actually caused the error locally to see the resulting page, but the HTML sounds good! (If you happen to have it open locally and can add a screenshot, that'd be awesome; if not, that's fine too.)

Sorry again I left this unanswered for so long!

matthewd · 2018-02-01T16:02:52Z

actionpack/lib/action_controller/metal/implicit_render.rb

This is an interesting idea, but making a more accurate guess is a lot harder than this, so I think it's best to leave it off for now. (Notably, it has checked a lot more than one filename.)

matthewd · 2018-02-01T16:04:46Z

actionpack/lib/action_dispatch/middleware/exception_wrapper.rb

Let's add a trailing comma, so this line doesn't have to change next time we add an entry.

Also, I think we need to add our new exception to rescue_responses above as well (pointing to :not_acceptable, same as the existing UnknownFormat)

matthewd · 2018-02-01T16:07:20Z

actionpack/lib/action_dispatch/middleware/templates/rescues/missing_exact_template.html.erb

"exact" sounds a bit odd in a user-facing context here. How about we title it "No template for interactive request"?

vinistock · 2018-02-09T17:21:51Z

@matthewd I've addressed your comments and rebased with the current master. Let me know if any other changes are needed.

Here's the screenshot of a sample application raising the error.

rafaelfranca · 2018-04-12T23:34:24Z

actionpack/lib/action_controller/metal/exceptions.rb

Any reason why we need to define an initialize?

rafaelfranca · 2018-04-12T23:35:07Z

actionpack/lib/action_controller/metal/implicit_render.rb

can't we can keep the raise ActionController::MissingExactTemplate, message pattern here?

rafaelfranca · 2018-04-12T23:37:31Z

actionpack/lib/action_dispatch/middleware/exception_wrapper.rb

can we align all other values or maybe a next PR un-align all the values?

rafaelfranca · 2018-04-12T23:41:40Z

actionpack/lib/action_dispatch/middleware/templates/rescues/missing_exact_template.html.erb

Not sure if the source and the trace is going to be useful for this exception. The source is always inside Rails. I'd also remove the request_and_response. This page is more informative than actually an application error.

vinistock · 2018-04-13T13:55:36Z

@rafaelfranca Thanks for the review. I believe all your comments make sense and applied all the requested changes. Let me know if there's anything else to be done.

rafaelfranca

This looks good to me. Can you squash your commits?

vinistock · 2018-04-20T14:03:47Z

@rafaelfranca all done.

…e_exception Create MissingExactTemplate exception with separate template

Changes the Getting Started guide explanation for `ActionController::MissingExactTemplate` error, to reflect the current message. Follow up for rails#29286, rails#35148 [ci skip]

rails-bot assigned schneems May 30, 2017

matthewd reviewed May 30, 2017

View reviewed changes

maclover7 added actionpack needs work labels May 30, 2017

vinistock force-pushed the create_missing_exact_template_exception branch from 0b3944c to e069e26 Compare June 5, 2017 14:06

matthewd reviewed Feb 1, 2018

View reviewed changes

vinistock force-pushed the create_missing_exact_template_exception branch from 4c6c334 to 76d79e7 Compare February 9, 2018 16:32

rafaelfranca mentioned this pull request Apr 12, 2018

Reformat implicit render exception #30529

Closed

rafaelfranca reviewed Apr 12, 2018

View reviewed changes

rafaelfranca reviewed Apr 20, 2018

View reviewed changes

Create MissingExactTemplate exception with separate template

297a579

vinistock force-pushed the create_missing_exact_template_exception branch from e4c7954 to 297a579 Compare April 20, 2018 14:03

rafaelfranca merged commit 297a579 into rails:master Apr 20, 2018

rafaelfranca added a commit that referenced this pull request Apr 20, 2018

Merge pull request #29286 from vinistock/create_missing_exact_templat…

5033e2c

…e_exception Create MissingExactTemplate exception with separate template

utilum mentioned this pull request Feb 4, 2019

Update template missing text in Guide #35149

Merged

vinistock deleted the create_missing_exact_template_exception branch February 5, 2020 00:49

Create MissingExactTemplate exception with separate template #29286

Create MissingExactTemplate exception with separate template #29286

Uh oh!

Conversation

vinistock commented May 30, 2017

Uh oh!

rails-bot commented May 30, 2017

Uh oh!

matthewd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vinistock commented May 30, 2017

Uh oh!

kaspth commented May 30, 2017

Uh oh!

vinistock commented Jun 1, 2017

Uh oh!

matthewd left a comment

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!

vinistock commented Feb 9, 2018

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!

vinistock commented Apr 13, 2018

Uh oh!

rafaelfranca left a comment

Choose a reason for hiding this comment

Uh oh!

vinistock commented Apr 20, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants