何をしたか: location の塊を 1 つ足す作業

nginx の設定ファイルに、location の塊を 1 つ足す作業をしました。足し方が正しいかどうかは、人の目ではなく自動の確認で確かめる形にしていました。

やり方は単純です。変える前のファイルと変えたあとのファイルを、Python の difflib.ndiff で比べます。そのうえで、次の 2 点を見ます。

設定ファイルを触る作業で怖いのは、足すつもりで何かを消してしまうことと、足した中身が意図とずれることです。この 2 点を機械的に見れば、その両方を拾えます。私たちはこの確認を前提に、手順を組んでいました。

手順には、塊を入れる位置も書かれていました。既存の location の塊の閉じ括弧の直後です。そこに新しい塊を入れれば、作業としては終わりのはずでした。

何が起きたか: 中身が正しいのに判定が必ず落ちる

つまずいたのは、足す塊の最後の 3 行が、すぐ前にある既存の location の塊の最後の 3 行と、同じ文字列だったことです。中身は次のとおりです。

proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}

2 つの塊が、まったく同じ 3 行で終わっています。手順どおり既存の塊の閉じ括弧の直後に入れると、difflib.ndiff はこれを次のように読みます。

人間が見れば、足したのは新しい塊です。ところが ndiff から見ると、同じ 3 行がファイルの中に 2 回続けて並んでいるだけです。どちらの 3 行が新しいのかを、差分の側は区別できません。結果として、新しい塊の末尾を「元からあった行」として扱い、その手前にずれた位置を「足した行」にしてしまいました。

このため「足した」と数えられた行の並びは、既存の塊の末尾 3 行から始まります。入れたかった塊の先頭とは別の行です。並びがずれるので、2 点目の「入れたかった塊とちょうど同じ」という条件は満たせません。

ここが厄介なところです。入れた中身は正しく、1 字も間違えていません。それでも、この位置に入れる限り判定は必ず落ちます。直すべきなのが中身ではないことは、はっきりしていました。

入れる前に、手元で 2 つの位置を回した

実際のファイルに入れる前に、同じ判定を 2 つの位置で手元で回しました。結果は次の表のとおりです。

入れた位置消した行足した行一致
閉じ括弧の直後(183 行の後)09False
その次の空行の後(184 行の後)09True

注目したいのは、足した行の数がどちらも 9 で同じことです。数だけを見ていたら、2 つの位置の違いには気づけません。違いが出るのは、並びを突き合わせる 2 点目の条件だけです。消した行が 0 であることも、どちらの位置でも変わりませんでした。

数で見ても落ちず、消した行も 0 のままで、並びだけが食い違う。こうした落ち方は、確認が通るかどうかを見ただけでは原因が見えにくいものです。手元で位置を変えて回したから、違いがはっきり分かりました。

どう直したか: 塊を 1 行下に入れた

直し方は、指示された位置より 1 行下に塊を入れることでした。閉じ括弧の直後ではなく、その次の空行の後です。塊の中身はそのままで、ほかの行は 1 字も変えていません。

確認のほうは、書き換えていません。「足した行の並びが、入れたかった塊とちょうど同じ」という条件は、そのままです。変えたのは、入れる位置だけです。

ここで気になるのは、位置を変えて nginx の動きが変わらないか、という点です。結論から言うと、変わりません。prefix の location と ^~ の location は、最も長く一致した prefix で選ばれます。ファイルに書いた順で選ばれるわけではありません。しかも、どちらの位置も同じ server の塊の中です。ですから、選ばれ方に差は出ません。

見た目は少し変わりました。塊の前の空行が 2 行になり、塊の閉じ括弧と次の行の間には空行がありません。読みやすさの好みは分かれるかもしれませんが、動きには関係しません。

入れたあとは、先に nginx -t で設定の文法を確かめました。通ったことを見てから reload しています。そのうえで自動の確認を回すと、前の 4/10 から 10/10 PASS になりました。

副作用が 1 つあった

副作用が 1 つありました。末尾にスラッシュの無い形で来た要求が、スラッシュ付きへの 301 になったのです。

これは nginx の仕様どおりの動きです。既存の location でも、同じ動きになっています。今回足した塊だけが特別な挙動をしているわけではありません。

そこから何を決めたか: 確認を直す前に、読み方を再現する

今回の件で、私たちは次のように考えるようになりました。差分の確認は、「どの行を足したか」を 1 通りに決められないことがあります。

設定ファイルのように、同じ行が何度も出てくるものでは特にそうです。同じ行が並んでいれば、差分を取る側は、どちらを新しい行と見るか選べてしまいます。入れる位置しだいで、判定の結果が変わります。今回の 183 行の後と 184 行の後は、まさにその例でした。

そこで、次の順で進めると決めました。

  1. 確認が落ちても、確認のほうは書き換えない
  2. まず判定の読み方を手元で再現する
  3. どちらの位置なら一致するかを見てから入れる

確認を書き換えない理由は、単純です。落ちた確認を緩めれば、その場は通ります。けれど、通ったあとの確認は、前より見る力が弱くなっています。今回のように中身が正しいときでも、中身が間違っているときと見分けがつかなくなってしまいます。

反対に、手元で読み方を再現すれば、落ちた理由が位置なのか中身なのかを切り分けられます。今回は、同じ 9 行を入れても、位置が違えば False にも True にもなることを、入れる前に確かめられました。実際のファイルに触る前に分かったことが、いちばんの収穫です。

この順が安全だと、私たちは考えています。確認を直すのは、位置を動かしても通らないと分かってからで遅くありません。

今回は、指示された位置より 1 行下に入れるだけで済みました。nginx の動きは変わらず、確認は 10/10 PASS になりました。

手順書に「この行の直後に入れる」と書いてあっても、同じ行が続く場所では、その位置が差分の確認と噛み合わないことがあります。そう分かったので、位置を決めるときは、入れる前に判定を手元で回すことにしました。