tasks

Author: rohit-gohri

cypress-backend.json

@@ -3,7 +3,9 @@
   "integrationFolder": "cypress/test-backend",
   "env": {
     "codeCoverage": {
-      "url": "http://localhost:3003/__coverage__"
+      "timeout": 60000,
+      "url": "http://localhost:3003/__coverage__",
+      "ssr": "/api/__coverage__"
     }
   }
 }

lib/plugin/chromeRemoteInterface.js

@@ -0,0 +1,84 @@
+// @ts-check
+/**
+ * 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');
+
+
+/**
+ * @type {ChromeRemoteInterface.Client | null}
+ */
+let client = null
+
+export 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}`
+    )
+  }
+  // find how Cypress is going to control Chrome browser
+  const rdpArgument = launchOptions.args.find((arg) =>
+    arg.startsWith('--remote-debugging-port')
+  )
+  if (!rdpArgument) {
+    return debug(
+      `Could not find launch argument that starts with --remote-debugging-port`
+    )
+  }
+  const rdpPort = Number.parseInt(rdpArgument.split('=')[1])
+  const tryConnect = () => {
+    return ChromeRemoteInterface({
+      port: rdpPort
+    })
+      .then((newClient) => {
+        client = newClient
+        client.on('disconnect', () => {
+          client = null
+        })
+      })
+      .catch(() => {
+        client = null
+        setTimeout(tryConnect, 100)
+      })
+  }
+
+  tryConnect()
+}
+
+export async function startPreciseCoverage() {
+  if (!client) {
+    return
+  }
+
+  await client.Profiler.enable()
+  await client.Runtime.enable()
+  await client.Profiler.startPreciseCoverage({
+    callCount: true,
+    detailed: true
+  })
+}
+
+export function takePreciseCoverage() {
+  if (!client) {
+    return null
+  }
+
+  return client.Profiler.takePreciseCoverage().then((cov) =>
+    convertProfileCoverageToIstanbul(cov, {
+      filename: path.join('reports', 'v8_out.json')
+    })
+  )
+}
+
+export function stopPreciseCoverage() {
+  if (!client) {
+    return
+  }
+  return client.Profiler.stopPreciseCoverage()
+}

lib/plugin/task-utils.js

@@ -5,11 +5,11 @@
 /// <reference types="cypress" />
 const { readFileSync, writeFileSync, existsSync } = require('fs')
 const { isAbsolute, resolve, join } = require('path')
-const debug = require('debug')('code-coverage')
 const chalk = require('chalk')
 const globby = require('globby')
 const yaml = require('js-yaml')
 const {
+  debug,
   combineNycOptions,
   defaultNycOptions,
   fileCoveragePlaceholder
@@ -33,20 +33,26 @@ function readNycOptions(workingDirectory) {
     : {}
 
   const nycrcYamlFilename = join(workingDirectory, '.nycrc.yaml')
+  /**
+   * @type {unknown}
+   */
   let nycrcYaml = {}
   if (existsSync(nycrcYamlFilename)) {
     try {
-      nycrcYaml = yaml.safeLoad(readFileSync(nycrcYamlFilename, 'utf8'))
+      nycrcYaml = yaml.load(readFileSync(nycrcYamlFilename, 'utf8'))
     } catch (error) {
       throw new Error(`Failed to load .nycrc.yaml: ${error.message}`)
     }
   }
 
   const nycrcYmlFilename = join(workingDirectory, '.nycrc.yml')
+  /**
+   * @type {unknown}
+   */
   let nycrcYml = {}
   if (existsSync(nycrcYmlFilename)) {
     try {
-      nycrcYml = yaml.safeLoad(readFileSync(nycrcYmlFilename, 'utf8'))
+      nycrcYml = yaml.load(readFileSync(nycrcYmlFilename, 'utf8'))
     } catch (error) {
       throw new Error(`Failed to load .nycrc.yml: ${error.message}`)
     }

task.js renamed to lib/plugin/task.js

@@ -10,11 +10,14 @@ const {
   tryFindingLocalFiles,
   readNycOptions,
   includeAllFiles
-} = require('./lib/plugin/task-utils')
-const { fixSourcePaths } = require('./lib/support/support-utils')
-const { removePlaceholders } = require('./lib/common/common-utils')
-
-const debug = require('debug')('code-coverage')
+} = require('./task-utils')
+const { fixSourcePaths } = require('../support/support-utils')
+const { debug, removePlaceholders } = require('../common/common-utils')
+const {
+  startPreciseCoverage,
+  takePreciseCoverage,
+  stopPreciseCoverage
+} = require('./chromeRemoteInterface')
 
 // these are standard folder and file names used by NYC tools
 const processWorkingDirectory = process.cwd()
@@ -110,6 +113,9 @@ function maybePrintFinalCoverageFiles(folder) {
 }
 
 const tasks = {
+  startPreciseCoverage,
+  takePreciseCoverage,
+  stopPreciseCoverage,
   /**
    * Clears accumulated code coverage information.
    *

plugins.js

@@ -4,10 +4,13 @@
 //   "pluginsFile": "cypress-code-coverage-v8/plugins",
 //   "supportFile": "cypress-code-coverage-v8/support"
 // }
-//
+
+const { browserLaunchHandler } = require('./lib/plugin/chromeRemoteInterface')
+const addTasks = require('./lib/plugin/task')
+
 module.exports = (on, config) => {
-  require('./task')(on, config)
-  require('./taskV8')(on, config)
+  on('before:browser:launch', browserLaunchHandler)
+  addTasks(on, config)
   // IMPORTANT to return the config object
   // with the any changed environment variables
   return config