📝 この記事は forge.workstyle.tech に掲載した記事の転載です。
作業が止まるたびに未コミットの変更を知らせるStop hookを使っていて、JSONエラーが出た人向けの記事です。Stop hookは、作業が止まるときに実行されるフック(処理)です。JSONはデータを決まった書式で表す形式です。私はエラーを見て、変更を知らせる出力のどこが壊れているのか分からず、JSONを作る処理と変更の数え方を順に確認しました。この記事では、エラーの原因と、実行場所や変更の確認方法も含めて見直した内容を説明します。
先に結論
Stop hookのHook output looks like a JSON object but is not valid JSON — JSON Parse error: Unterminated string.は、文字列を出力するprintfコマンドの%bがJSON文字列に生の改行を出力したことで起きていました。JSONはPythonのjson.dumps関数(値からJSON形式の文字列を作る機能)で組み立てる形に直し、実行場所とGitの変更の数え方も見直しました。
なぜStop hookのJSONで「Unterminated string」が出たのか
JSONエラーの直接の原因は、printfの%bが文字列に含まれる改行をそのまま出力していたことでした。
エラーは次の内容です。
Hook output looks like a JSON object but is not valid JSON — JSON Parse error: Unterminated string.
printfは文字列などを出力するコマンドです。書式に%bを使うと、文字列に含まれる改行が出力に反映されます。その結果、JSONの文字列の中に生の改行が入り、文字列が途中で途切れた形になっていました。Unterminated stringは、文字列が終わっていないというエラーです。
私は最初、変更を知らせる処理のどこかでJSONの形を間違えたのだと思いました。エラー文から出力が壊れていることは分かっても、どの値が原因かは分からなかったため、JSONを組み立てている部分を確認しました。
Stop hookの実行場所が前の環境のままではないか
JSON以外に見つかった問題は、処理の最初に実行するcdの移動先が前の環境の場所のままだったことです。
その移動に失敗しても、処理は続いていました。出力を正しく作るには、フックがどこでコマンドを実行しているかも確認する必要があります。私は場所を固定せず、実行時に決める形に直しました。
Gitの変更を数えるときに何が抜けていたのか
変更の数え方では、git diff --name-onlyだけを確認していたため、ステージ済みの変更と未追跡のファイルが対象から抜けていました。
ステージ済みとは、Gitでコミットするために登録した変更です。未追跡のファイルは、Gitがまだ管理対象として認識していないファイルです。通知したいのは未コミットの変更なので、一部の変更しか拾わない方法では通知が不完全になります。
私は変更をgit status --porcelain=v1 -zで数える形にしました。JSONのエラーを直すだけでは、変更の集計漏れは解決しません。
JSONと変更通知をどう直したのか
修正では、実行場所、変更の確認方法、JSONの組み立て方の三つを見直しました。
まず、前の環境の場所に固定したcdを残さず、実行時に場所を決める形にしました。次に、変更をgit status --porcelain=v1 -zで数え、ステージ済みと未追跡のファイルも確認対象に含めました。最後に、シェルのprintfでJSONを手作業で組み立てるのをやめ、Pythonのjson.dumpsで組み立てました。
ファイル名に改行などを含めてもJSONになるか
修正後は、ファイル名に引用符、バックスラッシュ、改行、日本語、空白を含むケースで出力を確かめました。
修正前は壊れ、修正後は正しく出ました。JSONらしい形の文字列が出るだけでは十分ではなく、今回問題になった文字を含むファイル名でも正しいJSONになるかを確かめました。
Stop hookがいつから壊れていたかは分からない
設定がGitの管理外にあり変更履歴が残っていなかったため、いつから壊れていたかは特定できませんでした。
今回確認できた原因は、JSON文字列に生の改行を入れていたこと、実行場所が古いままだったこと、変更の集計対象が足りなかったことです。フックは失敗しても作業が止まらず、私もエラーを見て初めて確認しました。動作が止まらないことは、正常に動いている証拠にはなりません。
同じことで困ったら
- エラー文に
Unterminated stringがあるか確認する。 - JSONを作る部分で
printfの%bを使っているか確認する。 - 処理の最初の
cdが前の環境の場所に固定されていないか確認する。 -
git diff --name-onlyだけでなく、ステージ済みと未追跡のファイルも数えているか確認する。 - 引用符、バックスラッシュ、改行、日本語、空白を含むファイル名で出力を確かめる。