摘要 當應用程式出錯時,比較有心的產品會給使用者一個回報管道,讓錯誤資訊能回到開發者手上。本文示範如何在 JavaScript / Ajax 應用裡實作這樣一套機制。
如果能遠端連上使用者電腦的除錯器,客戶端的 JavaScript 錯誤其實很好查。現實是我們做不到,所以只能換一條路:讓使用者把我們修錯所需要的資訊送回來。
Mozilla 這類應用程式在崩潰時會啟動一個錯誤回報程式,詢問使用者是否願意提交報告。若願意,它會請使用者描述崩潰前做了什麼,把這些描述連同程式自己蒐集到的診斷資料一起送到收集端,供開發人員與產品經理分析。
這個設計對開發者的價值在於:那段程式是跑在使用者的機器上,而這往往是你唯一一次能取得「在自己環境裡無法重現」的錯誤資訊的機會。累積久了,你還能看出某一類錯誤的發生頻率與嚴重程度,據此決定先修哪一個。
本文要做的,就是把這個精神搬進 JavaScript / Ajax 應用:當程式碼裡發生錯誤時,跳出一個小提示,讓使用者可以選擇把錯誤資訊寄回來。
作法是把進入點包進一個包裝函式,這個包裝函式負責攔下所有例外,並在使用者身上開一個「回報」的入口。
function fun()
{
// 程式在這裡
}
fun = tb_wrap(fun);
關鍵就是那個 tb_wrap()。經過包裝之後,fun() 裡任何未處理的例外都會被攔下來交給我們處理,使用者不會看到瀏覽器醜陋的腳本錯誤視窗,而是看到一個可以選擇要不要回報的提示。
一個精簡的實作可以長得像這樣:
var tb_exceptions = [];
function tb_wrap(fun)
{
return function()
{
try
{
return fun.apply(this, arguments);
}
catch (e)
{
tb_exceptions.push(e);
tb_show_talkback_link();
}
};
}
攔到錯誤之後,要把能擠出來的消息都擠出來。送回去的診斷資料越完整,開發者找到並修掉它的機率就越高。
遺憾的是,不同瀏覽器的錯誤物件屬性並不一致。多數情況下 name 與 message 兩個屬性可以信賴;而 stack 屬性裡那串寶貴的呼叫堆疊,只有較新版本的 Mozilla 系瀏覽器才有。這意味著回報內容必須設計成「有多少收多少」,缺欄位時留白即可,不要因為取不到堆疊就整包放棄。
除了例外物件本身,還有幾個不花成本卻很有用的資訊值得一起帶上:目前的網址與查詢參數、使用者代理字串、以及觸發錯誤的那個動作。這些在後面的 mailto 內容裡都能派上用場。
最不需要基礎設施的回報管道,就是使用者的郵件程式。給他一個可以點的連結,讓他自己決定要不要麻煩一下;順便也避免了同一個錯誤被重複送出好幾份。
這個 mailto: 連結會開啟郵件軟體,並自動把標題與本文填好:
Subject: Error from https://myserver.com/myapp/index.cgi?id=234 Body: ReferenceError: nonexistent_variable is not defined fun_c()@https://myserver.com/myapp/index.cgi?id=234:19 fun_b()@https://myserver.com/myapp/index.cgi?id=234:14 fun_a()@https://myserver.com/myapp/index.cgi?id=234:9 apply(null, [object Object])@:0 ()@https://myserver.com/myapp/livedebug.js:106 onload([object Event])@:0 @:0
使用者可以在上面補任何他覺得可能有用的描述,然後按下寄送。這一步很重要——「我在按儲存之前改了哪個欄位」這類資訊,只有使用者知道。
整個機制可以收攏在三個函式裡:
tb_wrap(fun) 把函式 fun 包進一個能攔截例外的包裝層。發生例外時,它把錯誤物件推進例外清單,並叫出回報連結。若後續又發生更深的例外,就繼續往清單與連結裡追加。
tb_show_talkback_link() 顯示一個小型浮動視窗,內容類似「此頁面發生錯誤。若要回報此錯誤,請點這裡:回報錯誤」。這個視窗只在第一次發生例外時出現,並且會浮在其他內容之上。之後若再有例外,資訊會併入既有的 mailto 連結,不會重複跳出視窗騷擾使用者。
tb_set_link_contents() 每次拋出例外就把資訊追加到清單;接著掃過整份清單,把有用的欄位打包進 mailto 連結。連結第一次顯示之後就一直留在頁面上,讓使用者隨時可以回頭點它。
用 mailto 有個先天限制:本文長度會被郵件程式的 URI 上限截斷。堆疊很長時,記得保留最前面幾層(離錯誤點最近的那些),後面的丟掉也不心疼。
另一個要小心的是隱私。回報內容會經過使用者的郵件軟體,也就等於把頁面網址、可能的查詢參數都寫在明文裡。如果你的應用網址帶有工作階段識別碼或個資參數,應該先過濾掉再放進 mailto,並在視窗裡明白告訴使用者「這封信會包含哪些資訊」。
最後,別忘了節流。同一個錯誤在一個迴圈裡連續觸發幾百次,是相當常見的情況;例外清單應該有容量上限,浮動視窗也只出現一次。否則你收到的不是診斷報告,而是一封被塞爆的信。
JavaScript 與 Ajax 已經被大量用來打造功能豐富的應用,相對地,應用層級的支持機制也得跟上。本文這套小型回饋系統,目標是盡可能蒐集一次錯誤的完整樣貌,並給使用者一個 mailto 連結把資訊送回來;而使用者自己補充的那幾句話,往往才是真正破案的那把鑰匙。