更新日: 2016年7月21日
Rails

Rails ActiveRecordをマルチスレッドで使う

マルチスレッド環境で Rails の ActiveRecord を使おうとしたところ、以下のエラーに遭遇しました。スレッド毎に、ActiveRecord がDB接続（コネクション）を確保しようとするために、コネクションのプールサイズをオーバーしてしまうのが原因です。


ActiveRecord::ConnectionTimeoutError in SomeController#some_action
could not obtain a database connection within 5.000 seconds (waited 5.003 seconds)

ActiveRecord::ConnectionTimeoutError in SomeController#some_action

could not obtain a database connection within 5.000 seconds (waited 5.003 seconds)

— 環境 —
Rails 4.2
Ruby 2.3

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

エラーが発生したコード

スレッド毎に User モデル（データベースの users テーブル）を検索して、結果を後で user_groups としてまとめるようなコードを書いていた。

threads = []
threads.push(Thread.new do
  first_group = User.first_group
end)

threads.push(Thread.new do
  second_group = User.second_group
end)

threads.each {|t| t.join(30)}
user_groups = first_group + second_group

threads = []

threads.push(Thread.new do

first_group = User.first_group

end)

threads.push(Thread.new do

second_group = User.second_group

end)

threads.each {|t| t.join(30)}

user_groups = first_group + second_group

User.first_group, User.second_group は、それぞれ特定の条件で User モデルを検索する scope です。この書き方だと ActiveRecord::ConnectionTimeoutError が発生します。

ActiveRecord::Base.connection_pool.with_connection を使う

ActiveRecord::Base.connection_pool.with_connection を使って、そのブロック内でモデルを検索するようにコードを修正することで、ActiveRecord::ConnectionTimeoutError を解決できます。

ActiveRecord::Base.connection_pool.with_connection のソースを読んだところ、fresh_connection（新規のDBコネクション）の場合、ブロック実行後に ensure 節で release_connection（コネクションを解放）するコードとなっています。次の説明が書いてありました。

Use ActiveRecord::Base.connection_pool.with_connection(&block), which obtains a connection, yields it as the sole argument to the block, and returns it to the pool after the block completes.

ActiveRecord::ConnectionAdapters::ConnectionPool

意訳）ActiveRecord::Base.connection_pool.with_connection(&block) を使うと、コネクションを取得して、そのコネクションをブロック引数としてブロックを実行し、ブロック実行が終了したらそのコネクションをプールに戻します。

ということで、ActiveRecord::Base.connection_pool.with_connection に渡すブロック内で、User モデルを検索するようにコードを変更しました。

threads = []
threads.push(Thread.new do
  ActiveRecord::Base.connection_pool.with_connection do
    first_group = User.first_group
  end
end)

threads.push(Thread.new do
  ActiveRecord::Base.connection_pool.with_connection do
    second_group = User.second_group
  end
end)

threads.each {|t| t.join(30)}
user_groups = first_group + second_group

threads = []

threads.push(Thread.new do

ActiveRecord::Base.connection_pool.with_connection do

first_group = User.first_group

end

end)

threads.push(Thread.new do

ActiveRecord::Base.connection_pool.with_connection do

second_group = User.second_group

end

end)

threads.each {|t| t.join(30)}

user_groups = first_group + second_group

これでエラーが発生しなくなりました。

パーフェクト Ruby on Rails は、最近読んだ Rails 本の中では一番役に立った本です。Chef や Capistrano など Rails と共によく使用される技術にも触れてあります。Ruby on Rails 4 アプリケーションプログラミングは、入門的な内容で Rails の機能全体を網羅されています。

パーフェクト Ruby on Rails

Ruby on Rails 4 アプリケーションプログラミング