chore: destroy source maps consumers when spec finishes (#23708)

Co-authored-by: Blue F <blue@cypress.io>
Co-authored-by: Bill Glesias <bglesias@gmail.com>

packages/driver/README.md

@@ -82,7 +82,6 @@ TODO: this data is accurate but also somewhat out of date.
 | mocha:fail            | Mocha   | Cypress | when mocha runner fires its 'fail' event                                                                                                                      |
 | test:end              | Mocha   | Cypress | when mocha runner fires its 'test end' event                                                                                                                  |
 | test:results:ready    | Runner  | Anyone  | when we receive the 'test:end' event                                                                                                                          |
-| test:after:hooks      | Cypress | Cypress | after all hooks have run for a test                                                                                                                           |
 | test:after:run        | Cypress | Anyone  | after any code has run for a test                                                                                                                             |
 | mocha:end             | Mocha   | Cypress | when mocha runner fires its 'end' event                                                                                                                       |
 | after:run             | Runner  | Anyone  | after run has finished                                                                                                                                        |

packages/driver/cypress/e2e/cypress/script_utils.cy.js

@@ -35,8 +35,8 @@ describe('src/cypress/script_utils', () => {
       return $scriptUtils.runScripts(scriptWindow, scripts)
       .then(() => {
         expect($sourceMapUtils.extractSourceMap).to.be.calledTwice
-        expect($sourceMapUtils.extractSourceMap).to.be.calledWith(scripts[0], 'the script contents')
-        expect($sourceMapUtils.extractSourceMap).to.be.calledWith(scripts[1], 'the script contents')
+        expect($sourceMapUtils.extractSourceMap).to.be.calledWith('the script contents')
+        expect($sourceMapUtils.extractSourceMap).to.be.calledWith('the script contents')
       })
     })
 

packages/driver/cypress/e2e/cypress/source_map_utils.cy.js

@@ -46,19 +46,19 @@ const file2 = createFile('file2')
 describe('driver/src/cypress/source_map_utils', () => {
   context('.extractSourceMap', () => {
     it('returns null if there is no source map embedded', () => {
-      const sourceMap = $sourceMapUtils.extractSourceMap(file2, testContent)
+      const sourceMap = $sourceMapUtils.extractSourceMap(testContent)
 
       expect(sourceMap).to.be.null
     })
 
     it('returns null if it is not an inline map', () => {
-      const sourceMap = $sourceMapUtils.extractSourceMap(file2, `${testContent}\n\/\/# sourceMappingURL=foo.map`)
+      const sourceMap = $sourceMapUtils.extractSourceMap(`${testContent}\n\/\/# sourceMappingURL=foo.map`)
 
       expect(sourceMap).to.be.null
     })
 
     it('returns source map when content has an inline map', () => {
-      const sourceMap = $sourceMapUtils.extractSourceMap(file1, fileContents)
+      const sourceMap = $sourceMapUtils.extractSourceMap(fileContents)
 
       expect(sourceMap).to.be.eql(sourceMap)
     })
@@ -71,7 +71,7 @@ describe('driver/src/cypress/source_map_utils', () => {
         const timeLimit = 10
         const startTime = Date.now()
 
-        $sourceMapUtils.extractSourceMap(file1, fileContents)
+        $sourceMapUtils.extractSourceMap(fileContents)
 
         const endTime = Date.now()
 
@@ -81,7 +81,7 @@ describe('driver/src/cypress/source_map_utils', () => {
 
     // https://github.com/cypress-io/cypress/issues/7481
     it('does not garble utf-8 characters', () => {
-      const sourceMap = $sourceMapUtils.extractSourceMap(file1, fileContents)
+      const sourceMap = $sourceMapUtils.extractSourceMap(fileContents)
 
       expect(sourceMap.sourcesContent[1]).to.include('サイプリスは一番')
     })

packages/driver/src/cypress.ts

@@ -9,6 +9,7 @@ import debugFn from 'debug'
 
 import browserInfo from './cypress/browser'
 import $scriptUtils from './cypress/script_utils'
+import $sourceMapUtils from './cypress/source_map_utils'
 
 import $Commands from './cypress/commands'
 import { $Cy } from './cypress/cy'
@@ -403,15 +404,9 @@ class $Cypress {
         break
 
       case 'runner:end':
-        // mocha runner has finished running the tests
+        $sourceMapUtils.destroySourceMapConsumers()
 
-        // end may have been caused by an uncaught error
-        // that happened inside of a hook.
-        //
-        // when this happens mocha aborts the entire run
-        // and does not do the usual cleanup so that means
-        // we have to fire the test:after:hooks and
-        // test:after:run events ourselves
+        // mocha runner has finished running the tests
         this.emit('run:end')
 
         this.maybeEmitCypressInCypress('mocha', 'end', args[0])

packages/driver/src/cypress/script_utils.ts

@@ -14,7 +14,7 @@ const fetchScript = (scriptWindow, script) => {
 const extractSourceMap = ([script, contents]) => {
   script.fullyQualifiedUrl = `${window.top!.location.origin}${script.relativeUrl}`.replace(/ /g, '%20')
 
-  const sourceMap = $sourceMapUtils.extractSourceMap(script, contents)
+  const sourceMap = $sourceMapUtils.extractSourceMap(contents)
 
   return $sourceMapUtils.initializeSourceMapConsumer(script, sourceMap)
   .catch((_err) => {

packages/driver/src/cypress/source_map_utils.ts

@@ -1,6 +1,7 @@
 import _ from 'lodash'
 import { SourceMapConsumer } from 'source-map'
 
+import type { BasicSourceMapConsumer } from 'source-map'
 // @ts-ignore
 import mappingsWasm from 'source-map/lib/mappings.wasm'
 
@@ -9,9 +10,9 @@ import $utils from './utils'
 const sourceMapExtractionRegex = /\/\/\s*[@#]\s*sourceMappingURL\s*=\s*(data:[^\s]*)/g
 const regexDataUrl = /data:[^;\n]+(?:;charset=[^;\n]+)?;base64,([a-zA-Z0-9+/]+={0,2})/ // matches data urls
 
-let sourceMapConsumers = {}
+let sourceMapConsumers: Record<string, BasicSourceMapConsumer> = {}
 
-const initializeSourceMapConsumer = async (file, sourceMap) => {
+const initializeSourceMapConsumer = async (script, sourceMap): Promise<BasicSourceMapConsumer | null> => {
   if (!sourceMap) return null
 
   // @ts-ignore
@@ -21,18 +22,29 @@ const initializeSourceMapConsumer = async (file, sourceMap) => {
 
   const consumer = await new SourceMapConsumer(sourceMap)
 
-  sourceMapConsumers[file.fullyQualifiedUrl] = consumer
+  sourceMapConsumers[script.fullyQualifiedUrl] = consumer
 
   return consumer
 }
 
-const extractSourceMap = (file, fileContents) => {
-  let sourceMapMatch = fileContents.match(sourceMapExtractionRegex)
+const extractSourceMap = (fileContents) => {
+  let dataUrlMatch
 
-  if (!sourceMapMatch) return null
+  try {
+    let sourceMapMatch = fileContents.match(sourceMapExtractionRegex)
+
+    if (!sourceMapMatch) return null
+
+    const url = _.last(sourceMapMatch) as any
 
-  const url = _.last(sourceMapMatch) as any
-  const dataUrlMatch = url.match(regexDataUrl)
+    dataUrlMatch = url.match(regexDataUrl)
+  } catch (err) {
+    // ignore unable to match regex. there's nothing we
+    // can do about it and we don't want to thrown an exception
+    if (err.message === 'Maximum call stack size exceeded') return null
+
+    throw err
+  }
 
   if (!dataUrlMatch) return null
 
@@ -61,15 +73,16 @@ const getSourcePosition = (filePath, position) => {
 
   if (!sourceMapConsumer) return null
 
-  const sourcePosition = sourceMapConsumer.originalPositionFor(position)
-  const { source, line, column } = sourcePosition
+  const { source, line, column } = sourceMapConsumer.originalPositionFor(position)
 
   if (!source || line == null || column == null) return
 
   // if the file is outside of the projectRoot
   // originalPositionFor will not provide the correct relative path
   // https://github.com/cypress-io/cypress/issues/16255
+  // @ts-expect-error
   const sourceIndex = sourceMapConsumer._absoluteSources.indexOf(source)
+  // @ts-expect-error
   const file = sourceMapConsumer._sources.at(sourceIndex)
 
   return {
@@ -89,9 +102,16 @@ const base64toJs = (base64) => {
   }
 }
 
+const destroySourceMapConsumers = () => {
+  Object.values(sourceMapConsumers).forEach((consumer) => {
+    consumer.destroy()
+  })
+}
+
 export default {
   getSourcePosition,
   getSourceContents,
   extractSourceMap,
   initializeSourceMapConsumer,
+  destroySourceMapConsumers,
 }