SpecialJavaScriptTest.php

Go to the documentation of this file.

<?php
class SpecialJavaScriptTest extends SpecialPage {
 
    public function __construct() {
        parent::__construct( 'JavaScriptTest' );
    }
 
    public function execute( $par ) {
        $out = $this->getOutput();
 
        $this->setHeaders();
        $out->disallowUserJs();
 
        // 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();
 
        // Sub resource: Internal JavaScript export bundle for QUnit
        if ( $par === 'qunit/export' ) {
            $this->exportQUnit();
            return;
        }
 
        // 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;
        }
 
        // Unknown action
        $out->setStatusCode( 404 );
        $out->setPageTitle( $this->msg( 'javascripttest' ) );
        $out->addHTML(
            '<div class="error">'
            . $this->msg( 'javascripttest-pagetext-unknownaction' )
                ->plaintextParams( $par )->parseAsBlock()
            . '</div>'
        );
    }
 
    private function getSummaryHtml() {
        $summary = $this->msg( 'javascripttest-qunit-intro' )
            ->params( 'https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing' )
            ->parseAsBlock();
        return "<div id=\"mw-javascripttest-summary\">$summary</div>";
    }
 
    private function exportQUnit() {
        $out = $this->getOutput();
        $out->disable();
 
        $rl = $out->getResourceLoader();
 
        $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 ) );
 
        $modules = $rl->getTestSuiteModuleNames();
 
        // 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 exit the browser process before the tests even finished loading.
        $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 perform its duty of calling
            // `__karma__.start()` ourselves. 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().
        $code = $rl->makeModuleResponse( $startupContext, [
            'startup' => $rl->getModule( 'startup' ),
        ] );
        $code .= <<<JAVASCRIPT
    // Disable module storage.
    // The unit test for mw.loader.store will enable it
    // explicitly with a mock timer.
    mw.loader.store.enabled = false;
JAVASCRIPT;
        // The following has to be deferred via RLQ because the startup module is asynchronous.
        $code .= ResourceLoader::makeLoaderConditionalScript(
            // 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.
            ResourceLoader::makeConfigSetScript( $out->getJSVars() )
            // Embed private modules as they're not allowed to be loaded dynamically
            . $rl->makeModuleResponse( $embedContext, [
                'user.options' => $rl->getModule( 'user.options' ),
                'user.tokens' => $rl->getModule( 'user.tokens' ),
            ] )
            // Load all the test suites
            . Xml::encodeJsCall( 'mw.loader.load', [ $modules ] )
        );
        $encModules = Xml::encodeJsVar( $modules );
        $code .= ResourceLoader::makeInlineCodeWithModule( 'mediawiki.base', <<<JAVASCRIPT
    var start = window.__karma__ ? window.__karma__.start : QUnit.start;
    mw.loader.using( $encModules ).always( start );
    mw.trackSubscribe( 'resourceloader.exception', function ( topic, err ) {
        // Things like "dependency missing" or "unknown module".
        // Re-throw so that they are reported as global exceptions by QUnit and Karma.
        setTimeout( function () {
            throw err;
        } );
    } );
JAVASCRIPT
    );
 
        header( 'Content-Type: text/javascript; charset=utf-8' );
        header( 'Cache-Control: private, no-cache, must-revalidate' );
        header( 'Pragma: no-cache' );
        echo $qunitConfig;
        echo $code;
    }
 
    private function plainQUnit() {
        $out = $this->getOutput();
        $out->disable();
 
        $styles = $out->makeResourceLoaderLink( 'jquery.qunit',
            ResourceLoaderModule::TYPE_STYLES
        );
 
        // Use 'raw' because QUnit loads before ResourceLoader initialises (omit mw.loader.state call)
        // Use 'sync' to ensure OutputPage doesn't use the "async" attribute because QUnit must
        // load before qunit/export.
        $scripts = $out->makeResourceLoaderLink( 'jquery.qunit',
            ResourceLoaderModule::TYPE_SCRIPTS,
            [ 'raw' => '1', 'sync' => '1' ]
        );
 
        $head = implode( "\n", [ $styles, $scripts ] );
        $summary = $this->getSummaryHtml();
        $html = <<<HTML
<!DOCTYPE html>
<title>QUnit</title>
$head
$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' );
        echo $html;
    }
 
    protected function getGroupName() {
        return 'other';
    }
}