You need to enable JavaScript to run this app. Clearance SessionsController登录成功后@user偶发为nil的问题排查
优惠活动
大模型
产品
解决方案
定价
更多

Clearance SessionsController登录成功后@user偶发为nil的问题排查

登录逻辑中@user偶发为nil的问题

我原本认为只要 status.success? 返回 true,就可以确定 @user 变量一定存在,但实际偶尔会遇到报错,提示 @user 为 nil。

为什么 #track_sign_in 方法内引用的 @user 会偶发出现 nil?这个问题在我给控制器添加2FA功能之前就已经存在,接入2FA之后报错的发生频率还有所上升。

最初的基础版会话控制器实现如下:

class Clearance::SessionsController < Clearance::BaseController
  before_action :redirect_signed_in_users, only: [:new]
  skip_before_action :require_login, only: [:create, :new, :destroy], raise: false

  def create
    @user = authenticate(params)

    sign_in(@user) do |status|
      if status.success?
        track_sign_in
        redirect_back_or url_after_create
      else
        flash.now.alert = status.failure_message
        render template: "sessions/new", status: :unauthorized
      end
    end
  end

  private

  def track_sign_in
    @user.update!(sign_in_count: @user.sign_in_count + 1)
  end
end

早在将逻辑改造为支持2FA之前,我就已经遇到过这个报错。以下是接入2FA后的完整自定义控制器实现:这个版本里报错频率更高,但哪怕是上面的基础版本,我也碰到过相同的问题。

class SessionsController < Clearance::SessionsController
  before_action :skip_authorization
  layout 'simple'

  def create
    @user = find_user
    authed_user = authenticate(params)

    if params[:session][:otp_attempt].present? && session[:otp_user_id]
      authenticate_user_with_otp_two_factor(@user)
    elsif !@user || !@user.two_factor_required? || !authed_user || (@user.two_factor_required? && !@user.two_factor_setup?)
      do_sign_in(authed_user)
    else
      prompt_for_otp_two_factor(authed_user)
    end
  end

  private

  def valid_otp_attempt?(user)
    user.authenticate_otp(params[:session][:otp_attempt])
  end

  def authenticate_user_with_otp_two_factor(user)
    if valid_otp_attempt?(user)
      # 清除登录流程中残留的用户会话数据
      session.delete(:otp_user_id)
      do_sign_in(user)
    else
      flash.now[:alert] = '验证码无效,请重试'
      prompt_for_otp_two_factor(user, :unauthorized)
    end
  end

  def prompt_for_otp_two_factor(user, status = :ok)
    @user = user
    session[:otp_user_id] = user.id
    render 'sessions/two_factor', status: status
  end

  def do_sign_in(user)
    sign_in(user) do |status|
      if status.success?
        track_sign_in
        redirect_back_or url_after_create
      else
        flash.now.alert = status.failure_message
        render template: "sessions/new", status: :unauthorized
      end
    end
  end

  def find_user
    if session[:otp_user_id]
      User.find(session[:otp_user_id])
    elsif params[:session][:email]
      User.find_by(email: params[:session][:email])
    end
  end

  def track_sign_in
    @user.update!(
      sign_in_count: @user.sign_in_count + 1,
      last_sign_in_at: Time.current,
      last_sign_in_ip: request.remote_ip,
    )
  end
end

以下是对应的错误堆栈截图。

问题根因

偶发的@user为nil报错,本质是控制器实例变量的赋值时机和实际完成登录的用户对象完全脱节:

  • 基础版控制器中,@user的值由authenticate(params)赋值。当请求没有携带有效邮箱/密码凭证时,authenticate返回nil,此时@user就是nil。
  • Clearance 的 sign_in 方法内置了兜底逻辑:当传入的用户参数为nil时,会自动从当前会话残留的有效用户ID加载对应用户,完成登录流程并返回status.success? == true。
  • 这就导致了:哪怕没有提供有效登录凭证,只要会话里残留了之前的有效登录态,sign_in就会判定登录成功,进入成功分支调用track_sign_in,但此时@user还是之前authenticate返回的nil,自然触发空对象报错。

接入2FA后报错频率上升,是因为2FA流程增加了更多异步分支:

  • 当用户在OTP输入页停留时间过长,会话中的otp_user_id过期失效时,提交OTP请求会因为找不到关联用户,让find_user返回nil,也就是@user = nil。
  • 只要会话里残留了其他有效登录态,do_sign_in(nil)依然会让Clearance完成自动登录、返回成功状态,触发track_sign_in里的空对象访问。

修复方案

不要再依赖外层赋值的@user实例变量,改为将实际完成登录的用户对象作为参数传入track_sign_in,切断对全局实例变量的依赖:

  • 修改track_sign_in方法,接收user参数,替换原来的@user引用:
    def track_sign_in(user)
      user.update!(
        sign_in_count: user.sign_in_count + 1,
        last_sign_in_at: Time.current,
        last_sign_in_ip: request.remote_ip,
      )
    end
    
  • 在登录成功的分支里,将实际完成登录的用户对象传入方法。Clearance 的sign_in方法返回的成功状态对象,会携带实际登录的用户实例,直接从状态对象中获取即可,不需要依赖外层变量。

内容的提问来源于stack exchange,提问作者Lauren

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.01 19:15:04