update middlewares

Author: rohit-gohri

lib/common/common-utils.js

@@ -1,3 +1,5 @@
+const debug = require('debug')('code-coverage')
+
 // @ts-check
 function stringToArray(prop, obj) {
   if (typeof obj[prop] === 'string') {
@@ -62,6 +64,7 @@ const removePlaceholders = (coverage) => {
 }
 
 module.exports = {
+  debug,
   combineNycOptions,
   defaultNycOptions,
   fileCoveragePlaceholder,

lib/register/getCoverage.js renamed to lib/register/v8Interface.js

@@ -6,12 +6,12 @@ const { convertProfileCoverageToIstanbul } = require('../common/v8ToIstanbul')
  * @see https://github.com/bcoe/c8/issues/376
  * @see https://github.com/tapjs/processinfo/blob/33c72e547139630cde35a4126bb4575ad7157065/lib/register-coverage.cjs
  */
-const getCoverage = async () => {
+const takePreciseCoverage = async () => {
   return new Promise((resolve, reject) => {
-    session.post('Profiler.takePreciseCoverage', async (er, cov) => {
+    session.post('Profiler.takePreciseCoverage', async (err, cov) => {
       /* istanbul ignore next - something very strange and bad happened */
-      if (er) {
-        reject(er)
+      if (err) {
+        reject(err)
         return
       }
 
@@ -20,6 +20,21 @@ const getCoverage = async () => {
   })
 }
 
+const stopPreciseCoverage = async () => {
+  return new Promise((resolve, reject) => {
+    session.post('Profiler.stopPreciseCoverage', async (err) => {
+      /* istanbul ignore next - something very strange and bad happened */
+      if (err) {
+        reject(err)
+        return
+      }
+
+      resolve(null)
+    })
+  })
+}
+
 module.exports = {
-  getCoverage
+  takePreciseCoverage,
+  stopPreciseCoverage
 }

middleware/express.js

@@ -1,5 +1,6 @@
 // @ts-check
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
+const { debug } = require('../lib/common/common-utils');
 
 /**
  * for Express.js
@@ -12,24 +13,36 @@ const { isCoverageEnabled } = require('../lib/common/isEnabled')
  * require('cypress-code-coverage-v8/middleware/express')(app)
  * ```
  *
+ * Then add to your cypress.json an environment variable pointing at the API
+ * ```json
+ * {
+ *   "baseUrl": "http://localhost:3000",
+ *   "env": {
+ *     "codeCoverage": {
+ *       "api": "http://localhost:4000/__coverage__"
+ *     }
+ *   }
+ * }
+ * ```
+ * 
  * @param {import('express').Application} app
  */
 module.exports = (app) => {
+  if (!isCoverageEnabled()) {
+    debug('skipping express middleware, code coverage is not enabled')
+    return
+  }
+
+  const {
+    takePreciseCoverage
+  } = require('../lib/register/v8Interface')
+
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)
   app.get('/__coverage__', async (req, res, next) => {
-    if (!isCoverageEnabled()) {
-      res.json({
-        coverage: null
-      })
-      return
-    }
-
-    const { getCoverage } = require('../lib/register/getCoverage')
-
     try {
       res.json({
-        coverage: (await getCoverage()) || null
+        coverage: (await takePreciseCoverage()) || null
       })
     } catch (error) {
       return next(error)

middleware/hapi.js

@@ -1,5 +1,6 @@
 // @ts-check
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
+const { debug } = require('../lib/common/common-utils');
 
 /**
  * for Hapi.js
@@ -22,10 +23,29 @@ const { isCoverageEnabled } = require('../lib/common/isEnabled')
  *   console.log('Server running on %s', server.info.uri);
  * };
  * ```
+ * 
+ * Then add to your cypress.json an environment variable pointing at the API
+ * ```json
+ * {
+ *   "baseUrl": "http://localhost:3000",
+ *   "env": {
+ *     "codeCoverage": {
+ *       "api": "http://localhost:4000/__coverage__"
+ *     }
+ *   }
+ * }
+ * ```
  *
  * @param {import('@hapi/hapi').Server} server
  */
 module.exports = (server) => {
+  if (!isCoverageEnabled()) {
+    debug('skipping hapi middleware, code coverage is not enabled')
+    return
+  }
+
+  const { takePreciseCoverage } = require('../lib/register/v8Interface')
+
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)
 
@@ -34,15 +54,8 @@ module.exports = (server) => {
     method: 'GET',
     path: '/__coverage__',
     async handler() {
-      if (!isCoverageEnabled()) {
-        return {
-          coverage: null
-        }
-      }
-
-      const { getCoverage } = require('../lib/register/getCoverage')
 
-      return { coverage: (await getCoverage()) || null }
+      return { coverage: (await takePreciseCoverage()) || null }
     }
   })
 }

middleware/koa.js

@@ -1,38 +1,50 @@
 // @ts-check
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
+const { debug } = require('../lib/common/common-utils');
 
 /**
  * for Express.js
  *
  * @example Use like
+ * 
  * ```ts
  * require('cypress-code-coverage-v8/register');
  * const Koa = require('koa')
  * const app = new Koa();
  * // @see https://github.com/rohit-gohri/cypress-code-coverage-v8
  * require('cypress-code-coverage-v8/middleware/koa')(app)
  * ```
+ * 
+ * Then add to your cypress.json an environment variable pointing at the API
+ * ```json
+ * {
+ *   "baseUrl": "http://localhost:3000",
+ *   "env": {
+ *     "codeCoverage": {
+ *       "api": "http://localhost:4000/__coverage__"
+ *     }
+ *   }
+ * }
+ * ```
  *
  * @param {import('koa')} app
  */
 module.exports = (app) => {
+  if (!isCoverageEnabled()) {
+    debug('skipping koa middleware, code coverage is not enabled')
+    return
+  }
+
+  const { takePreciseCoverage } = require('../lib/register/v8Interface')
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)
   app.use(async (ctx, next) => {
     if (ctx.path !== '/__coverage__' && ctx.method !== 'GET') {
       return next()
     }
 
-    if (!isCoverageEnabled()) {
-      ctx.body = {
-        coverage: null
-      }
-      return
-    }
-
-    const { getCoverage } = require('../lib/register/getCoverage')
     ctx.body = {
-      coverage: (await getCoverage()) || null
+      coverage: (await takePreciseCoverage()) || null
     }
   })
 }

middleware/nextjs.js

@@ -1,40 +1,50 @@
+// @ts-check
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
 
+if (isCoverageEnabled()) {
+  require('../lib/register/register-node')
+}
+
 /**
  * Middleware for returning server-side code coverage
  * for Next.js API route. To use, create new `pages/api/coverage.js` file
  * and re-export this default middleware function.
  *
-  ```
-  // in your pages/api/coverage.js
-  module.exports = require('cypress-code-coverage-v8/middleware/nextjs')
-  
-  // then add to your cypress.json an environment variable pointing at the API
-  {
-    "baseUrl": "http://localhost:3000",
-    "env": {
-      "codeCoverage": {
-        "url": "/api/coverage"
-      }
-    }
-  }
-  ```
+ * @example in your pages/api/coverage.js
+ * ```ts
+ * module.exports = require('cypress-code-coverage-v8/middleware/nextjs')
+ * ```
+ * 
+ * Then add to your cypress.json an environment variable pointing at the API
+ * ```json
+ * {
+ *   "baseUrl": "http://localhost:3000",
+ *   "env": {
+ *     "codeCoverage": {
+ *       "ssr": "/api/coverage"
+ *     }
+ *   }
+ * }
+ * ```
  *
  * @see https://nextjs.org/docs#api-routes
  * @see https://github.com/rohit-gohri/cypress-code-coverage-v8
+ * 
+ * @param {import('next').NextApiRequest} _req
+ * @param {import('next').NextApiResponse} res
  */
-module.exports = async function returnCodeCoverageNext(req, res) {
+module.exports = async function returnCodeCoverageNext(_req, res) {
   if (!isCoverageEnabled()) {
     res.status(200).json({
       coverage: null
     })
     return
   }
 
-  const { getCoverage } = require('../lib/register/getCoverage')
+  const { takePreciseCoverage } = require('../lib/register/v8Interface')
 
   // only GET is supported
   res.status(200).json({
-    coverage: (await getCoverage()) || null
+    coverage: (await takePreciseCoverage()) || null
   })
 }