Upgrade Ruby on Rails: 6.2 -> 7.0 #1631

nanophate · 2024-09-18T14:44:04Z

やりたいこと

Rails 7.0 にアップグレードしたい

cf. Railsガイド - Railsアップグレードガイド
cf. Ruby on Rails - Maintenance Policy
- List of currently supported releases
  - 8.0.x - Supported until November 7, 2026
  - 7.2.x - Supported until August 9, 2026
  - 7.1.x - Supported until October 1, 2025
  - 7.0.x - Supported until April 1, 2025
関連PR (時系列順):

やったこと

Gemfile の gem 'rails', '~> 7.0' を指定
bundle update を実行
app:update を実行し該当のファイルを確認しながら、コミット
rambulance の autoload のタイミングを変更して、テストが行えるようにした (詳細: Upgrade Ruby on Rails: 6.2 -> 7.0 #1631 (comment))

確認方法

Review App で問題なく動作すること
https://coderdojo-pi-update-rai-1uyjnn.herokuapp.com

nanophate · 2024-10-20T10:27:37Z

Rails 6からRails 7.0へのアップデートを完了し、通常のページは問題なく動作・表示されることを確認しました。しかし、ページが見つからない場合に例外をキャッチしてカスタムエラーページを表示する機能（Rambulance Gem）が正常に動作せず、テスト時にエラーが発生しています。

https://github.com/coderdojo-japan/coderdojo.jp/actions/runs/11422953916/job/31781556938#step:6:319

`NameError: uninitialized constant ApplicationHelper` 発生原因の推測

調査を進めたところ、7556876 で追加した require 'rambulance/exceptions_app' で回避できてたと思ったエラーに関連がありました。開発環境では、require をするだけでエラーは出なくなりますが、実際に動作すると、rambulance が読み込まれてなく、エラーページを出す機能が機能していない事が確認、この NameError の解決が必要と考えます。

エラー: NameError: uninitialized constant ApplicationHelper
推測: Rails 6 から Rails 7 へのアップグレードに伴い、オートローディングが Zeitwerk にされた影響か、オートローディングのタイミングが Rails 6 から大きく変更した影響。これにより、Gem の Railtie がアプリケーションのヘルパーモジュール（ApplicationHelper や ContractsHelper など）を参照する際に、それらがまだロードされておらずエラーが発生。

試してみた

Rails 6 で動作確認
- git checkout main でブランチを変更し
- 結果: エラーは起きない
Rambulance の issue に上がっていた回避方法 require 'rambulance/exceptions_app
- 7556876 で追加
- 結果: エラーは起きないが、Rambulance が機能していない、また RAILS_ENV=production bin/rails zeitwerk:check を行うと同様のエラーが表示される
prepend_helpers_path の設定調整
- Rambulance の Railtie 内の after: prepend_helpers_path を load_application_config や application.initialize などに変更してロード後にならないか試みた。
- 結果: この読み込み設定が期待通りに機能せず、引き続き NameError が発生。

application.rb に ApplicationHelper の手動読み込みを追加

変更点:

# config/application.rb
require_relative "boot"
require "rails/all"

Bundler.require(*Rails.groups)

# 問題の回避策としてヘルパーファイルを手動で読み込む
require_relative "../app/helpers/application_helper"

module CoderdojoJp
  class Application < Rails::Application

結果:

エラー（ApplicationHelper 関連）は解消されたが、新たに ContactsHelper の NameError が発生。

 ❯ RAILS_ENV=production bin/rails zeitwerk:check
 ActionMailer::MailDeliveryJob
 ActionText::ContentHelper
 ActionText::TagHelper
 Rambulance::ExceptionsAppHelper
 Rambulance
 Rambulance
 ApplicationHelper
 rails aborted!
 NameError: uninitialized constant ContractsHelper
       Object.const_get(camel_cased_word)
             ^^^^^^^^^^
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.8.4/lib/active_support/inflector/methods.rb:279:in `constantize'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.8.4/lib/active_support/core_ext/string/inflections.rb:74:in `constantize'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/abstract_controller/helpers.rb:181:in `block in modules_for_helpers'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/abstract_controller/helpers.rb:174:in `map!'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/abstract_controller/helpers.rb:174:in `modules_for_helpers'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/action_controller/metal/helpers.rb:104:in `modules_for_helpers'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/abstract_controller/helpers.rb:152:in `helper'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/actionpack-7.0.8.4/lib/action_controller/railties/helpers.rb:19:in `inherited'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/rambulance-3.3.0/lib/rambulance/exceptions_app.rb:22:in `<module:Rambulance>'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/rambulance-3.3.0/lib/rambulance/exceptions_app.rb:3:in `<main>'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/bootsnap-1.18.4/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:30:in `require'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/bootsnap-1.18.4/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:30:in `require'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/zeitwerk-2.6.18/lib/zeitwerk/kernel.rb:34:in `require'
 /Users/vivio/.code/coderdojo.jp/vendor/bundle/ruby/3.1.0/gems/rambulance-3.3.0/lib/rambulance/railtie.rb:5:in `block (2 levels) in <class:Railtie>'

nanophate · 2024-10-21T02:10:11Z

IDEA 💡 rails/rails#43205 のコメントにあるように setup_main_autoloader で改善することもあるぽいので試してみる。読んでる感じ Autoloader の変更で起きた問題ですでに修正されてるようですが….

coderdojo-japan/coderdojo.jp#1631 (comment) issue

yasslab/rambulance@f422d93

nanophate · 2024-10-21T11:52:10Z

setup_main_autoloader に変更することで、動作も含めてエラーにならないことを確認しました 🎉 💯

Patch: yasslab/rambulance@f422d93
Patch Gem の利用: 45d49d9

nalabjp · 2024-10-29T19:04:28Z

rambulance関連は一通りリンク先やコードを追ってみましたが、現時点では原因がよくわからないです。
forked gemで期待通りの挙動になっているのであれば、一旦そのまま進めてしまうのが良さそうに思います。
一点だけ気になったのは 4a7f426 で有効になる変更点については特に触れられてなさそうですが、
内容の精査は不要という感じでしょうか？

nalabjp

#1631 (comment)
にレスがなかったのでv7.0でデフォルト設定となる項目のすべてを調査しました。
config/initializers配下の２つのファイルが不要になっているので削除しておいてもらえれば、
あとは特に問題はなさそうでした。
ということで、ファイル削除の再レビューも不要かなと思うので先にApproveしておきます。
ご対応ありがとうございました！

config/initializers/new_framework_defaults_7_0.rb

nalabjp · 2024-11-10T13:53:49Z

あ、Gemfile.lockがコンフリクトしてますね😅
それも合わせて修正しておいていただけると 🙏

nanophate · 2024-11-10T14:01:20Z

#1631 (comment)
にレスがなかったのでv7.0でデフォルト設定となる項目のすべてを調査しました。
config/initializers配下の２つのファイルが不要になっているので削除しておいてもらえれば、
あとは特に問題はなさそうでした。

細かくレビューいただきありがとうございます！コメントに気付いていませんでした... 💦 申し訳ありません... 🙇
返信が数日ない時は気軽に @nanophate でメンションいただければ Slack でも通知が飛んで気づけると思います！

また、丁寧に一個一個調査していただきありがとうございます ☺️✨一つずつ対応していきます！！

nanophate · 2024-11-11T00:53:20Z

Resolve ありがとうございます！マージしたいと思います...!!

nanophate · 2024-11-11T00:55:45Z

もし何か起きた場合は、Rollback

heroku rollback v3292 -a coderdojo-japan

=== coderdojo-japan Releases - Current: v3292

 v3292 Deploy ae32e2c7 2024/11/08 15:00:29 +0900 
 v3291 Deploy a8805809 2024/11/08 14:57:45 +0900

yasulab · 2024-11-13T05:27:37Z

諸々の対応ありがとうございました...!!! (＞人＜ )✨

#1631 (comment)

nanophate force-pushed the update-3.1.6 branch from a78d28c to 56bdbe0 Compare September 18, 2024 14:55

nanophate added 11 commits September 18, 2024 23:56

update ruby version 3.1.6

217ffa1

update gem to rails 7.0

0dabce2

app:update bin/setup

1d3a5d1

app:update config/environments/development.rb

29b52bc

app:update config/environments/production.rb

f9767bd

app:update config/environments/test.rb

58bab53

app:update config/initializers/assets.rb

d935753

app:update config/initializers/content_security_policy.rb

c399269

app:update config/initializers/filter_parameter_logging.rb

6d4ecc1

app:update config/initializers/inflections.rb

d573bdb

app:update db/schema.rb

105d203

nanophate force-pushed the update-rails-7.0 branch from 4833404 to 575bcc9 Compare September 18, 2024 14:56

app:update config/initializers/new_framework_defaults_7_0.rb

e20dbd6

nanophate force-pushed the update-rails-7.0 branch from 575bcc9 to e20dbd6 Compare September 18, 2024 15:00

nanophate temporarily deployed to coderdojo-pi-update-rai-5uhhfr September 18, 2024 15:10 Inactive

yasulab temporarily deployed to coderdojo-pi-update-rai-yyysoh September 18, 2024 15:43 Inactive

Base automatically changed from update-3.1.6 to main September 21, 2024 01:59

nanophate temporarily deployed to coderdojo-pi-update-rai-8coyxu October 20, 2024 02:35 Inactive

nanophate added 2 commits October 20, 2024 11:47

workaround rambulance load timming issue

7556876

remove js compressor replicating production config

b1fa9d4

nanophate force-pushed the update-rails-7.0 branch from 8dcb4e4 to b1fa9d4 Compare October 20, 2024 03:12

yasulab temporarily deployed to coderdojo-pi-update-rai-hrbl8a October 20, 2024 03:14 Inactive

match heroku-22 stack to match production

e100021

nanophate temporarily deployed to coderdojo-pi-update-rai-t8ipzj October 20, 2024 03:31 Inactive

nanophate added a commit to yasslab/rambulance that referenced this pull request Oct 21, 2024

Change load to mitigate load changes causing NameError

f422d93

coderdojo-japan/coderdojo.jp#1631 (comment) issue

Change rambulance to yasslab/rambulance to mitigate the nameerror issue

45d49d9

yasslab/rambulance@f422d93

nanophate marked this pull request as ready for review October 21, 2024 11:47

Update to Rails 7

4a7f426

nanophate temporarily deployed to coderdojo-pi-update-rai-1uyjnn October 21, 2024 11:52 Inactive

nanophate requested review from yasulab and himajin315 October 21, 2024 12:17

nalabjp approved these changes Nov 10, 2024

View reviewed changes

nanophate added 3 commits November 10, 2024 23:05

Merge branch 'main' into update-rails-7.0

afad8dc

remove already enable pramswrapper '#1631 (comment)'

59fae65

remove already enable cookies_serializer format '#1631 (comment)'

9b86ba4

nanophate merged commit b0ad364 into main Nov 11, 2024
2 checks passed

nanophate deleted the update-rails-7.0 branch November 11, 2024 00:53

This was referenced May 21, 2025

Update Ruby version to 3.4.4 #1690

Merged

Upgrade Ruby on Rails: 7.0 -> 7.1 #1686

Merged

yasulab added a commit that referenced this pull request May 22, 2025

Unpin unnecessary patched gem for rambulance for this reason:

f40144b

#1631 (comment)

This was referenced May 23, 2025

Upgrade Ruby on Rails: 7.1 -> 7.2 #1692

Merged

Upgrade Ruby on Rails: 7.2 -> 8.0 #1693

Merged

yasulab changed the title ~~Update rails 7.0~~ Update Ruby on Rails: 6.2 -> 7.0 May 23, 2025

yasulab changed the title ~~Update Ruby on Rails: 6.2 -> 7.0~~ Upgrade Ruby on Rails: 6.2 -> 7.0 May 23, 2025

Uh oh!

Upgrade Ruby on Rails: 6.2 -> 7.0 #1631

Upgrade Ruby on Rails: 6.2 -> 7.0 #1631

Uh oh!

Conversation

nanophate commented Sep 18, 2024 • edited by yasulab Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

やりたいこと

やったこと

確認方法

Uh oh!

nanophate commented Oct 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

NameError: uninitialized constant ApplicationHelper 発生原因の推測

試してみた

Uh oh!

nanophate commented Oct 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nanophate commented Oct 21, 2024

Uh oh!

nalabjp commented Oct 29, 2024

Uh oh!

nalabjp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nalabjp commented Nov 10, 2024

Uh oh!

nanophate commented Nov 10, 2024

Uh oh!

nanophate commented Nov 11, 2024

Uh oh!

Uh oh!

nanophate commented Nov 11, 2024

Uh oh!

yasulab commented Nov 13, 2024

Uh oh!

Uh oh!

nanophate commented Sep 18, 2024 •

edited by yasulab

Loading

nanophate commented Oct 20, 2024 •

edited

Loading

`NameError: uninitialized constant ApplicationHelper` 発生原因の推測

nanophate commented Oct 21, 2024 •

edited

Loading