nyc针对typescript代码插桩后出现keyof关键字与其他代码连接一起的问题分析

之前前端代码覆盖率一直用的babel-istanbul-plugin, 但是这种方式的弊端非常的多。需要跟开发的编译逻辑结合在一起,一旦编译的框架有区别,就得花很大的时间精力在上边,并且还得去适配不同的babel的版本。所以这次乘着调研react-native, 尝试通过nyc的方式进行代码插桩。

nyc的插桩使用非常的方便, 如下即可

nyc instrument <input> [output]

所以我们通过 ./node_modules/.bin/nyc instrument ./src ./src --complete-copy --in-place 直接进行插桩处理。

image

嗯,看上去一切都很顺利。那我们直接就进入到编译的环节吧。

image

出错了,从错误提示上看错误的地方在第4行的2238列

image

这个地方报错了,对比源码的话, 会发现一个很奇怪的现象。我们可以看下源码 interface.ts

export type NamedStyles<T> = {
  [P in keyof T]: ViewStyle | TextStyle | ImageStyle;
};

然而插桩后的代码结果是

[P inkeyofT]: ViewStyle|TextStyle|ImageStyle;

keyof竟然跟前后的字符连接在了一起。

这是个很诡异的现象,重新检查了下其他插桩的文件,发现同样都有keyof的关键字的 都会出现这样子的问题。导致编译失败。

这个问题就比较棘手了,总不能插桩完后手动去修改keyof的。所以我们先得确定这个到底是什么原因,但是在确定什么原因前,可能还得先分析下这个问题到底是谁的问题,nyc? 还是babel。

所以我们来做一个实验。进入到nyc的instrumenter的源码中,去掉插桩的逻辑,只保留babel的解析跟生成,去除掉中间的转换,其实就是相当于babel讲代码转换成ast, 又转换回来了。我们来看看怎么验证这个。

const ast = parser.parse(code, {
      allowReturnOutsideFunction: opts.autoWrap,
      sourceType: opts.esModules ? 'module' : 'script',
      plugins: opts.parserPlugins
    });
    const ee = (0, _visitor.default)(t, filename, {
      coverageVariable: opts.coverageVariable,
      coverageGlobalScope: opts.coverageGlobalScope,
      coverageGlobalScopeFunc: opts.coverageGlobalScopeFunc,
      ignoreClassMethods: opts.ignoreClassMethods,
      inputSourceMap
    });
    let output = {};
    const visitor = {
      Program: {
        enter: ee.enter,

        exit(path) {
          output = ee.exit(path);
        }

      }
    };
    <!--(0, _traverse.default)(ast, visitor);-->
    const generateOptions = {
      compact: opts.compact,
      comments: opts.preserveComments,
      sourceMaps: opts.produceSourceMap,
      sourceFileName: filename
    };
    const codeMap = (0, _generator.default)(ast, generateOptions, code);

如上所示 我们注释掉travere的逻辑,再观察下这个时候的codeMap的结果是如何的。

image

从这里基本能够确定出来 babel的问题的可能性就非常大了。但是具体是babel的什么问题呢?

这里我们可能需要一个比较纯净的环境来验证下babel的问题。如下:

let ast = require("@babel/parser").parse("type NamedStyles<T> = { [P in keyof T]: ViewStyle | TextStyle | ImageStyle };", {
  // parse in strict mode and allow module declarations
  sourceType: "module",
  plugins: [
    // enable jsx and flow syntax
    "jsx",
    "typescript"
  ]
});
var generator =  require("@babel/generator")
const output = generator.default(ast, { /* options */})
console.log(output)

我们直接通过babel api的方式parse后,直接generator 的这个demo来看看效果。

结果。。

image

是正确的。 那问题出在哪里呢? 我们再仔细看下我们这个demo跟实际instrumenter的差别。 在demo里面我们的options实际上是空的,但是instrumenter的options实际上是

const generateOptions = {
  compact: opts.compact,
  comments: opts.preserveComments,
  sourceMaps: opts.produceSourceMap,
  sourceFileName: filename
};

我们关注下compact这个参数,这个从字面看应该是配置代码转换后是否压缩的意思。

所以我们再尝试修改下我们的demo将其中的options做一个赋值

let ast = require("@babel/parser").parse("type NamedStyles<T> = { [P in keyof T]: ViewStyle | TextStyle | ImageStyle };", {
  // parse in strict mode and allow module declarations
  sourceType: "module",
  plugins: [
    // enable jsx and flow syntax
    "jsx",
    "typescript"
  ]
});
var generator =  require("@babel/generator")
const output = generator.default(ast, {compact: true})
console.log(output)

再来看下结果:


image

问题真的出现了。 那是不是问题跟到这里就结束了呢,其实还没有,我们现在只是分析出来了,babel有问题,而且问题的地方应该就是开启compact后,generator的生成逻辑出现问题了,但是我们还是具体再确认下。

我们尝试断点调试跟下 generator的代码。

image

真正的逻辑就是在这个地方了,左侧我们能看到当前的转换后的buf的列表,目前来看一切正常,现在问题就是在解析typeof这个关键字的时候了。我们看下token的逻辑

token(str) {
    if (str === "--" && this.endsWith("!") || str[0] === "+" && this.endsWith("+") || str[0] === "-" && this.endsWith("-") || str[0] === "." && this._endsWithInteger ) {
      this._space();
    }

    this._maybeAddAuxComment();

    this._append(str);
 }

我们发现 我们传入的keyof 根本进入不到this._space()的逻辑中,所以这里就会注定我们的in 跟 typeof就会连接在一起了。
这个就是根本的原因了。

既然问题发现了 那就提一个issue给到babel官方吧
@babel/generator parse error with the typescript when use the keyof and enable the compact opts

英文水平有限,只能那么描述了。没想到问题一天左右就得到解决了。真的很速度。

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

推荐阅读更多精彩内容