Skip to content

Rambulanceを使って404/500/422ページを整備 #1702

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.

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

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
a39bdf6
Rambulance の導入と初期設定を追加
nacchan99 Jun 10, 2025
a4ce6e1
ErrorsController を新規作成(404/500/422用)
nacchan99 Jun 10, 2025
548d72a
500 Internal Server Error ページを追加
nacchan99 Jun 10, 2025
7c19b40
422 Unprocessable Entity ページを追加
nacchan99 Jun 10, 2025
a456487
エラーページ共通のヘッダー部分をパーシャル化
nacchan99 Jun 10, 2025
44d493b
共通パーシャル追加(フィードバック案内・Twitterタイムライン)※500/422は未確認
nacchan99 Jun 10, 2025
677d005
500/422エラーページの表示も確認済みに変更
nacchan99 Jun 11, 2025
62ad7c3
エラーページ(404/500/422)のリクエストテストを追加
nacchan99 Jun 11, 2025
4b52ff7
ErrorsControllerの不要なコメントを削除
nacchan99 Jun 11, 2025
7e4737c
コメント位置を上に移動して統一
nacchan99 Jun 11, 2025
9dac37e
errors/headerをインライン化し、partialを削除
nacchan99 Jun 11, 2025
c0d871a
errors/feedback_noticeをインライン化し、partialを削除
nacchan99 Jun 12, 2025
092c3dd
共通文言の表示確認テストをrequestspecに追加
nacchan99 Jun 12, 2025
8e7f468
refactor: 404・500・422 エラーページのルーティングを一元化
nacchan99 Jun 16, 2025
0103961
refactor: ErrorsController を show アクションに集約し旧アクションを削除
nacchan99 Jun 16, 2025
21dbe7b
refactor: エラーページのshow.htmlを新規作成しfooter_links_and_timelineパーシャルをインライン化
nacchan99 Jun 16, 2025
ee6d1de
refactor:不要になった旧エラービューとfooterパーシャルを削除
nacchan99 Jun 16, 2025
4e8612b
refactor:重複したroutes.drawブロックを削除しエラールーティングを昇順(404→422→500)に変更
nacchan99 Jun 16, 2025
2222744
refactor:application.rbからexceptions_app設定を削除しproduction/test環境へ移行
nacchan99 Jun 16, 2025
22c107b
feat: 開発/テスト環境向けのエラー確認ルートを追加
nacchan99 Jun 16, 2025
285999d
ルーティングから重複したRambulance::Engineのマウントを削除
nacchan99 Jun 16, 2025
5d202b7
Rambulance用の例外テンプレート(404/422/500)を追加
nacchan99 Jun 17, 2025
d064907
エラー表示用 show テンプレートにヘルパー連携を追加
nacchan99 Jun 17, 2025
5a6566d
エラー表示をヘルパー化
nacchan99 Jun 17, 2025
ca186cb
ErrorsController関連ルートを削除し、Rambulanceによる例外ハンドリングに統一
nacchan99 Jun 17, 2025
50bd22e
開発テスト環境にのみRambulanceマウント追加
nacchan99 Jun 17, 2025
c50c127
refactor: エラーページのビュー構成を変更
nacchan99 Jun 18, 2025
4457879
chore: 不要になった古いエラービューを削除
nacchan99 Jun 18, 2025
f86b750
fix: errors/showパーシャルでの変数の受け渡しを修正
nacchan99 Jun 18, 2025
29c6cac
fix(config): Rambulanceの例外マッピングを修正
nacchan99 Jun 18, 2025
48b231e
fix(helper): 予期せぬエラー発生時のメッセージを修正
nacchan99 Jun 18, 2025
8cd758d
feat: 開発用のエラーページプレビュー機能を追加
nacchan99 Jun 18, 2025
52bc61d
エラー画面の案内文を更新し、報告依頼の文言を追加
nacchan99 Jun 18, 2025
619801e
refactor: 400・403エラービューを共通の構成に統一
nacchan99 Jun 19, 2025
4df3a8a
feat: エラーページのプレビュー機能を動的に改善
nacchan99 Jun 19, 2025
cc5dad9
test: エラーページのリクエストスペックを追加
nacchan99 Jun 19, 2025
561e698
fix: 422エラービューのファイル名をRambulanceの仕様に統一
nacchan99 Jun 23, 2025
37ed1c4
refactor: 自作プレビュー機能を削除し、Rambulanceのルートに統一
nacchan99 Jun 23, 2025
9b25662
test: エラーページ(404, 422, 500, 400)のリクエストスペックを追加
nacchan99 Jun 23, 2025
ac24ce1
style: テストコードのクォートをシングルクォートに統一
nacchan99 Jun 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions app/helpers/errors_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module ErrorsHelper
def error_title(code)
case code
when 404 then "ページが見つかりませんでした... 🥺💦"
when 422 then "リクエストが処理できませんでした… 😢"
when 500 then "予期しないエラーが発生しました 😵‍💫"
else "予期せぬエラーが発生しました…😵"
end
end

