[test optimization] Fix cypress report of typescript test files (#7680)

juan-fernandez · web-flow · commit f49fafe7d30b · 2026-03-09T14:56:09.000+01:00
diff --git a/integration-tests/cypress/cypress.spec.js b/integration-tests/cypress/cypress.spec.js
diff --git a/integration-tests/cypress/e2e/spec-source-line-fallback.cy.ts b/integration-tests/cypress/e2e/spec-source-line-fallback.cy.ts
@@ -0,0 +1,13 @@
+/* global describe, it, cy, Cypress */
+interface TypeOnly {
+  field: string
+}
+
+describe('spec source line fallback branch', () => {
+  it('fallback branch literal title', () => {
+    Cypress.mocha.getRunner().currentRunnable.invocationDetails.line = 9999
+    cy.visit('/')
+      .get('.hello-world')
+      .should('have.text', 'Hello World')
+  })
+})
diff --git a/integration-tests/cypress/e2e/spec-source-line-invocation.cy.js b/integration-tests/cypress/e2e/spec-source-line-invocation.cy.js
@@ -0,0 +1,14 @@
+/* global describe, it, cy */
+'use strict'
+
+// Deliberate: keep this fixture as plain JS with no source map.
+// We validate the fast path that trusts invocationDetails.line directly
+// and skips source-map/declaration resolution.
+
+describe('spec source line invocation details js', () => {
+  it('uses invocation details line as source line', () => {
+    cy.visit('/')
+      .get('.hello-world')
+      .should('have.text', 'Hello World')
+  })
+})
diff --git a/integration-tests/cypress/e2e/spec-source-line-no-match.cy.ts b/integration-tests/cypress/e2e/spec-source-line-no-match.cy.ts
@@ -0,0 +1,15 @@
+/* global describe, it, cy, Cypress */
+interface TypeOnly {
+  field: string
+}
+
+const NO_MATCH_TITLE = ['no', 'match', 'title'].join(' ')
+
+describe('spec source line no match', () => {
+  it(NO_MATCH_TITLE, () => {
+    Cypress.mocha.getRunner().currentRunnable.invocationDetails.line = 9999
+    cy.visit('/')
+      .get('.hello-world')
+      .should('have.text', 'Hello World')
+  })
+})
diff --git a/integration-tests/cypress/e2e/spec-source-line.cy.ts b/integration-tests/cypress/e2e/spec-source-line.cy.ts
@@ -0,0 +1,21 @@
+/* global describe, it, specify, cy */
+// This file is used to reproduce the issue where testSourceLine is not correctly
+// detected for test files compiled from TypeScript.
+// The TypeScript-only declarations below are removed during compilation,
+// which may cause the line numbers to shift in the compiled output.
+interface TypeScriptOnlyInterface {
+  field: string
+}
+const SOME_VARIABLE = 'interpolated'
+describe('spec source line', () => {
+  it('reports correct line number', () => {
+    cy.visit('/')
+      .get('.hello-world')
+      .should('have.text', 'Hello World')
+  })
+  specify(`template ${SOME_VARIABLE} string test name`, () => {
+    cy.visit('/')
+      .get('.hello-world')
+      .should('have.text', 'Hello World')
+  })
+})
diff --git a/integration-tests/cypress/tsconfig.cypress.json b/integration-tests/cypress/tsconfig.cypress.json
@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "outDir": "e2e/dist",
+    "rootDir": "e2e",
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "noEmitOnError": false
+  },
+  "include": [
+    "e2e/spec-source-line.cy.ts",
+    "e2e/spec-source-line-fallback.cy.ts",
+    "e2e/spec-source-line-no-match.cy.ts"
+  ]
+}
diff --git a/packages/datadog-plugin-cypress/src/cypress-plugin.js b/packages/datadog-plugin-cypress/src/cypress-plugin.js
@@ -91,6 +91,11 @@ const {
   RUNTIME_VERSION,
 } = require('../../dd-trace/src/plugins/util/env')
 const { DD_MAJOR } = require('../../../version')
+const {
+  resolveOriginalSourcePosition,
+  resolveSourceLineForTest,
+  shouldTrustInvocationDetailsLine,
+} = require('./source-map-utils')
 
 const TEST_FRAMEWORK_NAME = 'cypress'
 
