fix(typescript): normalize included step source paths

Author: luantaraschi

lib/container.js

@@ -892,10 +892,6 @@ async function loadSupportObject(modulePath, supportObjectName) {
           for (const [key, value] of mapping.entries()) {
             container.tsFileMapping.set(key, value)
           }
-          // Step.line() maps temp paths back through store, not through the
-          // container, so an include has to land there too. Without this a step
-          // that originates in an included .ts page object is printed with the
-          // deleted .temp.mjs sibling. (#5675)
           if (!store.tsFileMapping) {
             store.tsFileMapping = new Map()
           }

lib/step/base.js

@@ -1,4 +1,5 @@
 import color from 'chalk'
+import { pathToFileURL } from 'url'
 import Secret from '../secret.js'
 import { getCurrentTimeout } from '../timeout.js'
 import { ucfirst, humanizeString, serializeError } from '../utils.js'
@@ -149,8 +150,6 @@ class Step {
     const lines = this.stack.split('\n')
     if (lines[STACK_LINE]) {
       let line = lines[STACK_LINE].trim()
-        .replace(store.codeceptDir || '', '.')
-        .trim()
 
       // Map .temp.mjs back to original .ts files using container's tsFileMapping
       const fileMapping = store.tsFileMapping
@@ -160,10 +159,23 @@ class Step {
             line = line.replace(mjsFile, tsFile)
             break
           }
+
+          const mjsFileUrl = pathToFileURL(mjsFile).href
+          if (line.includes(mjsFileUrl)) {
+            line = line.replace(mjsFileUrl, pathToFileURL(tsFile).href)
+            break
+          }
         }
       }
 
-      return line
+      const codeceptDir = store.codeceptDir || ''
+      if (codeceptDir) {
+        line = line
+          .replace(pathToFileURL(codeceptDir).href, '.')
+          .replace(codeceptDir, '.')
+      }
+
+      return line.trim()
     }
     return ''
   }

test/data/sandbox/typescript-step-paths/codecept.conf.js

@@ -0,0 +1,13 @@
+export const config = {
+  tests: './tests/*Test.ts',
+  helpers: {
+    FakeHelper: {
+      require: './fakeHelper.js',
+    },
+  },
+  include: {
+    fooPage: './pages/fooPage.ts',
+  },
+  require: ['tsx/cjs'],
+  name: 'typescript-step-paths',
+}

test/data/sandbox/typescript-step-paths/fakeHelper.js

@@ -0,0 +1,11 @@
+import Helper from 'codeceptjs/lib/helper'
+
+export default class FakeHelper extends Helper {
+  doThing(label) {
+    return label
+  }
+
+  failNow(message) {
+    throw new Error(message)
+  }
+}

test/data/sandbox/typescript-step-paths/pages/fooPage.ts

@@ -0,0 +1,9 @@
+export {}
+
+const { I } = inject()
+
+export default {
+  open() {
+    I.doThing('from page')
+  },
+}

test/data/sandbox/typescript-step-paths/tests/fooTest.ts

@@ -0,0 +1,6 @@
+Feature('TypeScript step paths')
+
+Scenario('shows original paths', ({ I, fooPage }) => {
+  fooPage.open()
+  I.failNow('boom')
+})

test/runner/typescript_step_paths_test.js

@@ -0,0 +1,31 @@
+import { execFile } from 'child_process'
+import { expect } from 'expect'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const runner = path.join(__dirname, '../../bin/codecept.js')
+const codeceptDir = path.join(__dirname, '../data/sandbox/typescript-step-paths')
+
+describe('TypeScript step paths', () => {
+  it('maps included page object steps back to their source file', done => {
+    execFile(
+      process.execPath,
+      [runner, 'run', '--config', path.join(codeceptDir, 'codecept.conf.js')],
+      { cwd: codeceptDir, env: { ...process.env, FORCE_COLOR: '0' } },
+      (err, stdout) => {
+        try {
+          expect(err).toBeTruthy()
+          expect(stdout).toContain('Scenario Steps:')
+          expect(stdout).toMatch(/at Object\.open \(\.\/pages\/fooPage\.ts:\d+:\d+\)/)
+          expect(stdout).not.toContain('.temp.mjs')
+          expect(stdout).not.toContain('file://./pages/fooPage.ts')
+          done()
+        } catch (error) {
+          done(error)
+        }
+      },
+    )
+  })
+})