devise で未ログイン時の redirect 動作を調べて挙動を変更したい

やりたいこと

Redirect 時に Cache-Control ヘッダを明示的に指定したい
未ログイン時に Redirect している箇所を調べる
- リダイレクト先は ApplicationController の after_sign_out_path_for メソッドでオーバーライド可能
redirect の動作を変更したい

わかったこと

Devise における未ログイン時の Redirect の動作は Warden の failure_app の仕組みで行っている
Devise はデフォルトの failure_app として Devise::FailureApp を用意している

Devise の設定で failure_app を差し替えることができる

config/initializers/devise.rb

config.warden do |manager|
  manager.failure_app = CustomFailure
end

lib/custom_failure.rb

class CustomFailure < Devise::FailureApp
  # redirect メソッドをオーバーライドして処理を追加する、追加した処理の後に元の redirect メソッドを呼び出す
  def redirect
    Rails.logger.debug("#### CustomFailure redirect ####")
    super
  end
end

snaka 4ヶ月前に更新

アプリケーション側で after_sign_out_path_for をオーバーライドしているので、そのあたりを手がかりに Devise の動作を追いかけてみる。

snaka 4ヶ月前

リダイレクトしている箇所

snaka 4ヶ月前

sign_out_and_redirect を呼び出してる箇所が見当たらない...?

snaka 4ヶ月前

呼び出されているのはここでは無い可能性

snaka 4ヶ月前に更新

アプリケーションコードに respond_to_on_destroy をオーバーライドした箇所があった

format.any(*navigational_formats) { redirect_to after_sign_out_path_for(resource_name) }

snaka 4ヶ月前に更新

ログアウト時にはオーバライドしたコードが実行されていることを確認した

snaka 4ヶ月前

ログイン前にアクセスしたときのリダイレクトを実行している箇所が知りたい

snaka 4ヶ月前

acts_as_tenant の set_current_tenant_through_filter を使っていた

これはあまり関係なさそう

snaka 4ヶ月前

Devise 思い出してきた
before_action :authenticate_user! で、未ログイン時のリダイレクトが動いていた記憶ある

snaka 4ヶ月前

authenticate_user! を定義している箇所

snaka 4ヶ月前

リダイレクトは warden.authenticate!(opts) でやっていそう？

snaka 4ヶ月前

Warden の authenticate!()

snaka 4ヶ月前

throw したものは failure_app で処理される

snaka 4ヶ月前

見た感じ failure_app は Warden 自身には定義されてなくて、Configとして設定するものっぽい。
ということは、Devise 側で設定していそう。

snaka 4ヶ月前

Devise の FailureApp

snaka 4ヶ月前

failure_app は Rack アプリケーションという記述があったので call(env) が呼び出されるはず。

snaka 4ヶ月前に更新

action(:respond) とは？

snaka 4ヶ月前

dispatch

snaka 4ヶ月前

process(name)

snaka 4ヶ月前

process_action(action_name, *args)

snaka 4ヶ月前

send_action(...) は action(...) の alias

snaka 4ヶ月前

action(:respond) は respond() メソッドを呼び出しているっぽい

snaka 4ヶ月前に更新

redirect メソッド

ここをオーバーライドするとかしたら良さそう

snaka 4ヶ月前

この記事にあるように Devise::FailureApp を拡張することでなんとかできそう

snaka 4ヶ月前

lib/custom_failure.rb

class CustomFailure < Devise::FailureApp
  # redirect メソッドをオーバーライドして処理を追加する、追加した処理の後に元の redirect メソッドを呼び出す
  def redirect
    Rails.logger.debug("#### CustomFailure redirect ####")
    super
  end
end

config/initializers/devise.rb

  config.warden do |manager|
    manager.failure_app = CustomFailure
  end

これで未ログイン時に独自の処理 Rails.logger.debug("#### CustomFailure redirect ####") が動くことを確認した

snaka 4ヶ月前に更新

:private, :no_store の他に :must_revalidate とか追加したかったが、normalize ロジックが入ってて :no_store のときには :private のほかは追加されないようになっている

snaka 4ヶ月前

試しに以下のようにしてみた

class CustomFailure < Devise::FailureApp
  # リダイレクトのレスポンスをキャッシュさせないようにする
  def redirect
    response.cache_control[:private] = true
    response.cache_control[:no_store] = true

    super
  end
end

snaka 4ヶ月前

期待通りの Cache-Control ヘッダになった