RubyのException#causeでネストされた例外の原因を追跡する方法

Rubyでは、例外をrescueして別の種類の例外として再送出（re-raise）するのは非常によくあるパターンです。ActionViewはその分かりやすい例の一つです。以前TracePointについて取り上げた記事でも触れましたが、ActionViewはテンプレート内で発生した例外をすべて握りつぶし、ActionView::Template::Errorとして再送出します。

しかし、この挙動だけでは不十分な場合があります。元の例外には問題解決につながる重要なデータが含まれていることが多く、どうしても元の例外そのものが必要になるのです。幸い、Ruby 2.1以降ではException#causeメソッドを使うことで、これを簡単に実現できます。

実際の動作を見てみましょう。次の例では、まずNoMethodErrorをraiseし、直後にそれをrescueしてRuntimeErrorをraiseしています。その後、外側でRuntimeErrorを捕捉し、#causeを使って元のNoMethodErrorを取得しています。

def fail_and_reraise
  raise NoMethodError
rescue
  raise RuntimeError
end

begin
  fail_and_reraise
rescue => e
  puts "#{ e } caused by #{ e.cause }"
end

ネストされたバックトレースとカスタム属性へのアクセス

#causeメソッドは、元の例外オブジェクトそのものを返します。つまり、元の例外が持っていたあらゆるメタデータにアクセスできるということです。もちろん、元のバックトレースも取得可能です。

次の例では、食べ物の名前を保持するカスタム例外EatingErrorを定義し、再送出後もその属性を参照できることを示しています。

class EatingError < StandardError
  attr_reader :food
  def initialize(food)
    @food = food
  end
end

def fail_and_reraise
  raise EatingError.new("soup")
rescue
  raise RuntimeError
end

begin
  fail_and_reraise
rescue => e
  puts "#{ e } caused by #{ e.cause } while eating #{ e.cause.food }"
  puts e.cause.backtrace.first
end

無限の彼方へ！

ここまでの例は1階層のネストでしたが、Rubyのネストされた例外は理論上いくらでも深くできます。とはいえ、実際に3〜4階層より深いネストが必要になる場面はまずないでしょう。

…とはいえ、せっかくなので面白半分に100階層の深さを持つネストされた例外を作ってみました。ただの遊びのコードなので、本番環境でこんなものを目にすることがないよう祈っています。

def recursively_raise(c=0)
  raise "Level #{ c }"
rescue => e
  if c < 100
    recursively_raise(c + 1)
  else
    recursively_print(e)
  end
end

def recursively_print(e)
  if e
    puts e
    recursively_print(e.cause)
  end
end

recursively_raise()

# ... Prints the following:
# Level 100
# Level 99
# Level 98
# etc.