add starter of custom 404/422/500 routing (#2560)

colinxfleming · lomky · web-flow · commit b5a02e8223b7 · 2022-09-21T00:25:15.000-04:00
* add starter of custom 404/422/500 routing

* proper layout routing

* use btn, stash for now

* don't use a separate layout for errors, add conditionals to app instead

* don't really need this to render pages, it kicks it to errors controller regardless

* don't need these anymore

* re-add csrf - needed for sign out, it turns out

* Update app/views/errors/error_500.html.erb

Co-authored-by: Kat Tipton &lt;kathryn.tipton@gmail.com&gt;

Co-authored-by: Kat Tipton &lt;kathryn.tipton@gmail.com&gt;
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -6,8 +6,8 @@ class ApplicationController < ActionController::Base
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery prepend: true, with: :exception
 
-  prepend_before_action :authenticate_user!
-  prepend_before_action :confirm_user_not_disabled!, unless: :devise_controller?
+  prepend_before_action :authenticate_user!, unless: -> { try(:errors_controller?) }
+  prepend_before_action :confirm_user_not_disabled!, unless: -> { devise_controller? || try(:errors_controller?) }
 
   if Rails.env.development?
     before_action :confirm_tenant_set_development
diff --git a/app/controllers/errors_controller.rb b/app/controllers/errors_controller.rb
@@ -0,0 +1,11 @@
+class ErrorsController < ApplicationController
+  def errors_controller?
+    true
+  end
+
+  def error_404; end
+
+  def error_422; end
+
+  def error_500; end
+end
diff --git a/app/views/errors/error_404.html.erb b/app/views/errors/error_404.html.erb
@@ -0,0 +1,6 @@
+<% content_for :title do %>DARIA - 404<% end %>
+<% content_for :error_page do %>error<% end %>
+
+<h2>Sorry! The page you're looking for doesn't exist. (404)</h2>
+
+<p>This page may have moved, or been removed entirely.</p>
diff --git a/app/views/errors/error_422.html.erb b/app/views/errors/error_422.html.erb
@@ -0,0 +1,6 @@
+<% content_for :title do %>DARIA - 422<% end %>
+<% content_for :error_page do %>error<% end %>
+
+<h2>Sorry! Something went wrong. (422)</h2>
+
+<p>Something about the data looked weird - try adjusting it and give it another shot.</p>
diff --git a/app/views/errors/error_500.html.erb b/app/views/errors/error_500.html.erb
@@ -0,0 +1,6 @@
+<% content_for :title do %>DARIA - 500<% end %>
+<% content_for :error_page do %>error<% end %>
+
+<h2>Sorry! Something went wrong. (500)</h2>
+
+<p>This is probably an us problem - try again later, and have your organization let the Daria maintainers know if it persists.</p>
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
@@ -3,7 +3,7 @@
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
     <title><%= content_for?(:title) ? yield(:title) : "DARIA" %></title>
-    <meta name="description" content="<%= content_for?(:description) ? yield(:description) : "DCAF" %>">
+    <meta name="description" content="<%= content_for?(:description) ? yield(:description) : "DARIA" %>">
     <meta name='ROBOTS' content='NOINDEX, NOFOLLOW'>
     <meta name="google-site-verification" content="<%= ENV['GOOGLE_SITE_VERIFICATION'] %>" />
 
@@ -14,21 +14,33 @@
     <%= stylesheet_link_tag 'application', media: 'all' %>
     
     <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
-    <%= content_for :render_async %>
 
+    <% if !content_for? :error_page %>
+      <%= content_for :render_async %>
+    <% end %>
   </head>
+
   <body>
     <% if current_user.present? %>
       <header>
         <%= render 'layouts/navigation' %>
       </header>
     <% end %>
+
     <main class="container" role="main">
-      <%= render 'layouts/messages' %>
+      <% if !content_for? :error_page %>
+        <%= render 'layouts/messages' %>
+      <% end %>
 
       <br>
       <%= yield %>
 
+      <% if content_for? :error_page %>
+        <p>
+          <%= link_to 'Back to homepage', root_path, class: 'btn btn-primary btn-lg text-white' %>
+        </p>
+      <% end %>
+
       <% if current_user.present? %>
         <footer>
           <%= render 'layouts/footer' %>
diff --git a/config/application.rb b/config/application.rb
@@ -57,5 +57,8 @@ class Application < Rails::Application
     #
     # config.time_zone = "Central Time (US & Canada)"
     # config.eager_load_paths << Rails.root.join("extras")
+
+    # Custom exceptions pages
+    config.exceptions_app = self.routes
   end
 end
diff --git a/config/environments/development.rb b/config/environments/development.rb
@@ -12,7 +12,7 @@
   config.eager_load = false
 
   # Show full error reports.
-  config.consider_all_requests_local = true
+  config.consider_all_requests_local = false
 
   # Enable server timing
   config.server_timing = true
diff --git a/config/routes.rb b/config/routes.rb
@@ -64,4 +64,8 @@
     get '/users/edit' => 'devise/registrations#edit', as: 'edit_user_registration'
     put '/users' => 'devise/registrations#update', as: 'registration'
   end
+
+  match '/404' => 'errors#error_404', via: [:get, :post, :put, :patch]
+  match '/422' => 'errors#error_422', via: [:get, :post, :put, :patch]
+  match '/500' => 'errors#error_500', via: [:get, :post, :put, :patch]
 end
diff --git a/public/404.html b/public/404.html
diff --git a/public/422.html b/public/422.html
diff --git a/public/500.html b/public/500.html

Original file line number	Diff line number	Diff line change
`@@ -57,5 +57,8 @@ class Application < Rails::Application`
`57`	`57`	`#`
`58`	`58`	`# config.time_zone = "Central Time (US & Canada)"`
`59`	`59`	`# config.eager_load_paths << Rails.root.join("extras")`
	`60`	`+`
	`61`	`+ # Custom exceptions pages`
	`62`	`+ config.exceptions_app = self.routes`
`60`	`63`	`end`
`61`	`64`	`end`