SpecialJavaScriptTest.php

Go to the documentation of this file.

<?php
use MediaWiki\Html\Html;
use MediaWiki\MainConfigNames;
use MediaWiki\Request\FauxRequest;
use MediaWiki\ResourceLoader as RL;
use MediaWiki\ResourceLoader\ResourceLoader;
 
class SpecialJavaScriptTest extends SpecialPage {
 
    public function __construct() {
        parent::__construct( 'JavaScriptTest' );
    }
 
    public function execute( $par ) {
        $this->getOutput()->disable();
 
        if ( $par === 'qunit/export' ) {
            // Send the JavaScript payload.
            $this->exportJS();
        } elseif ( $par === null || $par === '' || $par === 'qunit' || $par === 'qunit/plain' ) {
            // Render the page
            // (Support "/qunit" and "/qunit/plain" for backwards-compatibility)
            $this->renderPage();
        } else {
            wfHttpError( 404, 'Unknown action', "Unknown action \"$par\"." );
        }
    }
 
    private function exportJS() {
        $out = $this->getOutput();
        $rl = $out->getResourceLoader();
 
        // Allow framing (disabling wgBreakFrames). Otherwise, mediawiki.page.ready
        // will close this tab when running from CLI using karma-qunit.
        $out->setPreventClickjacking( false );
 
        $query = [
            'lang' => 'qqx',
            'skin' => 'fallback',
            'debug' => (string)ResourceLoader::inDebugMode(),
            'target' => 'test',
        ];
        $embedContext = new RL\Context( $rl, new FauxRequest( $query ) );
        $query['only'] = 'scripts';
        $startupContext = new RL\Context( $rl, new FauxRequest( $query ) );
 
        $modules = $rl->getTestSuiteModuleNames();
        $component = $this->getContext()->getRequest()->getVal( 'component' );
        if ( $component ) {
            $module = 'test.' . $component;
            if ( !in_array( 'test.' . $component, $modules ) ) {
                wfHttpError(
                    404,
                    'Unknown test module',
                    "'$module' is not a defined test module. "
                        . 'Register one via the QUnitTestModules attribute in extension.json.'
                );
                return;
            }
            $modules = [ 'test.' . $component ];
        }
 
        // Disable module storage.
        // The unit test for mw.loader.store will enable it (with a mock timers).
        $config = new MultiConfig( [
            new HashConfig( [ MainConfigNames::ResourceLoaderStorageEnabled => false ] ),
            $rl->getConfig(),
        ] );
 
        // 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().
        $startupModule = $rl->getModule( 'startup' );
        $startupModule->setConfig( $config );
        $code = $rl->makeModuleResponse( $startupContext, [ 'startup' => $startupModule ] );
        // The following has to be deferred via RLQ because the startup module is asynchronous.
        $code .= ResourceLoader::makeLoaderConditionalScript(
            // Embed page-specific mw.config variables.
            //
            // For compatibility with older tests, these will come from the user
            // action "viewing Special:JavaScripTest".
            //
            // This is deprecated since MediaWiki 1.25 and slowly being phased out in favour of:
            // 1. tests explicitly mocking the configuration they depend on.
            // 2. tests explicitly skipping or not loading code that is only meant
            //    for real page views (e.g. not loading as dependency, or using a QUnit
            //    conditional).
            //
            // See https://phabricator.wikimedia.org/T89434.
            // Keep a select few that are commonly referenced.
            ResourceLoader::makeConfigSetScript( [
                // used by mediawiki.util
                'wgPageName' => 'Special:Badtitle/JavaScriptTest',
                // used as input for mw.Title
                'wgRelevantPageName' => 'Special:Badtitle/JavaScriptTest',
            ] )
            // Embed private modules as they're not allowed to be loaded dynamically
            . $rl->makeModuleResponse( $embedContext, [
                'user.options' => $rl->getModule( 'user.options' ),
            ] )
            // Load all the test modules
            . 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 renderPage() {
        $basePath = $this->getConfig()->get( MainConfigNames::ResourceBasePath );
        $headHtml = implode( "\n", [
            Html::linkedScript( "$basePath/resources/lib/qunitjs/qunit.js" ),
            Html::linkedStyle( "$basePath/resources/lib/qunitjs/qunit.css" ),
            Html::linkedStyle( "$basePath/resources/src/qunitjs/qunit-local.css" ),
        ] );
 
        $introHtml = $this->msg( 'javascripttest-qunit-intro' )
            ->params( 'https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing' )
            ->parseAsBlock();
 
        $scriptUrl = $this->getPageTitle( 'qunit/export' )->getFullURL( [
            'debug' => (string)ResourceLoader::inDebugMode(),
        ] );
        $script = Html::linkedScript( $scriptUrl );
 
        header( 'Content-Type: text/html; charset=utf-8' );
        echo <<<HTML
<!DOCTYPE html>
<title>QUnit</title>
$headHtml
$introHtml
<div id="qunit"></div>
$script
HTML;
    }
 
    protected function getGroupName() {
        return 'other';
    }
}