def error_desc(code)
case code
when 404 then "ページが削除された可能性があります 🤔💭"
when 422 then "入力内容に誤りがあるか、リクエストが正しく送信されなかった可能性があります。"
when 500 then "申し訳ありません。サーバーで問題が発生しています。"
else "改善されない場合は、お手数ですがエラー報告をお願いいたします🙇‍♀️"
end
end
end
40 changes: 1 addition & 39 deletions app/views/errors/bad_request.html.erb
Original file line number Diff line number Diff line change
@@ -1,39 +1 @@
<% provide(:title, "ページが見つかりませんでした... 🥺💦") %>
<% provide(:desc, "ページが削除された可能性があります 🤔💭") %>

<div id="top" class="title text-center">
<i class="cd cd-logo"></i>
<h1>CoderDojo Japan</h1>
<p>子どものためのプログラミング道場</p>
<br>
</div>

<section class="introduction text-center list">
<h2>
ページが見つかりませんでした... 🥺💦
</h2>
<p>
ページが削除された可能性があります 🤔💭
<br>
</p>
<p>
フィードバックなどあれば [email protected] にメールしていただくか、
<br>
もしくは
<a href="https://github.com/coderdojo-japan/coderdojo.jp/issues/">GitHub Issue</a>
に書いていただけると嬉しいです (>人< )✨
</p>
</section>

<section id="timeline" class="text-center grayscale-bg" style="padding-bottom: 100px;">
<br>
<h3 class="text-center">
<a href="https://twitter.com/search?vertical=default&q=dojocon%20OR%20coderdojo%20OR%20%E3%82%B3%E3%83%BC%E3%83%80%E3%83%BC%E9%81%93%E5%A0%B4%20lang%3Aja" target="_blank" rel="noopener">🐣 最近の情報発信</a>
</h3>
<br>
<div class="twitter-timeline-wrapper">
<a class="twitter-timeline" href="https://twitter.com/CoderDojoJapan?ref_src=twsrc%5Etfw" data-lang="ja" data-chrome="noheader nofooter noborders" data-dnt="true" data-width="500" data-tweet-limit="5">@CoderDojoJapan アカウントのタイムライン</a>
</div>
<script async="" await="" src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</section>

<%= render template: "errors/show", locals: { status_code: 400 } %>
39 changes: 1 addition & 38 deletions app/views/errors/forbidden.html.erb
Original file line number Diff line number Diff line change
@@ -1,38 +1 @@
<% provide(:title, "403 Forbidden エラー 🚧 🏗") %>
<% provide(:desc, "アクセス権限が無いか削除された可能性があります 🤔💭") %>

<div id="top" class="title text-center">
<i class="cd cd-logo"></i>
<h1>CoderDojo Japan</h1>
<p>子どものためのプログラミング道場</p>
<br>
</div>

<section class="introduction text-center list">
<h2>
アクセスできないページのため表示できませんでした 🚧 🏗
</h2>
<p>
ログインし直すことで解決する可能性があります 🤔💭
<br>
</p>
<p>
フィードバックなどあれば [email protected] にメールしていただくか、
<br>
もしくは
<a href="https://github.com/coderdojo-japan/coderdojo.jp/issues/">GitHub Issue</a>
に書いていただけると嬉しいです (>人< )✨
</p>
</section>

<section id="timeline" class="text-center grayscale-bg" style="padding-bottom: 100px;">
<br>
<h3 class="text-center">
<a href="https://twitter.com/search?vertical=default&q=dojocon%20OR%20coderdojo%20OR%20%E3%82%B3%E3%83%BC%E3%83%80%E3%83%BC%E9%81%93%E5%A0%B4%20lang%3Aja" target="_blank" rel="noopener">🐣 最近の情報発信</a>
</h3>
<br>
<div class="twitter-timeline-wrapper">
<a class="twitter-timeline" href="https://twitter.com/CoderDojoJapan?ref_src=twsrc%5Etfw" data-lang="ja" data-chrome="noheader nofooter noborders" data-dnt="true" data-width="500" data-tweet-limit="5">@CoderDojoJapan アカウントのタイムライン</a>
</div>
<script async="" await="" src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</section>
<%= render template: "errors/show", locals: { status_code: 403 } %>
1 change: 1 addition & 0 deletions app/views/errors/internal_server_error.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<%= render template: "errors/show", locals: { status_code: 500 } %>
1 change: 0 additions & 1 deletion app/views/errors/internal_server_error.json.jbuilder

