istanbul-middleware

istanbul-middleware

istanbul-middleware（后面简称 middleware）本质上是一个基于 express 的网站。但其包含了数个针对 istanbul 覆盖率收集及报告生成的 http 接口，因此可用于作为单独的覆盖率报告生成网站。

• 覆盖率相关接口信息（基础路径为 coverage ，如重置覆盖率数据，需要访问的路径是 http://localhost/coverage/reset ）：

URL	Description
GET /	动态生成覆盖率 html 报告。和平时单测生成的静态版本一样，可以通过点击逐级深入，查看更细节的覆盖率数据。
POST /reset	把覆盖率数据重置成基线（可以理解成清空当前覆盖率数据）
GET /download	下载一个包含 json 、lcov、html 三种格式覆盖率报告的压缩包
POST /client	用于从浏览器主动发送覆盖率对象。覆盖率对象必须是 json 格式，且发送时 header 中必须有 Content-type: application/json 。这个对象需要和当前服务端已有的统计数据保持一致。补充：即不能把不同程序的覆盖率数据都一起发给同一个 middleware 服务端。

• 覆盖率收集的两种方式
  • middleware 支持 server 端的覆盖率数据收集。
  • middleware 支持 browser 端的覆盖率数据收集。

server 端

• 通过 hook require 方法，自动在运行时给 server 端文件插桩。同时添加 /coverage 路径的 handler ，处理上述的覆盖率接口请求。
• 核心方法：im.hookLoader(__dirname);，app.use('/coverage', im.createHandler());

项目运行分析

通过打断点的方式来查看server端自动插装过程

• 项目debug模式运行，首先通过hookLoader传入两个参数，第一个参数主要匹配除了node_modules外其他全部需要插装的问价路径，第二个参数主要是插装的一些配置选项
• hookLoader中加入Instrumenter对象，然后通过本地方法instrumenter.instrumentSync.bind(instrumenter)获得一个transformer(本地方法),把相关参数传入,postLoadHook(matcherFn, transformer, opts.verbose)获得postLoadHookFn
• 通过hook.hookRequire（本地方法）的方法对服务端代码进行插装，通过postLoadHook,postLoadHookFn传入相关js文件，通过saveBaseline函数对插装的函数进行保存，在saveBaseline中baselineCoverage可以获得插装后的js文件信息

function saveBaseline(file) {
    var coverageObject = getCoverageObject(),
        fileCoverage;
    if (coverageObject && coverageObject[file]) {
        fileCoverage = coverageObject[file];
        if (!baselineCoverage[file]) {
            baselineCoverage[file] = {
                s: clone(fileCoverage.s),
                f: clone(fileCoverage.f),
                b: clone(fileCoverage.b)
            };
        }
    }
}

• 通过在server端调用app.use('/coverage', im.createHandler()); 渲染相关接口页面，并提供相关接口。
• 在clientHandler中可以通过res.send(instrumented);把插装后的代码数据上传

try {
    instrumented = core.getInstrumenter().instrumentSync(contents, fullPath);
    if (verbose) { console.log('Sending instrumented code for: ' + fullPath + ', url:' + req.url); }
    res.setHeader('Content-type', 'application/javascript');
    return res.send(instrumented);
} catch (ex) {
    console.warn('Error instrumenting file:' + fullPath);
    return next();
}

• app.use(coverage.createClientHandler(publicDir, { matcher: matcher }));，返回app