由於網路、瀏覽器差異、快取等種種原因,線上執行的 JS 常常和開發環境不一樣,就會拋出異常。前端工程師對這種事早已司空見慣,但「如何記錄並利用這些錯誤」,關注的人卻不多。最近在構思一個方案,大致分成收集與使用兩步。
收集錯誤其實相當容易,因為各瀏覽器都提供了 window.onerror 這個入口:
window.onerror = function(errorMessage, scriptURL, lineNumber) {
alert(errorMessage, scriptURL, lineNumber)
}
甚至還能取得 Stack Trace,例如在 try/catch 中存取 e.stack(各瀏覽器格式不同,可用 eriwen/javascript-stacktrace 這個相容庫來抹平差異):
try {
fn()
} catch(e) {
alert(e.stack)
}
有兩個細節要注意:其一,使用 window.addEventListener('error', callback, isBubble) 時,callback 收到的第一個參數並不是 event,而是一個 Error 物件,這是個容易踩的坑;其二,用點運算子掛 window.onerror 意味著後掛的會覆蓋前面的,而這段監聽腳本理論上又必須放在所有 JS 最前面,因此要預先想清楚被覆蓋的風險(比較穩妥的寫法是用 addEventListener,並保留對既有 handler 的鏈式呼叫)。
之前在支付寶的時候,線上 JS 報錯會轉成一封郵件發給前端團隊,各自認領、各自修掉。這方案有它的好處——最基本的問題(立即響應、修掉)確實解決了。但還留下一個問題:如何避免同樣的錯誤再犯?我的初步構想是:
· 以 URL 為單位記錄同一頁面的報錯,方便統一處理。
· 每筆錯誤記錄包含 Page URL、User Agent、Script URL、Error Message、Line Number。
· 每個錯誤修完後,都能在同一處寫下解法,其他人可以評論、加分,最終沉澱成一個知識庫,並提供方便的 API 供查詢。
· 開發時,相同頁面觸發 window.onerror 時透過外掛比對 Error Message 與 URL,提醒開發者「前人已在此處跌倒過」。
· 開發者可訂閱知識庫的某些標籤,自動收到通知(若搭配 source map 或程式碼註釋做更精細的配對會更好)。
這樣做主要是為了解決三件事:形成知識庫讓團隊(特別是新人)得以累積學習;用工具保證效率並避免重複造輪;訂閱機制讓通知更有針對性,而不是每個人每天收一堆無關的錯誤信。
1、用 POST 發送。Error Message 有時很長,而瀏覽器對 URL 長度有限制。錯誤量少的話用 GET 還可以,但一般情況 POST 能把完整資料送到後台。
2、何時發送。建議在觸發 onerror 的當下就送。最早我試著在 onbeforeunload 時送,結果 POST 請求還沒 open 就被瀏覽器中斷了。
3、用什麼當索引。多數網站用 URL 就足夠,但像分類廣告、電商這類 UGC 比重高的網站,同一套程式碼會對應到大量不同 URL,可能需要變通(例如只取路徑而排除參數)。若改用 Error 本身當索引呢?兩種都可行,取決於需求。
4、是否記錄所有錯誤。這也該視情況而定。有些網站各種雜七雜八的報錯其實都來自外部廣告腳本,全部收進來只會淹掉真正該修的問題,適度的過濾與分類是必要的。
此外,報告到伺服器時務必避免把使用者輸入或頁面敏感內容一起送出,並對回傳的資料做基本驗證與限流,否則這個收集端點本身就會成為被濫用的入口。
目前初步做了一個收集工具(sofish/stacktrace.js)與配套的儲存方式,要不要繼續投入,還需要時間和更多驗證。先把想法丟出來,拋磚引玉。