karma-runner/karma

Handle blocked pop-up window (when client.useIframe false)

Open

#849 opened on Dec 7, 2013

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

Description

By default, Chrome (and probably all other browsers too) will block the pop-up window. This results in super weird behavior - browser starts execution (it thinks it's executing), but never really starts. Even the user clicks "open the window", Karma won't start executing, the user has to "allow pop-ups" and restart the browser.

  1. All the browser launchers should pass --disable-popup-blocking.
  2. We need a timeout on the client, if client.useIframe false (using new window) and the child window does not call setupContext we should display a warning to the user "Hey, your browser is probably blocking the pop-up window".
  3. window.open returns undefined if the window is blocked (https://github.com/karma-runner/karma/blob/master/client/karma.js#L29), we should open directly the "executing url" (rather than "about:blank"), so that when the user opens the window, the execution starts. Then, we need to update the childWindow reference inside setupContext (so that we have it for future runs).

Contributor guide

Tech stack
javascript
Domain
testing
Issue type
feature
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.
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.
clear
Prerequisites
Basic JavaScriptKarma architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the browser launcher code (e.g., launcher.js) to add the ' disable popup blocking' flag. Then modify client/karma.js to implement a timeout for the 'setupContext' call from the child window, and change 'window.open' to use the executing URL instead of 'about:blank'. Refer to the issue description for detailed steps.