karma-runner/karma

Stacktrace rewrite (sourceMap support) fails for absolute Windows paths

Open

#1097 opened on Jun 10, 2014

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (11,918 stars) (1,703 forks)batch import
help wantedtype: backlogtype: bugwindows

Description

The regex for attaching source locations in lib/reporter.js#L25 fails to match absolute Windows path.

The problem is that the regular expression matches drive letters in path such as C:/foo,js as as the path name. This leads to the stack trace below not being rewritten.

Error: intentional
    at http://localhost:9876/absoluteC:/foo.js?da39a3ee5e6b4b0d3255bfef95601890afd80709:17

We could make the used regular expression less restrictive by removing the \\: part from the path segment to fix the issue.

var URL_REGEXP = new RegExp('http:\\/\\/[^\\/]*\\/' +
                              '(base|absolute)' + // prefix
                              '([^\\?\\s\\]*)' + // path
                              '(\\?\\w*)?' +      // sha
                              '(\\:(\\d+))?' +    // line
                              '(\\:(\\d+))?' +    // column
                              '', 'g');`

This however this breaks the existing test case.

An additional test case for test/unit/reporter.spec.coffee that must must pass on Windows systems could be the following:

      it 'should rewrite absolute stack trace (Windows)', (done) ->

        formatError = m.createErrorFormatter '/some/base', emitter, MockSourceMapConsumer
        servedFiles = [new File('C:/b.js')]
        servedFiles[0].sourceMap = 'SOURCE MAP b.js'

        emitter.emit 'file_list_modified', q(served: servedFiles)

        scheduleNextTick ->
          ERROR = 'at http://localhost:123/base/C:/b.js:2:6'
          expect(formatError ERROR).to.equal 'at /some/base/b.js:2:6 <- C:/original/b.js:4:8\n'
          done()

Maybe I am mistaken but I believe a simple regex fix will not solve the issue across all platforms.

Give me the OK to rewrite the URL matching with some more sophisticated logic and I am happy to provide a pull request.

Contributor guide

Tech stack
javascriptnodejs
Domain
testing
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
regexNode.js path handlingKarma codebase basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The bug is in the regex in lib/reporter.js line 25 that fails to match absolute Windows paths (e.g., C:/foo.js). The existing test in test/unit/reporter.spec.coffee fails with a simple regex fix. Review the current URL matching logic, investigate why a simple regex fix breaks the test, and consider rewriting the URL matching with more sophisticated logic that handles both Unix and Windows paths correctly. The issue author offers to provide a pull request but awaits maintainer OK. Check the sole comment for any additional context.