如何尽可能早的捕获JS 异常?

背景

前段时间,超级会员的业务上线之后,总有人反馈它的会员落地页打不开了,打开就是空白。
空白页

反馈不多,但是总是有几个人持续在反馈.

用户ID:23,用户积分兑换页面进入总是进不去,好几天了。已经清理过缓存

严选|赖* 11:02:00
用户ID: 93
用户反馈切换网络,清理缓存,退出登录都是无法进入签到页面

起初是根据反馈人数不多,加载页面速度过快等 APM 数据,以为它的网络被劫持了。随着这批用户持续的反馈,

活动组|徐** 18:16:07用户反馈电脑和手机均无法进入带有会员活动的页面,试过了UC 华为自带 谷歌,客户说明都是已经试过了而且在公司使用公司网络其他同事可以点开,用其他手机登录自己账户就无法点开

从用户反馈的操作来看,初步排除用户被劫持。经过各种 traceId 和后端排查,确定是请求没有到后端、应该是前端很早的时候,JS 出错导致后续 JS 逻辑没有执行,应该和用户自己的数据有关系,那到底是什么数据呢?

如何定位 JS 异常信息

如果是和用户账号相关,有以下方式获取错误信息:

  1. 申请启用白名单,免密登录用户信息,在本地尝试复现—— 目前严选不支持此类免登服务
  2. 使用 APM 平台获取此用户 UID 相关信息—— 当时超会页面没有接入 APM,而且 APM 捕获的时机比较靠后,实际上是抓不到这种很早就出错的异常。
  3. 启用远程协助调试——严选没有,也没有业界可里参考的例子,最初的想法是需要用户人肉配合我们在他自己的手机上调试问题。

远程协助调试

构想是:我们编写一个和超会同域名的页面,让用户帮忙用 App 扫码打开,然后让用户把他看到的错误信息回传给我们,供我们分析,从而定位问题。根据定位问题的难易程度,定义了以下指标:

主要采集信息项

指标性 目的
1. JS 执行错误 用来排查是否有脚本错误。
2. response (html)源码 用来排查是否 html 被篡改
3. 所有 JS 的 response 用来排查 JS 劫持
4. 是否是缓存导致的问题 通过追加时间戳确认问题所在
5. 远程页面调试 遇到上述情况还没有解决的问题,需要启用 weinre 远程调试。

本文重点介绍下如何去捕获页面的脚本错误,思路如下:

  1. 使用 window.onerror来捕获脚本错误,参考来源, MDN GlobalEventHandlers,忽略个别不 bubble up 的错误异常。
window.onerror = function (msg, url, lineNo, columnNo, error) {
  var string = msg.toLowerCase();
  var substring = "script error";
  if (string.indexOf(substring) > -1){
    alert('Script Error: See Browser Console for Detail');
  } else {
    var message = [
      'Message: ' + msg,
      'URL: ' + url,
      'Line: ' + lineNo,
      'Column: ' + columnNo,
      'Error object: ' + JSON.stringify(error)
    ].join(' - ');

    alert(message);
  }

  return false;
};
  1. 考虑到超会页面脚本出错较早,一种方式是把以上脚本放在超会页面 html 页面结构的尽可能前面。但是问题1,究竟多前面才能算前面呢?放到 <head> 标签第一个元素吗?问题2,需要在原来的超会页面基础上添加调试代码,不够通用,如果是积分页面那又要改一遍吗?问题3,对真实页面 JS 加载有干扰。这种方案不行。
  2. 在 WKWebView 里注册 documentStart 时机的脚本。
WKUserScript *userScript = [[WKUserScript alloc] initWithSource:js injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES];
    [userContentController addUserScript:userScript];

这种方案的问题是,1. Android 不能用;2. 需要客户发版,不适合紧急调试;2. 对真实的页面加载有干扰,客户端和 h5 需要配合,不好控制。

终极方案

我们最后想到一种不用修改旧页面结构,不干扰真实页面加载,而且还能尽可能早,捕获一切 JS 异常的方案,堪称 JS 界的防侧漏—— 使用 iframe 加载来监听。核心代码如下,

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>页面故障白屏自助排查工具</title>
</head>

<body>
    <iframe id="iframe" name="iframe" src="<真实调试页面地址>"></iframe>
    <script>
        var h5Iframe = document.getElementById('iframe');
        h5Iframe.contentWindow.window.onerror = function iframe_onerror(msg, url, lineNo, columnNo, error) {
            var string = msg.toLowerCase();
            var substring = "script error";
            if (string.indexOf(substring) > -1) {
                alert('Script Error: See Browser Console for Detail');
            } else {
                var message = [
                    'Message: ' + msg,
                    'URL: ' + url,
                    'Line: ' + lineNo,
                    'Column: ' + columnNo,
                    'Error object: ' + JSON.stringify(error)
                ].join(' - ');

                alert(message);
            }

            return false;
        };
    </script>
</body>

</html>

只需要把包含代码的页面发送给用户,让用户打开(其实真实调试页面还包含了其他的排查问题手段)。在搭建好调试页面之后,我们通过电话回访联系到用户,让他实操了下,一打开页面就发现问题所在。

JS 异常
再经过其他文件分析,最后发现是在整个 html 骨架下面第一个 FreeMark 产生的 Script 脚本出错了。具体错误可见参考本文提供的 JSErrorCatch demo

总结

使用 在 WKWebView 里注册 documentStart 时机的脚本 的方案是扩展性比较好的 实现 APM 能力的方式,但不跨平台;使用 iframe 的方式不适合做日常的 APM 数据采集,而作为临时的远程协助调试能力是个不错的选择。

后续

本文旨在介绍一种简单实用捕获 JS 异常的方案。但它的目的是如何发现线上,个别用户的运行错误信息,不知道业界有没有合适的方案能分享,让我们学习一下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容