* @ingroup SpecialPage
*/
class SpecialJavaScriptTest extends SpecialPage {
- /**
- * @var array Supported frameworks.
- */
- private static $frameworks = array(
- 'qunit',
- );
public function __construct() {
parent::__construct( 'JavaScriptTest' );
$this->setHeaders();
$out->disallowUserJs();
- if ( $par === null ) {
- // No framework specified
- // If only one framework is configured, redirect to it. Otherwise display a list.
- if ( count( self::$frameworks ) === 1 ) {
- $out->redirect( $this->getPageTitle( self::$frameworks[0] . '/plain' )->getLocalURL() );
- return;
- }
- $out->setStatusCode( 404 );
- $out->setPageTitle( $this->msg( 'javascripttest' ) );
- $out->addHTML(
- $this->msg( 'javascripttest-pagetext-noframework' )->parseAsBlock()
- . $this->getFrameworkListHtml()
- );
- return;
- }
-
- // Determine framework and mode
- $pars = explode( '/', $par, 2 );
-
- $framework = $pars[0];
- if ( !in_array( $framework, self::$frameworks ) ) {
- // Framework not found
- $out->setStatusCode( 404 );
- $out->addHTML(
- '<div class="error">'
- . $this->msg( 'javascripttest-pagetext-unknownframework' )
- ->plaintextParams( $par )->parseAsBlock()
- . '</div>'
- . $this->getFrameworkListHtml()
- );
- return;
- }
-
// This special page is disabled by default ($wgEnableJavaScriptTest), and contains
// no sensitive data. In order to allow TestSwarm to embed it into a test client window,
// we need to allow iframing of this page.
$out->allowClickjacking();
- if ( count( self::$frameworks ) !== 1 ) {
- // If there's only one framework, don't set the subtitle since it
- // is going to redirect back to this page
- $out->setSubtitle(
- $this->msg( 'javascripttest-backlink' )
- ->rawParams( Linker::linkKnown( $this->getPageTitle() ) )
- );
- }
- // Custom actions
- if ( isset( $pars[1] ) ) {
- $action = $pars[1];
- if ( !in_array( $action, array( 'export', 'plain' ) ) ) {
- $out->setStatusCode( 404 );
- $out->addHTML(
- '<div class="error">'
- . $this->msg( 'javascripttest-pagetext-unknownaction' )
- ->plaintextParams( $action )->parseAsBlock()
- . '</div>'
- );
- return;
- }
- $method = $action . ucfirst( $framework );
- $this->$method();
+ // Sub resource: Internal JavaScript export bundle for QUnit
+ if ( $par === 'qunit/export' ) {
+ $this->exportQUnit();
return;
}
- $out->addModules( 'mediawiki.special.javaScriptTest' );
-
- $method = 'view' . ucfirst( $framework );
- $this->$method();
- $out->setPageTitle( $this->msg(
- 'javascripttest-title',
- // Messages: javascripttest-qunit-name
- $this->msg( "javascripttest-$framework-name" )->plain()
- ) );
- }
-
- /**
- * Get a list of frameworks (including introduction paragraph and links
- * to the framework run pages)
- *
- * @return string HTML
- */
- private function getFrameworkListHtml() {
- $list = '<ul>';
- foreach ( self::$frameworks as $framework ) {
- $list .= Html::rawElement(
- 'li',
- array(),
- Linker::link(
- $this->getPageTitle( $framework ),
- // Message: javascripttest-qunit-name
- $this->msg( "javascripttest-$framework-name" )->escaped()
- )
- );
+ // Regular view: QUnit test runner
+ // (Support "/qunit" and "/qunit/plain" for backwards compatibility)
+ if ( $par === null || $par === '' || $par === 'qunit' || $par === 'qunit/plain' ) {
+ $this->plainQUnit();
+ return;
}
- $list .= '</ul>';
- return $this->msg( 'javascripttest-pagetext-frameworks' )->rawParams( $list )
- ->parseAsBlock();
+ // Unknown action
+ $out->setStatusCode( 404 );
+ $out->setPageTitle( $this->msg( 'javascripttest' ) );
+ $out->addHTML(
+ '<div class="error">'
+ . $this->msg( 'javascripttest-pagetext-unknownaction' )
+ ->plaintextParams( $par )->parseAsBlock()
+ . '</div>'
+ );
}
/**
return "<div id=\"mw-javascripttest-summary\">$summary</div>";
}
- /**
- * Run the test suite on the Special page.
- *
- * Rendered by OutputPage and Skin.
- */
- private function viewQUnit() {
- $out = $this->getOutput();
-
- $modules = $out->getResourceLoader()->getTestModuleNames( 'qunit' );
-
- $baseHtml = <<<HTML
-<div class="mw-content-ltr">
-<div id="qunit"></div>
-</div>
-HTML;
-
- $out->addHtml( $this->getSummaryHtml() . $baseHtml );
-
- // The testrunner configures QUnit and essentially depends on it. However, test suites
- // are reusable in environments that preload QUnit (or a compatibility interface to
- // another framework). Therefore we have to load it ourselves.
- $out->addHtml( ResourceLoader::makeInlineScript(
- Xml::encodeJsCall( 'mw.loader.using', array(
- array( 'jquery.qunit', 'jquery.qunit.completenessTest' ),
- new XmlJsCode(
- 'function () {' . Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) . '}'
- )
- ) )
- ) );
- }
-
/**
* Generate self-sufficient JavaScript payload to run the tests elsewhere.
*
$rl = $out->getResourceLoader();
- $query = array(
+ $query = [
'lang' => $this->getLanguage()->getCode(),
'skin' => $this->getSkin()->getSkinName(),
'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
- );
+ 'target' => 'test',
+ ];
$embedContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
$query['only'] = 'scripts';
$startupContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
+ $query['raw'] = true;
+
$modules = $rl->getTestModuleNames( 'qunit' );
- // The below is essentially a pure-javascript version of OutputPage::getHeadScripts.
- $startup = $rl->makeModuleResponse( $startupContext, array(
+ // Disable autostart because we load modules asynchronously. By default, QUnit would start
+ // at domready when there are no tests loaded and also fire 'QUnit.done' which then instructs
+ // Karma to end the run before the tests even started.
+ $qunitConfig = 'QUnit.config.autostart = false;'
+ . 'if (window.__karma__) {'
+ // karma-qunit's use of autostart=false and QUnit.start conflicts with ours.
+ // Hack around this by replacing 'karma.loaded' with a no-op and call it ourselves later.
+ // See <https://github.com/karma-runner/karma-qunit/issues/27>.
+ . 'window.__karma__.loaded = function () {};'
+ . '}';
+
+ // The below is essentially a pure-javascript version of OutputPage::headElement().
+ $startup = $rl->makeModuleResponse( $startupContext, [
'startup' => $rl->getModule( 'startup' ),
- ) );
+ ] );
// Embed page-specific mw.config variables.
// The current Special page shouldn't be relevant to tests, but various modules (which
// are loaded before the test suites), reference mw.config while initialising.
$code = ResourceLoader::makeConfigSetScript( $out->getJSVars() );
// Embed private modules as they're not allowed to be loaded dynamically
- $code .= $rl->makeModuleResponse( $embedContext, array(
+ $code .= $rl->makeModuleResponse( $embedContext, [
'user.options' => $rl->getModule( 'user.options' ),
'user.tokens' => $rl->getModule( 'user.tokens' ),
- ) );
- $code .= Xml::encodeJsCall( 'mw.loader.load', array( $modules ) );
+ ] );
+ // Catch exceptions (such as "dependency missing" or "unknown module") so that we
+ // always start QUnit. Re-throw so that they are caught and reported as global exceptions
+ // by QUnit and Karma.
+ $code .= '(function () {'
+ . 'var start = window.__karma__ ? window.__karma__.start : QUnit.start;'
+ . 'try {'
+ . 'mw.loader.using( ' . Xml::encodeJsVar( $modules ) . ' ).always( start );'
+ . '} catch ( e ) { start(); throw e; }'
+ . '}());';
header( 'Content-Type: text/javascript; charset=utf-8' );
header( 'Cache-Control: private, no-cache, must-revalidate' );
header( 'Pragma: no-cache' );
+ echo $qunitConfig;
echo $startup;
- echo "\n";
- // Note: The following has to be wrapped in a script tag because the startup module also
- // writes a script tag (the one loading mediawiki.js). Script tags are synchronous, block
- // each other, and run in order. But they don't nest. The code appended after the startup
- // module runs before the added script tag is parsed and executed.
- echo Xml::encodeJsCall( 'document.write', array( Html::inlineScript( $code ) ) );
+ // The following has to be deferred via RLQ because the startup module is asynchronous.
+ echo ResourceLoader::makeLoaderConditionalScript( $code );
}
private function plainQUnit() {
$out = $this->getOutput();
$out->disable();
- $url = $this->getPageTitle( 'qunit/export' )->getFullURL( array(
- 'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
- ) );
-
$styles = $out->makeResourceLoaderLink( 'jquery.qunit',
ResourceLoaderModule::TYPE_STYLES
);
- // Use 'raw' since this is a plain HTML page without ResourceLoader
+
+ // Use 'raw' because QUnit loads before ResourceLoader initialises (omit mw.loader.state call)
+ // Use 'test' to ensure OutputPage doesn't use the "async" attribute because QUnit must
+ // load before qunit/export.
$scripts = $out->makeResourceLoaderLink( 'jquery.qunit',
ResourceLoaderModule::TYPE_SCRIPTS,
- array( 'raw' => 'true' )
+ [ 'raw' => true, 'sync' => true ]
);
- $head = implode( "\n", array_merge( $styles['html'], $scripts['html'] ) );
+ $head = implode( "\n", [ $styles, $scripts ] );
$summary = $this->getSummaryHtml();
$html = <<<HTML
<!DOCTYPE html>
$summary
<div id="qunit"></div>
HTML;
+
+ $url = $this->getPageTitle( 'qunit/export' )->getFullURL( [
+ 'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
+ ] );
$html .= "\n" . Html::linkedScript( $url );
header( 'Content-Type: text/html; charset=utf-8' );
dépôts / lhc / web / wiklou.git / blobdiff