This file was deleted.

39 changes: 1 addition & 38 deletions app/views/errors/not_found.html.erb
Original file line number Diff line number Diff line change
@@ -1,38 +1 @@
<% provide(:title, "ページが見つかりませんでした... 🥺💦") %>
<% provide(:desc, "ページが削除された可能性があります 🤔💭") %>

<div id="top" class="title text-center">
<i class="cd cd-logo"></i>
<h1>CoderDojo Japan</h1>
<p>子どものためのプログラミング道場</p>
<br>
</div>

<section class="introduction text-center list">
<h2>
ページが見つかりませんでした... 🥺💦
</h2>
<p>
ページが削除された可能性があります 🤔💭
<br>
</p>
<p>
フィードバックなどあれば [email protected] にメールしていただくか、
<br>
もしくは
<a href="https://github.com/coderdojo-japan/coderdojo.jp/issues/">GitHub Issue</a>
に書いていただけると嬉しいです (>人< )✨
</p>
</section>

<section id="timeline" class="text-center grayscale-bg" style="padding-bottom: 100px;">
<br>
<h3 class="text-center">
<a href="https://twitter.com/search?vertical=default&q=dojocon%20OR%20coderdojo%20OR%20%E3%82%B3%E3%83%BC%E3%83%80%E3%83%BC%E9%81%93%E5%A0%B4%20lang%3Aja" target="_blank" rel="noopener">🐣 最近の情報発信</a>
</h3>
<br>
<div class="twitter-timeline-wrapper">
<a class="twitter-timeline" href="https://twitter.com/CoderDojoJapan?ref_src=twsrc%5Etfw" data-lang="ja" data-chrome="noheader nofooter noborders" data-dnt="true" data-width="500" data-tweet-limit="5">@CoderDojoJapan アカウントのタイムライン</a>
</div>
<script async="" await="" src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</section>
<%= render template: "errors/show", locals: { status_code: 404 } %>
1 change: 0 additions & 1 deletion app/views/errors/not_found.json.jbuilder

This file was deleted.

53 changes: 53 additions & 0 deletions app/views/errors/show.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<%# The status_code local variable is passed from the parent template %>
<% title = error_title(status_code) %>
<% desc = error_desc(status_code) %>

<% provide(:title, title) %>
<% provide(:desc, desc) %>

<div id="top" class="title text-center">
<i class="cd cd-logo"></i>
<h1>CoderDojo Japan</h1>
<p>子どものためのプログラミング道場</p>
<br>
</div>

<section class="introduction text-center list">
<h2><%= title %></h2>
<p>
<%= desc %>
<br>
</p>
<p>
フィードバックなどあれば [email protected] にメールしていただくか、
<br>
もしくは
<a href="https://github.com/coderdojo-japan/coderdojo.jp/issues/" target="_blank" rel="noopener">
GitHub Issue
</a>
に書いていただけると嬉しいです (>人< )✨
</p>
</section>

<section id="timeline" class="text-center grayscale-bg" style="padding-bottom: 100px;">
<br>
<h3 class="text-center">
<a href="https://twitter.com/search?vertical=default&q=dojocon%20OR%20coderdojo%20OR%20%E3%82%B3%E3%83%BC%E3%83%80%E3%83%BC%E9%81%93%E5%A0%B4%20lang%3Aja"
target="_blank" rel="noopener">
🐣 最近の情報発信
</a>
</h3>
<br>
<div class="twitter-timeline-wrapper">
<a class="twitter-timeline"
href="https://twitter.com/CoderDojoJapan?ref_src=twsrc%5Etfw"
data-lang="ja"
data-chrome="noheader nofooter noborders"
data-dnt="true"
data-width="500"
data-tweet-limit="5">
@CoderDojoJapan アカウントのタイムライン
</a>
</div>
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</section>
1 change: 1 addition & 0 deletions app/views/errors/unprocessable_content.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<%= render template: "errors/show", locals: { status_code: 422 } %>
1 change: 0 additions & 1 deletion app/views/errors/unprocessable_entity.json.jbuilder

This file was deleted.

3 changes: 3 additions & 0 deletions config/environments/production.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
# Full error reports are disabled.
config.consider_all_requests_local = false

# 本番環境では例外を自前ルーティングへ
config.exceptions_app = self.routes

Comment on lines +15 to +17
Copy link
Contributor

Choose a reason for hiding this comment

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

Rambulance提供のルートを利用する場合は、この定義も不要そうです👍

# Turn on fragment caching in view templates.
config.action_controller.perform_caching = true

Expand Down
3 changes: 3 additions & 0 deletions config/environments/test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
config.consider_all_requests_local = true
config.cache_store = :null_store

