wip

Author: rohit-gohri

lib/common/sourceMap.js

@@ -6,7 +6,7 @@ const lineLengths = (f) =>
     .split(/\n|\u2028|\u2029/)
     .map((l) => l.length)
 
-export function getSources(f, url, sourceMapCache = {}) {
+function getSources(f, url, sourceMapCache = {}) {
   if (sourceMapCache[url]) {
     return sourceMapCache[url]
   }
@@ -37,3 +37,7 @@ export function getSources(f, url, sourceMapCache = {}) {
     return sources
   }
 }
+
+module.exports = {
+  getSources,
+}

lib/common/v8ToIstanbul.js

@@ -4,6 +4,7 @@ const { fileURLToPath } = require('url')
 const libCoverage = require('istanbul-lib-coverage')
 const v8toIstanbul = require('v8-to-istanbul')
 const { getSources } = require('./sourceMap')
+const { debug } = require('./common-utils');
 
 async function convertToIstanbul(obj, sourceMapCache = {}) {
   const file = fileURLToPath(obj.url)
@@ -27,13 +28,8 @@ function exists(filename) {
  * @see https://github.com/bcoe/c8/issues/376
  * @see https://github.com/tapjs/processinfo/blob/33c72e547139630cde35a4126bb4575ad7157065/lib/register-coverage.cjs
  */
-async function convertProfileCoverageToIstanbul(cov, { filename = '' } = {}) {
-  const previousCoverage = filename
-    ? (await exists(filename))
-      ? JSON.parse(await fs.readFile(filename, 'utf8'))
-      : undefined
-    : undefined
-  const map = libCoverage.createCoverageMap(previousCoverage)
+async function convertProfileCoverageToIstanbul(cov) {
+  const map = libCoverage.createCoverageMap()
   const sourceMapCache = (cov['source-map-cache'] = {})
 
   const coverages = await Promise.all(
@@ -56,9 +52,9 @@ async function convertProfileCoverageToIstanbul(cov, { filename = '' } = {}) {
   }, null)
 
   const result = map.toJSON()
-  if (filename) {
-    await fs.writeFile(filename, JSON.stringify(result, null, 2), 'utf8')
-  }
+  // if (filename) {
+  //   await fs.writeFile(filename, JSON.stringify(result, null, 2), 'utf8')
+  // }
   return result
 }
 

lib/plugin/chromeRemoteInterface.js

@@ -3,23 +3,19 @@
  * Based on
  * @see https://github.com/leftyio/v8-cypress-coverage-plugin/blob/master/src/plugin.js
  */
-const path = require('path')
 const ChromeRemoteInterface = require('chrome-remote-interface')
-const {
-  convertProfileCoverageToIstanbul
-} = require('../common/v8ToIstanbul')
-const { debug } = require('../common/common-utils');
-
+const { convertProfileCoverageToIstanbul } = require('../common/v8ToIstanbul')
+const { debug } = require('../common/common-utils')
 
 /**
  * @type {ChromeRemoteInterface.Client | null}
  */
 let client = null
 
-export function browserLaunchHandler(browser, launchOptions) {
+function browserLaunchHandler(browser, launchOptions) {
   if (browser.name !== 'chrome') {
     return debug(
-      ` Warning: An unsupported browser is used, output will not be logged to console: ${browser.name}`
+      `Warning: An unsupported browser is used, output will not be logged to console: ${browser.name}`
     )
   }
   // find how Cypress is going to control Chrome browser
@@ -51,34 +47,42 @@ export function browserLaunchHandler(browser, launchOptions) {
   tryConnect()
 }
 
-export async function startPreciseCoverage() {
+async function startPreciseCoverage() {
   if (!client) {
-    return
+    debug('no chrome client')
+    return null
   }
 
   await client.Profiler.enable()
   await client.Runtime.enable()
-  await client.Profiler.startPreciseCoverage({
+  return client.Profiler.startPreciseCoverage({
     callCount: true,
     detailed: true
   })
 }
 
-export function takePreciseCoverage() {
+function takePreciseCoverage() {
   if (!client) {
+    debug('no chrome client')
     return null
   }
 
   return client.Profiler.takePreciseCoverage().then((cov) =>
-    convertProfileCoverageToIstanbul(cov, {
-      filename: path.join('reports', 'v8_out.json')
-    })
+    convertProfileCoverageToIstanbul(cov)
   )
 }
 
-export function stopPreciseCoverage() {
+function stopPreciseCoverage() {
   if (!client) {
-    return
+    debug('no chrome client')
+    return null
   }
   return client.Profiler.stopPreciseCoverage()
 }
+
+module.exports = {
+  browserLaunchHandler,
+  startPreciseCoverage,
+  takePreciseCoverage,
+  stopPreciseCoverage
+}

lib/plugin/task.js

@@ -146,7 +146,7 @@ const tasks = {
    * with previously collected coverage.
    *
    * @param {string} sentCoverage Stringified coverage object sent by the test runner
-   * @returns {null} Nothing is returned from this task
+   * @returns {any} Updated coverage
    */
   combineCoverage(sentCoverage) {
     const coverage = JSON.parse(sentCoverage)
@@ -170,7 +170,7 @@ const tasks = {
     saveCoverage(coverageMap)
     debug('wrote coverage file %s', nycFilename)
 
-    return null
+    return JSON.stringify(coverageMap)
   },
 
   /**
@@ -234,16 +234,6 @@ const tasks = {
  * Registers code coverage collection and reporting tasks.
  * Sets an environment variable to tell the browser code that it can
  * send the coverage.
- * @example
-  ```
-    // your plugins file
-    module.exports = (on, config) => {
-      require('cypress-code-coverage-v8/task')(on, config)
-      // IMPORTANT to return the config object
-      // with the any changed environment variables
-      return config
-    }
-  ```
 */
 function registerCodeCoverageTasks(on, config) {
   on('task', tasks)

middleware/koa.js

@@ -21,7 +21,7 @@ const { debug } = require('../lib/common/common-utils');
  *   "baseUrl": "http://localhost:3000",
  *   "env": {
  *     "codeCoverage": {
- *       "api": "http://localhost:4000/__coverage__"
+ *       "api": "http://localhost:4000/api/__coverage__"
  *     }
  *   }
  * }
@@ -34,7 +34,8 @@ module.exports = (app) => {
     debug('skipping koa middleware, code coverage is not enabled')
     return
   }
-
+  debug('adding koa middleware, code coverage is enabled')
+  
   const { takePreciseCoverage } = require('../lib/register/v8Interface')
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)
@@ -43,6 +44,8 @@ module.exports = (app) => {
       return next()
     }
 
+    debug('taking precise coverage')
+
     ctx.body = {
       coverage: (await takePreciseCoverage()) || null
     }

middleware/nextjs.js

@@ -10,9 +10,10 @@ if (isCoverageEnabled()) {
  * for Next.js API route. To use, create new `pages/api/coverage.js` file
  * and re-export this default middleware function.
  *
- * @example in your pages/api/coverage.js
+ * @example in your pages/api/__coverage__.js
  * ```ts
- * module.exports = require('cypress-code-coverage-v8/middleware/nextjs')
+ * import coverageHandler from 'cypress-code-coverage-v8/middleware/nextjs';
+ * export default coverageHandler;
  * ```
  * 
  * Then add to your cypress.json an environment variable pointing at the API
@@ -21,7 +22,7 @@ if (isCoverageEnabled()) {
  *   "baseUrl": "http://localhost:3000",
  *   "env": {
  *     "codeCoverage": {
- *       "ssr": "/api/coverage"
+ *       "ssr": "/api/__coverage__"
  *     }
  *   }
  * }