修正を入れた版を配信して数日たった朝、クラッシュの一覧を開きました。いちばん多かった例外が、そのまま一番上に座っていました。件数は減るどころか、少しずつ増えていました。
壁紙アプリの Android 版での出来事です。ページ送りの部品の内側で起きる例外が、当時のクラッシュの大半を占めていました。その対策を入れた版で、debug の実機では何度ページをはじいても落ちなくなっていたのです。
それなのに、本番では減りませんでした。別の経路があるのだろう、と考えたくなる場面でした。実際には、修正そのものが本番でだけ丸ごと無効になっていたのです。
壊れないように引き下がる処理には、引き下がったことを必ず外へ知らせてもらいます。 今回いちばん強く残った線引きは、この一文でした。この経験を、Expo で作る Android アプリに置き換えて書き残します。
何が起きていたのか
修正は、ページ送り部品の内部にある「並べ方の担当」を、例外を握りつぶす版に差し替えるものでした。内部の部品なので公開された差し替え口はありません。そこで、内部フィールドを名前で探してリフレクションで入れ替えていました。
差し替えに失敗したときのために、元の担当へ戻す処理も入れていました。アプリを落とさないための、ごく普通の安全策です。
release ビルドでは R8 がクラスやフィールドの名前を短い名前へ変えます。名前で探していたフィールドは見つからず、安全策が働いて元の担当へ戻りました。アプリは落ちません。ただ、修正も効いていません。そして、そのことを知らせる手段がどこにもありませんでした。
debug では R8 が走らないので、名前はそのまま残ります。だから実機検証では正しく動いて見えたのです。
最後の行がいちばんの問題でした。どちらのビルドでも、修正が効いているかどうかを外から確かめる手段がなかったのです。
Expo のプロジェクトで同じことが起きる場所
Expo の Android でも、release で縮小を有効にした時点から、debug と release の差が生まれます。プロジェクトによっては既定で無効なので、自分の設定を一度確かめておくと安心です。
縮小が有効なときに、名前に頼っている箇所が危うくなります。
- 設定プラグインやネイティブモジュールの中で、ライブラリ内部のフィールドやメソッドを名前で引いている箇所
Class.forName に文字列でクラス名を渡している箇所
- 文字列から資源の ID を引いている箇所(これは以前 release の起動だけ資源が見つからずに落ちた件 で書いた別の穴です)
JavaScript 側にも似た差があります。if (__DEV__) の中に書いた処理は、release のバンドルからは取り除かれます。開発中だけ有効な分岐に修正を置いてしまうと、本番では存在しない修正になります。
名前ではなく型で探す
私自身が最終的に採った直し方は、フィールドを型で探すことでした。クラスそのものの比較は、名前を変えられても崩れません。
ただし、同じ型のフィールドが二つあると、どちらを掴んだのか分からなくなります。そこで「ちょうど一つだけ見つかったときに限って成功」とし、それ以外は失敗として扱いました。
import java.lang.reflect.Field
/**
* owner クラス(と親クラス)から、type に代入できるフィールドを探す。
* ちょうど1つのときだけ返し、0個・2個以上なら null を返す。
* 名前ではなく型で探すので、R8 による改名の影響を受けない。
*/
fun findSingleFieldByType(owner: Class<*>, type: Class<*>): Field? {
val hits = mutableListOf<Field>()
var c: Class<*>? = owner
while (c != null && c != Any::class.java) {
for (f in c.declaredFields) {
if (type.isAssignableFrom(f.type)) hits.add(f)
}
c = c.superclass
}
if (hits.size != 1) return null // 曖昧なら掴まない。失敗として扱う
return hits[0].apply { isAccessible = true }
}
型で探すように変えたあとも、保険として縮小の設定に名前を残す指定を足しました。Expo では expo-build-properties の extraProguardRules で書けます。prebuild をやり直しても消えません。
{
"expo": {
"plugins": [
[
"expo-build-properties",
{
"android": {
"extraProguardRules": "-keepclassmembernames class androidx.viewpager2.widget.ViewPager2 { <fields>; }"
}
}
]
]
}
}
-keepclassmembernames は、メンバーを削除から守るのではなく、残ったメンバーの名前を変えさせない指定です。消えるのを止めたいのか、改名を止めたいのかで指定が変わります。対象のクラスは、ご自身が手を入れている部品に合わせて置き換えてください。
私は、この指定を主役ではなく保険だと考えています。ライブラリの更新でフィールドの名前そのものが変われば、守った名前は役に立たなくなるからです。
修正に「効いている印」を持たせる
ここからが本題です。型で探す直し方は、今回の穴をふさぎます。けれども次の修正が別の理由で効かなくなったとき、また数週間気づけないかもしれません。
そこで、修正ごとに「本番で有効になったか」をクラッシュレポートのキーと端末ログの両方へ書く小さな部品を作りました。クラッシュが起きたとき、その瞬間のキーが一緒に届きます。
import android.util.Log
import com.google.firebase.crashlytics.FirebaseCrashlytics
/**
* 修正ごとの「効いている印」を記録する。
* - Crashlytics のカスタムキー: 本番のクラッシュと一緒に届く
* - logcat(タグ FixFlags): release を手元で起動して確かめる用
*/
object FixFlags {
private const val TAG = "FixFlags"
fun record(id: String, active: Boolean, detail: String = "") {
val key = "fix_$id" // 例: fix_pager_guard
try {
FirebaseCrashlytics.getInstance().setCustomKey(key, active)
if (detail.isNotEmpty()) {
FirebaseCrashlytics.getInstance().setCustomKey("${key}_why", detail.take(100))
}
} catch (t: Throwable) {
// 記録の失敗で本体を巻き込まない
}
Log.i(TAG, "$key=$active ${detail.take(100)}")
}
}
呼び出し側では、安全策で引き下がった枝の中で必ず false を書きます。ここを書き忘れると、元の「黙って戻る」形に逆戻りします。
import androidx.recyclerview.widget.RecyclerView
import androidx.viewpager2.widget.ViewPager2
fun installPagerGuard(pager: ViewPager2) {
val field = findSingleFieldByType(ViewPager2::class.java, RecyclerView.LayoutManager::class.java)
if (field == null) {
FixFlags.record("pager_guard", false, "field not resolved")
return // 元の担当のまま続ける。ただし、引き下がったことは記録済み
}
try {
// ここで差し替える(中身は各自の修正に置き換え)
FixFlags.record("pager_guard", true)
} catch (t: Throwable) {
FixFlags.record("pager_guard", false, t.javaClass.simpleName)
}
}
detail には例外のクラス名のような短い手がかりだけを入れます。端末の情報や利用者に結びつく値は入れません。
JavaScript 側の修正にも同じ印を
React Native の層で入れた回避策も、同じ考え方で記録できます。@react-native-firebase/crashlytics を使っている場合は、属性として送れます。
import crashlytics from '@react-native-firebase/crashlytics';
/** JS 側の回避策が本番で有効になったかを記録する */
export async function recordFix(id: string, active: boolean, detail = '') {
const key = `fix_${id}`;
try {
await crashlytics().setAttribute(key, String(active));
if (detail) await crashlytics().setAttribute(`${key}_why`, detail.slice(0, 100));
} catch {
// 記録の失敗は無視する(本体を止めない)
}
console.info(`[FixFlags] ${key}=${active}`);
}
// 例: 回避策を __DEV__ の外で適用し、適用できたかを記録する
export function applyListGuard(listRef: { current: unknown }) {
const ok = listRef.current != null;
void recordFix('list_guard', ok, ok ? '' : 'ref missing');
return ok;
}
ここで気をつけたいのは、recordFix を呼ぶ場所が if (__DEV__) の内側に入っていないことです。印まで開発中だけのものになれば、本番では何も分かりません。
release を手元で起動して、印を確かめる
本番に出す前に、release ビルドを実機かエミュレータで一度起動し、印がそろっているかをログから確かめます。期待する印の一覧を書いておき、足りないもの・false のものがあれば失敗にします。
#!/usr/bin/env bash
# release ビルドを起動したあと、FixFlags の印がすべて true かを確かめる
# 使い方: ./check-fix-flags.sh pager_guard list_guard
set -euo pipefail
[ "$#" -ge 1 ] || { echo "期待する印の id を1つ以上指定してください"; exit 2; }
# 直前のログを消してから、起動と画面操作を済ませる
adb logcat -c
echo "アプリを起動し、修正に関わる画面を一度通してから Enter を押してください"
read -r _
LOG="$(adb logcat -d -s FixFlags:I ReactNativeJS:I)"
FAIL=0
for id in "$@"; do
line="$(printf '%s\n' "$LOG" | grep -E "fix_${id}=" | tail -1 || true)"
if [ -z "$line" ]; then
echo "NG fix_${id}: 記録が見つかりません(呼び出しが release に入っていない可能性)"; FAIL=1
elif printf '%s' "$line" | grep -q "fix_${id}=true"; then
echo "OK fix_${id}"
else
echo "NG fix_${id}: ${line##*FixFlags*: }"; FAIL=1
fi
done
exit "$FAIL"
adb logcat -s はタグで絞り込みます。React Native の console 出力は、通常 ReactNativeJS のタグで logcat に出ます。release で console を取り除く設定を入れている場合は出ないので、そのときは JS 側の印をクラッシュレポートの属性で確かめます。
ビルドは npx expo run:android --variant release で作れます。debug でこのスクリプトが通っても、意味はほとんどありません。必ず release で通すことが肝心です。
本番でキーをどう読むか
配信後は、残っている例外のイベントを開き、キーの欄を見ます。読み方は二通りしかありません。
今回の件では、型で探す形にした版を配信したあと、その例外は新しい版の上では出なくなりました。同時にキーも入れていたので、もし残っていたとしても「効いていないのか、別の経路か」をその日のうちに分けられる状態でした。件数が減るのを待つだけの数週間に比べると、気持ちの軽さがまるで違います。
印を入れるときの落とし穴
印を書く位置が遅すぎる
差し替えの直後に書かないと、印を書く前に落ちたイベントにはキーが付きません。修正の適用と同じ関数の中で書きます。
安全策の枝で false を書き忘れる
成功時だけ true を書く形だと、失敗時は「キーなし」になり、古い版と区別できません。失敗の枝こそ必ず書きます。
同じ型のフィールドが増える
ライブラリの更新で同じ型のフィールドが足されると、型での解決も曖昧になります。この場合は、上のコードが失敗として扱うので、印が false になって気づけます。
キーを増やしすぎる
Crashlytics のカスタムキーは数に上限があります。修正一つにキー一つ(と理由のキー一つ)にとどめ、役目を終えた印は次の版で外します。印を外すときは、理由を一行だけ変更履歴に残しておくと、あとで同じ印を探し回らずに済みます。
true を「直った」と読む
印は「修正が適用された」ことしか示しません。直ったかどうかは、適用された版で例外が消えたかで判断します。
明日、最初にやること
手順は三つだけです。
- 自分のプロジェクトで「失敗したら元に戻す」「見つからなければ何もしない」と書いた箇所を、一つだけ探します。
- その枝と成功の枝の両方に、印を書く一行を足します。
- release ビルドで一度だけ起動し、ログに
true が出るかを確かめます。
これだけで、次に同じ形の穴を踏んだとき、数週間ではなく一日で気づけます。
落ちないための安全策は、利用者を守るために欠かせません。ただ、黙って引き下がる安全策は、作り手からは失敗を隠してしまいます。個人開発で見てくれる人が自分しかいないからこそ、引き下がったことだけは必ず外へ知らせる形にしています。