@@ -238,7 +243,6 @@ class CypressPlugin {
 
   finishedTestsByFile = {}
   testStatuses = {}
-
   isTestsSkipped = false
   isSuitesSkippingEnabled = false
   isCodeCoverageEnabled = false
@@ -391,7 +395,9 @@ class CypressPlugin {
     this.ciVisEvent(TELEMETRY_EVENT_CREATED, 'suite')
 
     if (testSuiteAbsolutePath) {
-      const testSourceFile = getTestSuitePath(testSuiteAbsolutePath, this.repositoryRoot)
+      const resolvedSuitePosition = resolveOriginalSourcePosition(testSuiteAbsolutePath, 1)
+      const resolvedSuiteAbsolutePath = resolvedSuitePosition ? resolvedSuitePosition.sourceFile : testSuiteAbsolutePath
+      const testSourceFile = getTestSuitePath(resolvedSuiteAbsolutePath, this.repositoryRoot)
       testSuiteSpanMetadata[TEST_SOURCE_FILE] = testSourceFile
       testSuiteSpanMetadata[TEST_SOURCE_START] = 1
       const codeOwners = this.getTestCodeOwners({ testSuite, testSourceFile })
@@ -804,8 +810,10 @@ class CypressPlugin {
         if (this.itrCorrelationId) {
           finishedTest.testSpan.setTag(ITR_CORRELATION_ID, this.itrCorrelationId)
         }
-        const testSourceFile = spec.absolute && this.repositoryRoot
-          ? getTestSuitePath(spec.absolute, this.repositoryRoot)
+        const resolvedSpecPosition = spec.absolute ? resolveOriginalSourcePosition(spec.absolute, 1) : null
+        const resolvedSpecAbsolutePath = resolvedSpecPosition ? resolvedSpecPosition.sourceFile : spec.absolute
+        const testSourceFile = resolvedSpecAbsolutePath && this.repositoryRoot
+          ? getTestSuitePath(resolvedSpecAbsolutePath, this.repositoryRoot)
           : spec.relative
         if (testSourceFile) {
           finishedTest.testSpan.setTag(TEST_SOURCE_FILE, testSourceFile)
@@ -902,9 +910,11 @@ class CypressPlugin {
           error,
           isRUMActive,
           testSourceLine,
+          testSourceStack,
           testSuite,
           testSuiteAbsolutePath,
           testName,
+          testItTitle,
           isNew,
           isEfdRetry,
           isAttemptToFix,
@@ -946,8 +956,29 @@ class CypressPlugin {
         if (isRUMActive) {
           this.activeTestSpan.setTag(TEST_IS_RUM_ACTIVE, 'true')
         }
+        // Source-line resolution strategy:
+        // 1. If plain JS and no source map, trust invocationDetails.line directly.
+        // 2. Otherwise, try invocationDetails.stack line mapped through source map.
+        // 3. If that fails, scan generated file for it/test/specify declaration by test name.
+        // 4. If declaration found:
+        //    - .ts file: use declaration line directly.
+        //    - .js file: map declaration line through source map.
+        // 5. If all fail, keep original invocationDetails.line.
         if (testSourceLine) {
-          this.activeTestSpan.setTag(TEST_SOURCE_START, testSourceLine)
+          let resolvedLine = testSourceLine
+          if (testSuiteAbsolutePath && testItTitle) {
+            // Use invocationDetails directly only for plain JS specs without source maps.
+            // Otherwise, resolve from the test declaration in the spec and map via source map.
+            const shouldTrustInvocationDetails = shouldTrustInvocationDetailsLine(testSuiteAbsolutePath, testSourceLine)
+            if (!shouldTrustInvocationDetails) {
+              resolvedLine = resolveSourceLineForTest(
+                testSuiteAbsolutePath,
+                testItTitle,
+                testSourceStack
+              ) ?? testSourceLine
+            }
+          }
+          this.activeTestSpan.setTag(TEST_SOURCE_START, resolvedLine)
         }
         if (isNew) {
           this.activeTestSpan.setTag(TEST_IS_NEW, 'true')
diff --git a/packages/datadog-plugin-cypress/src/source-map-utils.js b/packages/datadog-plugin-cypress/src/source-map-utils.js
diff --git a/packages/datadog-plugin-cypress/src/support.js b/packages/datadog-plugin-cypress/src/support.js
