Skip to content

脚本错误量极致优化-让脚本错误一目了然 #14

@joeyguo

Description

@joeyguo
Owner

原文地址

在上篇《脚本错误量极致优化-监控上报与Script error》 中,主要提到了js脚本错误上报的方式,并讲解了如何使用 crossorigin 来解决 Script error 报错信息的方案,于是我们就可以查看到脚本报错信息了。而此时可能会遇到另一个问题:”JS 代码压缩后,定位具体出错代码困难!“。本篇《脚本错误量极致优化-让脚本错误一目了然》 将结合示例,通过多种解决方案逐一分析,让脚本错误 一目了然。

示例 · 压缩代码定位错误困难

1.源代码(存在错误)

function test() {
    noerror // <- 报错
}

test();

2.经 webpack 打包压缩后产生如下代码

!function(n){function r(e){if(t[e])return t[e].exports;var o=t[e]={i:e,l:!1,exports:{}};return n[e].call(o.exports,o,o.exports,r),o.l=!0,o.exports}var t={};r.m=n,r.c=t,r.i=function(n){return n},r.d=function(n,t,e){r.o(n,t)||Object.defineProperty(n,t,{configurable:!1,enumerable:!0,get:e})},r.n=function(n){var t=n&&n.__esModule?function(){return n.default}:function(){return n};return r.d(t,"a",t),t},r.o=function(n,r){return Object.prototype.hasOwnProperty.call(n,r)},r.p="",r(r.s=0)}([function(n,r){function t(){noerror}t()}]);

3.代码如期报错,并上报相关信息

{ msg: 'Uncaught ReferenceError: noerror is not defined',
  url: 'http://127.0.0.1:8077/main.min.js',
  row: '1',
  col: '515' }

此时,错误信息中行列数为 1 和 515。 结合压缩后的代码,肉眼观察很难定位出具体问题。

如何定位到具体错误

方案一:不压缩 js 代码

这种方式简单粗暴,但存在明显问题:1. 源代码泄漏,2. 文件的大小大大增加。

方案二:将压缩代码中分号变成换行

uglifyjs 有一个叫 semicolons 配置参数,设置为 false 时,会将压缩代码中的分号替换为换行符,提高代码可读性, 如

!function(n){function r(e){if(t[e])return t[e].exports
var o=t[e]={i:e,l:!1,exports:{}}
return n[e].call(o.exports,o,o.exports,r),o.l=!0,o.exports}var t={}
r.m=n,r.c=t,r.i=function(n){return n},r.d=function(n,t,e){r.o(n,t)||Object.defineProperty(n,t,{configurable:!1,enumerable:!0,get:e})},r.n=function(n){var t=n&&n.__esModule?function(){return n.default}:function(){return n}
return r.d(t,"a",t),t},r.o=function(n,r){return Object.prototype.hasOwnProperty.call(n,r)},r.p="",r(r.s=0)}([function(n,r){function t(){noerror}t()}])

此时,错误信息中行列数为 5 和 137,查找起来比普通压缩方便不少。但仍会出现一行中有很多代码,不容易定位的问题。

方案三:js 代码半压缩 · 保留空格和换行

uglifyjs 的另一配置参数 beautify 设置为 true 时,最终代码将呈现压缩后进行格式化的效果(保留空格和换行),如

!function(n) {
    // ...
    // ...
}([ function(n, r) {
    function t() {
        noerror;
    }
    t();
} ]);

此时,错误信息中行列数为 32 和 9,能够快速定位到具体位置,进而对应到源代码。但由于增加了换行和空格,所以文件大小有所增加。

方案四:SourceMap 快速定位

SourceMap 是一个信息文件,存储着源文件的信息及源文件与处理后文件的映射关系。

在定位压缩代码的报错时,可以通过错误信息的行列数与对应的 SourceMap 文件,处理后得到源文件的具体错误信息。

sourcemap_1

SourceMap 文件中的 sourcesContent 字段对应源代码内容,不希望将 SourceMap 文件发布到外网上,而是将其存储到脚本错误处理平台上,只用在处理脚本错误中。

通过 SourceMap 文件可以得到源文件的具体错误信息,结合 sourcesContent 上源文件的内容进行可视化展示,让报错信息一目了然!

基于 SourceMap 快速定位脚本报错方案

sourcemap_2

整套方案的代码实现可以在这 noerror 查看,效果如下

sourcemap-noerror

1.左边的为线上页面,上报脚本错误
2.右边的为 noerror 脚本错误监控系统

此时,错误信息中行列数为 1 和 515。 结合 sourcemap,经处理(source-map)后,拿到对应的源文件上的具体错误信息,并进行展示。

方案五:开源方案 sentry

sentry 是一个实时的错误日志追踪和聚合平台,包含了上面 sourcemap 方案,并支持更多功能,如:错误调用栈,log 信息,issue管理,多项目,多用户,提供多种语言客户端等,具体介绍可以查看 getsentry/sentrysentry.io,这里暂不展开。

features-page-dash 1

总结

以上的方案都有各自使用场景,能够解决问题的方案都是好方案。可以先快速支持,然后逐渐过渡到完整的方案。除了本篇文章 提到的方案外,社区还有不少其他的优秀方案。

关于 sourceMap 文件的生成,通过 gulp,webpack 都可以很好支持, noerror 的示例使用的是 webpack,只需要设置 devtool: "source-map",具体示例可以查看这里

查看更多文章 >>
https://github.com/joeyguo/blog

Activity

EthanLin-TWer

