问题描述

在应用实时监控服务ARMS中“Script error.”是一个常见错误,但由于该错误不提供完整的报错信息(错误堆栈),因此无法定位问题。本文提供了该错误的解决方法。

问题原因

“Script error.”有时也被称为跨域错误。当网站请求并执行一个托管在第三方域名下的脚本时,就可能遇到该错误。最常见的情形是使用CDN托管JS资源。为了更好地理解,假设以下HTML页面部署在http://test.com域名下:

<!doctype html>
<html>
<head>
  <title>Test page in http://test.com</title>
</head>
<body>
  <script src="http://another-domain.com/app.js"></script>
  <script>
  window.onerror = function (message, url, line, column, error) {
    console.log(message, url, line, column, error);
  }
  foo(); // 调用app.js中定义的foo方法。
  </script>
</body>
</html>

假设foo方法调用了一个未定义的bar方法:

// another-domain.com/app.js
function foo() {
  bar(); // ReferenceError: bar is not a function
}

页面运行之后,捕获到的异常信息如下:

"Script error.", "", 0, 0, undefined

其实这并不是一个JavaScript Bug。出于安全考虑,浏览器会刻意隐藏其他域的JS文件抛出的具体错误信息,这样做可以有效避免敏感信息无意中被不受控制的第三方脚本捕获。因此,浏览器只允许同域下的脚本捕获具体错误信息,而其他脚本只知道发生了一个错误,但无法获知错误的具体内容。更多信息,请参见Webkit源码

 bool ScriptExecutionContext::sanitizeScriptError(String& errorMessage, int& lineNumber, String& sourceURL)
    {
        KURL targetURL = completeURL(sourceURL);
        if (securityOrigin()->canRequest(targetURL))
            return false;
        errorMessage = "Script error.";
        sourceURL = String();
        lineNumber = 0;
        return true;
    }

解决方案

解法1:开启跨域资源共享CORS(Cross Origin Resource Sharing)

为了跨域捕获JavaScript异常,可执行以下两个步骤:

  1. 添加crossorigin="anonymous"属性。
    <script src="http://another-domain.com/app.js" crossorigin="anonymous"></script>
    说明:此步骤的作用是告知浏览器以匿名方式获取目标脚本。这意味着请求脚本时不会向服务端发送潜在的用户身份信息(例如Cookies、HTTP证书等)。
  2. 添加跨域HTTP响应头。
    Access-Control-Allow-Origin: * 
    或者
    Access-Control-Allow-Origin: http://test.com
    说明 大部分主流CDN默认添加了 Access-Control-Allow-Origin 属性。以下是阿里云CDN的示例:
    curl --head https://retcode.alicdn.com/retcode/bl.js | grep -i "access-control-allow-origin"
    系统显示类似如下:
    => access-control-allow-origin: *
  3. 完成上述两步之后,即可通过window.onerror捕获跨域脚本的报错信息。回到之前的案例,页面重新运行后,捕获到的结果是:
    => "ReferenceError: bar is not defined", "http://another-domain.com/app.js", 2, 1, [Object Error]

(可选)解法2:try catch

无法在HTTP请求响应头中添加跨域属性时,还可以考虑try catch这个备选方案。

在之前的示例HTML页面中加入try catch:

<!doctype html>
<html>
<head>
  <title>Test page in http://test.com</title>
</head>
<body>
  <script src="http://another-domain.com/app.js"></script>
  <script>
  window.onerror = function (message, url, line, column, error) {
    console.log(message, url, line, column, error);
  }
  try {
    foo(); // 调用app.js中定义的foo方法
  } catch (e) {
    console.log(e);
    throw e;
  }
  </script>
</body>
</html>

再次运行,输出结果如下:

=> ReferenceError: bar is not defined
     at foo (http://another-domain.com/app.js:2:3)
     at http://test.com/:15:3
=> "Script error.", "", 0, 0, undefined

可见try catch中的Console语句输出了完整的信息,但window.onerror中只能捕获“Script error”,根据这个特点,可以在catch语句中手动上报捕获的异常,更多信息,请参见API

__bl.error(error, pos);
说明 :尽管 try catch方法可以捕获部分异常,但推荐采用 解法1

如何在ARMS中忽略“Script error.”

“Script error.”往往来源于第三方域名下的脚本,如果不影响应用的运行,您可以选择通过ARMS前端监控的SDK参数ignore忽略该错误。关于SDK的更多信息,请参考SDKignore可忽略指定JS错误的上报,其配置项的值是一个对象,包含3个属性:ignoreUrlsignoreApisignoreErrors。默认值如下:

ignore: {
    ignoreUrls: [],
    ignoreApis: [],
    ignoreErrors: []
},

针对“Script error.”,使用ignoreErrors即可。ignoreErrors表示忽略某些JS错误,符合该规则的JS错误不会上报。值可以是StringRegExpFunction或者以上三种类型组成的数组。示例如下:

__bl.setConfig({
    ignore: {
        ignoreErrors: /^Script error\.?$/
    }
});

适用于

  • 应用实时监控服务ARMS