fix: UNIFY-1389 proper absolute pathing in stack_utils (#20858)

* fix: UNIFY-1389 proper absolute pathing in stack_utils

* Add test for absolute path resolve fix

* add failing test for webpack absolute path line

* fix for webpack absolute line

* confirmed fix for absolute rather than relative path in cy tests

Author: tgriesser

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

@@ -262,6 +262,54 @@ Error: spec iframe stack
       ])
     })
 
+    it('strips webpack protocol and maintains absolute path', () => {
+      $sourceMapUtils.getSourcePosition.returns({
+        file: 'cypress:////root/absolute/path/some_other_file.ts',
+        line: 2,
+        column: 1,
+      })
+
+      $sourceMapUtils.getSourcePosition.onCall(1).returns({
+        file: 'webpack:////root/absolute/path/cypress/integration/features/source_map_spec.coffee',
+        line: 4,
+        column: 3,
+      })
+
+      const sourceStack = $stackUtils.getSourceStack(generatedStack, projectRoot)
+
+      expect(sourceStack.sourceMapped).to.equal(`Error: spec iframe stack
+    at foo.bar (cypress:////root/absolute/path/some_other_file.ts:2:2)
+    at Context.<anonymous> (webpack:////root/absolute/path/cypress/integration/features/source_map_spec.coffee:4:4)\
+`)
+
+      expect(sourceStack.parsed).to.eql([
+        {
+          message: 'Error: spec iframe stack',
+          whitespace: '',
+        },
+        {
+          function: 'foo.bar',
+          fileUrl: 'http://localhost:1234/source_map_spec.js',
+          originalFile: 'cypress:////root/absolute/path/some_other_file.ts',
+          relativeFile: '/root/absolute/path/some_other_file.ts',
+          absoluteFile: '/root/absolute/path/some_other_file.ts',
+          line: 2,
+          column: 2,
+          whitespace: '    ',
+        },
+        {
+          function: 'Context.<anonymous>',
+          fileUrl: 'http://localhost:1234/tests?p=cypress/integration/features/source_map_spec.js',
+          originalFile: 'webpack:////root/absolute/path/cypress/integration/features/source_map_spec.coffee',
+          relativeFile: '/root/absolute/path/cypress/integration/features/source_map_spec.coffee',
+          absoluteFile: '/root/absolute/path/cypress/integration/features/source_map_spec.coffee',
+          line: 4,
+          column: 4,
+          whitespace: '    ',
+        },
+      ])
+    })
+
     it('returns empty object if there\'s no stack', () => {
       expect($stackUtils.getSourceStack()).to.eql({})
     })
@@ -364,6 +412,27 @@ Error: spec iframe stack
       expect(details.relativeFile).to.equal('cypress/integration/spec%with space &^$ emoji👍_你好.js')
       expect(details.absoluteFile).to.equal(`${projectRoot}/cypress/integration/spec%with space &^$ emoji👍_你好.js`)
     })
+
+    it('maintains absolute path when provided', () => {
+      cy.stub($sourceMapUtils, 'getSourcePosition').returns({
+        file: '/root/path/cypress/integration/spec.js',
+        line: 1,
+        column: 0,
+      })
+
+      // stack is fairly irrelevant in this test - testing transforming getSourcePosition response
+      const stack = stripIndent`
+        Error
+          at Object../cypress/integration/spec.js (http://localhost:50129/__cypress/tests?p=/root/path/cypress/integration/spec.js:99:1)
+      `
+
+      const projectRoot = '/Users/gleb/git/cypress-example-todomvc'
+      const details = $stackUtils.getSourceDetailsForFirstLine(stack, projectRoot)
+
+      expect(details.originalFile).to.equal('/root/path/cypress/integration/spec.js')
+      expect(details.relativeFile).to.equal('/root/path/cypress/integration/spec.js')
+      expect(details.absoluteFile).to.equal(`/root/path/cypress/integration/spec.js`)
+    })
   })
 
   context('.stackWithUserInvocationStackSpliced', () => {

packages/driver/src/cypress/stack_utils.ts

@@ -12,7 +12,7 @@ import { getStackLines, replacedStack, stackWithoutMessage, splitStack, unsplitS
 
 const whitespaceRegex = /^(\s*)*/
 const stackLineRegex = /^\s*(at )?.*@?\(?.*\:\d+\:\d+\)?$/
-const customProtocolRegex = /^[^:\/]+:\/+/
+const customProtocolRegex = /^[^:\/]+:\/{1,3}/
 const percentNotEncodedRegex = /%(?![0-9A-F][0-9A-F])/g
 const STACK_REPLACEMENT_MARKER = '__stackReplacementMarker'
 
@@ -318,7 +318,7 @@ const getSourceDetailsForLine = (projectRoot, line): LineDetail => {
     fileUrl: generatedDetails.file,
     originalFile,
     relativeFile,
-    absoluteFile: (relativeFile && projectRoot) ? path.join(projectRoot, relativeFile) : undefined,
+    absoluteFile: (relativeFile && projectRoot) ? path.resolve(projectRoot, relativeFile) : undefined,
     line: sourceDetails.line,
     // adding 1 to column makes more sense for code frame and opening in editor
     column: sourceDetails.column + 1,

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

@@ -103,6 +103,8 @@ async function makeE2ETasks () {
   let remoteGraphQLIntercept: RemoteGraphQLInterceptor | undefined
   let scaffoldedProjects = new Set<string>()
 
+  const cachedCwd = process.cwd()
+
   clearCtx()
   ctx = setCtx(makeDataContext({ mode: 'open', modeOptions: { cwd: process.cwd() } }))
 
@@ -133,10 +135,21 @@ async function makeE2ETasks () {
     async __internal__before () {
       Fixtures.remove()
       scaffoldedProjects = new Set()
+      process.chdir(cachedCwd)
 
       return { launchpadPort }
     },
 
+    /**
+     * Force a reset to the correct CWD after all tests have completed, just incase this
+     * was modified by any code under test.
+     */
+    __internal__after () {
+      process.chdir(cachedCwd)
+
+      return null
+    },
+
     /**
      * Called before each test to do global setup/cleanup
      */

packages/frontend-shared/cypress/e2e/support/e2eSupport.ts

@@ -174,6 +174,10 @@ beforeEach(() => {
   taskInternal('__internal__beforeEach', undefined)
 })
 
+after(() => {
+  taskInternal('__internal__after', undefined)
+})
+
 function scaffoldProject (projectName: ProjectFixture, options: { timeout?: number} = {}) {
   return logInternal({ name: 'scaffoldProject', message: projectName }, () => {
     return taskInternal('__internal_scaffoldProject', projectName, options)