EthanLin-TWer commented on May 3, 2017

@EthanLin-TWer

关于方案一:不压缩 JS。前几天才发现一个工具,直接把 minify + uglify 过的 JS 代码通过机器学习还原出来,虽然效果不一定很好:http://jsnice.org/

yuyang2016

yuyang2016 commented on May 8, 2017

@yuyang2016

老师您好,我是https://sdk.cn 编辑于洋,希望转载这篇文章到我们网站上,请您放心我们会严格遵守转载规范,注明作者和出处,希望能得到老师的授权。

joeyguo

joeyguo commented on May 8, 2017

@joeyguo
OwnerAuthor

@yuyang2016 可以哈

yuyang2016

yuyang2016 commented on May 8, 2017

@yuyang2016

谢谢老师!

pengxiang-git

pengxiang-git commented on Jun 20, 2017

@pengxiang-git

方案五:开源方案 sentry,能介绍下吗

guoxiangwen

guoxiangwen commented on Jun 27, 2017

@guoxiangwen

如果要做成一个通用的错误脚本监控,怎么实施呢,比如嵌入脚本,而且监控的网站是不会让你动代码的。

pengkobe

pengkobe commented on Jun 29, 2017

@pengkobe

@joeyguo 哥,你的图画的极其好看,求告知下画图工具是哪个哈~

joeyguo

joeyguo commented on Jul 1, 2017

@joeyguo
OwnerAuthor

@guoxiangwen 嵌入脚本是为了能够上报错误信息,所以是必须的。如果无法更改项目代码的话,可以在用代理的方式在资源返回前插入上报脚本(不推荐)。

joeyguo

joeyguo commented on Jul 1, 2017

@joeyguo
OwnerAuthor

@pengkobe hi,上面那些是在keynote上制作的

joeyguo

joeyguo commented on Jul 1, 2017

@joeyguo
OwnerAuthor

@pengxianggithub sentry 的文档挺全的,不妨先看看 https://sentry.io/welcome/

ImTomy

ImTomy commented on Jul 10, 2017

@ImTomy

global code@ 类似于这种问题,是js error捕获的api层面错误吗?貌似网上相关的文档很少

cgkoreyoshi

cgkoreyoshi commented on Dec 13, 2017

@cgkoreyoshi

写得不错,图也画的很好

6 remaining items

joeyguo

joeyguo commented on Nov 14, 2018

@joeyguo
OwnerAuthor

@ganyouyin 已fix

hucheng91

hucheng91 commented on Apr 11, 2019

@hucheng91

要是 vue 怎么弄呀

Vue.config.errorHandler = function(err, vm, info) {}
这里没有返回行号和列

hucheng91

hucheng91 commented on Apr 11, 2019

@hucheng91

要是 vue 怎么弄呀

Vue.config.errorHandler = function(err, vm, info) {}
这里没有返回行号和列

hucheng91

hucheng91 commented on Apr 11, 2019

@hucheng91

还原后的文件

期待的代码

export default {
  name: "app",
  components: {},
  data() {
    return {
      value: 1234689
    };
  },
  methods: {
    test(){
      throw new Error("老哥,报错了呀")
    }
  }
};
hucheng91

hucheng91 commented on Apr 13, 2019

@hucheng91

好了,是我自己的一个问题

huruji

huruji commented on Apr 18, 2019

@huruji

m

Lionad-Morotar

Lionad-Morotar commented on Jul 1, 2020

@Lionad-Morotar

关于方案一:不压缩 JS。前几天才发现一个工具,直接把 minify + uglify 过的 JS 代码通过机器学习还原出来,虽然效果不一定很好:http://jsnice.org/

主要是靠注释和名字比对生成的代码,几乎零实用性
image

sisterAn

sisterAn commented on Aug 27, 2020

@sisterAn

你好,可以转载到公众号高级前端进阶上吗?会标明作者与来源,感谢

yingzidd12

yingzidd12 commented on Aug 27, 2020

@yingzidd12
joeyguo

joeyguo commented on Aug 31, 2020

@joeyguo
OwnerAuthor

你好,可以转载到公众号高级前端进阶上吗?会标明作者与来源,感谢

@sisterAn 可以。

foreverwang

foreverwang commented on Feb 11, 2021

@foreverwang

还原后的文件

期待的代码

export default {
  name: "app",
  components: {},
  data() {
    return {
      value: 1234689
    };
  },
  methods: {
    test(){
      throw new Error("老哥,报错了呀")
    }
  }
};

这种可视化展示是怎么做的

liuxsen

liuxsen commented on Mar 2, 2021

@liuxsen

要是 vue 怎么弄呀

Vue.config.errorHandler = function(err, vm, info) {}
这里没有返回行号和列

怎么处理的呢,我遇到了相同的问题

DBAAZzz

DBAAZzz commented on Nov 4, 2021

@DBAAZzz

要是 vue 怎么弄呀
Vue.config.errorHandler = function(err, vm, info) {}
这里没有返回行号和列

怎么处理的呢,我遇到了相同的问题

把 err.stack.toString() 上报到服务器,然后在服务器上打印就能看到完整信息了,原来是浏览器自动转码了,如果把开发者工具的 sourcemap 开启的话连行号和文件都看不到。
来源:http://www.javashuo.com/article/p-yqcmwniq-bv.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @yingzidd12@ganyouyin@guoxiangwen@pengkobe@joeyguo

        Issue actions

          脚本错误量极致优化-让脚本错误一目了然 · Issue #14 · joeyguo/blog