# テスト環境でも例外を自前ルーティングへ
config.exceptions_app = self.routes

Comment on lines +25 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

Rambulance提供のルートを利用する場合は、この定義も不要そうです👍

# Render exception templates for rescuable exceptions and raise for other exceptions.
config.action_dispatch.show_exceptions = :rescuable

Expand Down
7 changes: 4 additions & 3 deletions config/initializers/rambulance.rb
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@
# If Rambulance receives an exception that is not listed here, it'll render
# the internal server error template and return 500 as http status.
config.rescue_responses = {
ActionController::RoutingError => :not_found,
AbstractController::ActionNotFound => :not_found,
ActionController::BadRequest => :bad_request,
"ActionController::RoutingError" => :not_found,
"AbstractController::ActionNotFound" => :not_found,
"ActionController::BadRequest" => :bad_request,
"ActionController::InvalidAuthenticityToken" => :unprocessable_entity,

# "ActiveRecord::RecordNotUnique" => :unprocessable_entity,
# "CanCan::AccessDenied" => :forbidden,
Expand Down
11 changes: 11 additions & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
# For details on the DSL available within this file,
# see http://guides.rubyonrails.org/routing.html

# Rambulance を開発/テスト環境でのみマウント
if Rails.env.development? || Rails.env.test?
mount Rambulance::Engine => "/"
end

Comment on lines +5 to +9
Copy link
Contributor

Choose a reason for hiding this comment

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

Rambulance提供のルートを利用する場合は、この定義も不要そうです👍

root "home#show"

# Render legal documents by using Keiyaku CSS
Expand Down Expand Up @@ -105,4 +110,10 @@

# Check development sent emails
mount LetterOpenerWeb::Engine, at: "/letter_opener" if Rails.env.development?

# Rambulance がキャッチする /404, /422, /500
match "/404", to: Rambulance::Engine, via: :all, defaults: { status_code: 404 }
match "/422", to: Rambulance::Engine, via: :all, defaults: { status_code: 422 }
match "/500", to: Rambulance::Engine, via: :all, defaults: { status_code: 500 }

Comment on lines +113 to +118
Copy link
Contributor

Choose a reason for hiding this comment

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

Rambulance提供のルートを利用するので、この定義も不要そうです👍

end
57 changes: 53 additions & 4 deletions spec/requests/errors_spec.rb
Original file line number Diff line number Diff line change
@@ -1,15 +1,64 @@
require 'rails_helper'

RSpec.describe "Errors", type: :request do
RSpec.describe 'Errors', type: :request do
include Rambulance::TestHelper
include ErrorsHelper

describe "Error requests" do
it 'should render a corresponding error page' do
before do
# テスト用のルーティングを直接定義
Rails.application.routes.draw do
get '/trigger_400', to: ->(env) { raise ActionController::BadRequest }
get '/trigger_422', to: ->(env) { raise ActionController::InvalidAuthenticityToken }
get '/trigger_500', to: ->(env) { raise 'This is a test 500 error' }
end

# ビューのレンダリングをスタブして、レイアウト起因のエラーを回避
allow_any_instance_of(Rambulance::ExceptionsApp).to receive(:render).and_wrap_original do |m, *args|
options = args.last.is_a?(Hash) ? args.pop : {}
m.call(*args, **options.merge(layout: false))
end
end

after do
# テスト後に追加したルーティングを元に戻す
Rails.application.reload_routes!
end

describe 'Error requests' do
it 'renders the 404 error page' do
with_exceptions_app do
# どのルーティングにもマッチしないパスをリクエスト
get '/does_not_exist'
end
expect(response.status).to eq(404)
Copy link
Contributor

Choose a reason for hiding this comment

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

「子どものためのプログラミング道場」など、必ず表示されるテキストが存在するかも確認しておくと、さらに安心できそうです👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

テストを追加しました🙌
092c3dd
よろしくお願いします!

expect(response.body).to include(error_title(404))
expect(response.body).to include(error_desc(404))
end

assert_equal 404, response.status
it 'renders the 422 error page' do
with_exceptions_app do
get '/trigger_422'
end
expect(response.status).to eq(422)
expect(response.body).to include(error_title(422))
expect(response.body).to include(error_desc(422))
end

it 'renders the 500 error page' do
with_exceptions_app do
get '/trigger_500'
end
expect(response.status).to eq(500)
expect(response.body).to include(error_title(500))
expect(response.body).to include(error_desc(500))
end
it 'renders the 400 error page' do
with_exceptions_app do
get '/trigger_400'
end
expect(response.status).to eq(400)
expect(response.body).to include(error_title(400))
expect(response.body).to include(error_desc(400))
end
end
end