karma-runner/karma

Debug karma.error is not a function

Open

#2254 opened on Jul 13, 2016

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (11,918 stars) (1,703 forks)batch import
help wantedneeds: investigation

Description

Expected behavior

When karma is run in debug and a karma adapter calls __karma__.error, the error message should be printed on the console.

Actual behavior

When karma is run in debug, debug.html defines the window.__karma__ object but does not include an error function. Then, when a karma adapter calls __karma__.error, the error message printed is karma.error is not a function which occludes the real error.

There is at least one occurrence reported in the wild.

Enviroment Details

  • Karma version (output of karma --version): 0.13.22
  • Relevant part of your karma.config.js file

frameworks: ['jspm', ...]

or other adapter which calls karma.error.

Steps to reproduce the behaviour

  1. Mock an adapter which alway calls window.karma.error with a message.
  2. Start karma on any test suite in debug.
  3. The intended error message is not printed on the console.

Contributor guide

Tech stack
javascript
Domain
testing
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is that debug.html defines window. karma but lacks an error function. To fix, locate debug.html in the Karma source (likely in the lib/ or static/ directory). Add `window. karma .error = function(msg) { console.error(msg); };` to define the missing method. Verify by running in debug mode with an adapter that calls karma .error and ensure the error message prints correctly.