読者です 読者をやめる 読者になる 読者になる

モンモンブログ

Ruby, Python, PHP, JavaScript/jQuery などなど気分に応じて

Rails5 の or クエリがバグを誘発しそうで超怖い

Rails5 になって ActiveRecordor クエリが導入されました。早速、既存のコードを書き換えようとしたんですが、かなり慎重に使わないと結合順序のワナに嵌ってバグりそうで怖いです。

このような(間の抜けた)コードがあったとします。

Country.
  where(id: 1).
  where("id = ? OR id = ?", 1, 2).
  pluck(:id)

生成される SQL はこうで、

SELECT "countries"."id" FROM "countries" WHERE
"countries"."id" = $1 AND (id = 1 OR id = 2)  [["id", 1]]

実行結果はこう。

[
    [0] 1
]

これを、or クエリを用いて素直に書き換えてみます。

Country.
  where(id: 1).
  where(id: 1).or(Country.where(id: 2)).
  pluck(:id)

生成される SQL はこうで、

SELECT "countries"."id" FROM "countries" WHERE
("countries"."id" = $1 AND "countries"."id" = $2 OR "countries"."id" = $3)  [["id", 1], ["id", 1], ["id", 2]]

実行結果はこう。て、さっきと違うやないかい!?

[
    [0] 1,
    [1] 2
]

最初のケースでは A AND (B OR C) のように OR 句のまわりが明示的にカッコで囲まれていたのに対し、 or クエリを使ったケースでは A AND B OR C とカッコがなく、結果的に (A AND B) OR C と評価されたためです。

最初のケースと同様の結果を得るには、or クエリを使った行を最初に持ってくるといいようです。

Country.
  where(id: 1).or(Country.where(id: 2)). # この行と
  where(id: 1).                          # この行を入れ替えた
  pluck(:id)

生成される SQL はこうなり、

SELECT "countries"."id" FROM "countries" WHERE
("countries"."id" = $1 OR "countries"."id" = $2) AND "countries"."id" = $3  [["id", 1], ["id", 2], ["id", 1]]

実行結果は最初と等しくなりました。

[
    [0] 1
]

(B OR C) AND A のように OR 句のまわりがカッコで囲まれて、最初のケースの A AND (B OR C) と等価になっています。

or クエリ、怖いですねえ。

この挙動をしっかり理解した上でコードを書いたとしても、チームの別のエンジニアが(あるいは将来の自分が)無自覚に where 句を追加したり順番を入れ替えたりして、予期せぬバグが生まれたりしたら…。

慎重に使ったほうがよさそうです。

DelayedJob による非同期処理の失敗を exception_notification でエラー通知させる

delayed_jobs による非同期処理時に、exception_notification によるエラー通知メール送信を行う - Qiita

こちらの記事を参考に DelayedJob のエラー通知を実装していたんですが、 Rails5 で alias_method_chain が Deprecated になってしまったので Module.prepend を使って書き直しました。

config/initializers/delayed_job.rb

module NotifyWhenDelayedJobFailed
  def handle_failed_job(job, error)
    # オリジナルの Delayed::Worker#handle_failed_job を実行
    super
    # 追加処理としてメール通知を行う
    ExceptionNotifier.notify_exception(error)
  end
end

class Delayed::Worker
  # 定義したモジュールを prepend
  prepend NotifyWhenDelayedJobFailed
end

Module.prepend については

» Ruby2.0のModule#prependは如何にしてalias_method_chainを撲滅するのか!? TECHSCORE BLOG

こちらが分かりやすかったです。

Rubyで2項演算子が単項演算子に化けて悪さする話

DateTime.now + 1.hourDateTime.now +1.hour は異なる値を返します。

何を言ってるのかわからねーと思うがこの実行結果を見てくれ。こいつをどう思う?

[10] pry(main)> DateTime.now + 1.hour
Fri, 29 Jan 2016 11:38:52 +0900         # こっちだと 11:38
[11] pry(main)> DateTime.now +1.hour
Fri, 29 Jan 2016 10:38:52 +0900         # こうすると 10:38。あれれ?

すごく・・・バグりそうです・・・///

なんでか

DateTime.now + 1.hour

DateTime.now() + 1.hour

と解釈されるのに対し、

DateTime.now +1.hour

DateTime.now(+1.hour)

と解釈されるためです。

前者では二項演算子だった + 演算子が、後者では単項演算子に化けてますね。

ちなみに Time.now の場合はこの問題は起こりません。Time.now は引数を取らないので ArgumentError となるため。

[15] pry(main)> Time.now +1.hour
ArgumentError: wrong number of arguments (given 1, expected 0)
from /Users/monmon/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/delorean-2.1.0/lib/delorean.rb:11:in `now'

ちなみにちなみに 1.hour は1時間分の秒数 = 3600 を返すもんだと思ってくれい。ActiveSupport が追加するメソッドだ。rails 使いなら常識だ。

どんな場合に起こるか?

以下のような場合に、この問題が起こるんだと思います。

  • 数値(っぽい)型のデフォルト値つきの引数1つを取り、数値(っぽい)型の値を返すメソッドがある
  • + または - 演算子の左側にこのメソッドの括弧なし呼び出し、右側に数値(っぽい値)が現れる
  • 演算子と右側の値の間にスペースがない

「数値っぽい」と表現したのは、+- 演算子で計算出来るものであれば多分なんでもよさげなので。

実験してみましょう。こんなメソッドを作って、

def hoge(n = 1)
  n
end

+ 演算子の前後のスペースを変えながら実行してみると、

hoge + 1    # 2 ✓
hoge+1      # 2 ✓
hoge+ 1     # 2 ✓
hoge +1     # 1 ×

このとおり、結果がおかしくなる場合がありました。

- 演算子でも同様です。

hoge - 1    # 0 ✓
hoge-1      # 0 ✓
hoge- 1     # 0 ✓
hoge -1     # -1 ×

こわいですね。

弊社サービスもこれが原因でバグってたことがあるのはみんなには内緒だよ。
雑なエンジニアは死滅すればいいのに。

教訓

スペースにもちゃんと気を配ってコード書きましょうねというお話でした。