includes/specials/SpecialJavaScriptTest.php

   1 <?php
   2 /**
   3  * Implements Special:JavaScriptTest
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * @ingroup SpecialPage
  26  */
  27 class SpecialJavaScriptTest extends SpecialPage {
  28
  29         public function __construct() {
  30                 parent::__construct( 'JavaScriptTest' );
  31         }
  32
  33         public function execute( $par ) {
  34                 $out = $this->getOutput();
  35
  36                 $this->setHeaders();
  37                 $out->disallowUserJs();
  38
  39                 // This special page is disabled by default ($wgEnableJavaScriptTest), and contains
  40                 // no sensitive data. In order to allow TestSwarm to embed it into a test client window,
  41                 // we need to allow iframing of this page.
  42                 $out->allowClickjacking();
  43
  44                 // Sub resource: Internal JavaScript export bundle for QUnit
  45                 if ( $par === 'qunit/export' ) {
  46                         $this->exportQUnit();
  47                         return;
  48                 }
  49
  50                 // Regular view: QUnit test runner
  51                 // (Support "/qunit" and "/qunit/plain" for backwards compatibility)
  52                 if ( $par === null || $par === '' || $par === 'qunit' || $par === 'qunit/plain' ) {
  53                         $this->plainQUnit();
  54                         return;
  55                 }
  56
  57                 // Unknown action
  58                 $out->setStatusCode( 404 );
  59                 $out->setPageTitle( $this->msg( 'javascripttest' ) );
  60                 $out->addHTML(
  61                         '<div class="error">'
  62                         . $this->msg( 'javascripttest-pagetext-unknownaction' )
  63                                 ->plaintextParams( $par )->parseAsBlock()
  64                         . '</div>'
  65                 );
  66         }
  67
  68         /**
  69          * Get summary text wrapped in a container
  70          *
  71          * @return string HTML
  72          */
  73         private function getSummaryHtml() {
  74                 $summary = $this->msg( 'javascripttest-qunit-intro' )
  75                         ->params( 'https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing' )
  76                         ->parseAsBlock();
  77                 return "<div id=\"mw-javascripttest-summary\">$summary</div>";
  78         }
  79
  80         /**
  81          * Generate self-sufficient JavaScript payload to run the tests elsewhere.
  82          *
  83          * Includes startup module to request modules from ResourceLoader.
  84          *
  85          * Note: This modifies the registry to replace 'jquery.qunit' with an
  86          * empty module to allow external environment to preload QUnit with any
  87          * neccecary framework adapters (e.g. Karma). Loading it again would
  88          * re-define QUnit and dereference event handlers from Karma.
  89          */
  90         private function exportQUnit() {
  91                 $out = $this->getOutput();
  92                 $out->disable();
  93
  94                 $rl = $out->getResourceLoader();
  95
  96                 $query = [
  97                         'lang' => $this->getLanguage()->getCode(),
  98                         'skin' => $this->getSkin()->getSkinName(),
  99                         'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
 100                         'target' => 'test',
 101                 ];
 102                 $embedContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
 103                 $query['only'] = 'scripts';
 104                 $startupContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
 105
 106                 $query['raw'] = true;
 107
 108                 $modules = $rl->getTestModuleNames( 'qunit' );
 109
 110                 // Disable autostart because we load modules asynchronously. By default, QUnit would start
 111                 // at domready when there are no tests loaded and also fire 'QUnit.done' which then instructs
 112                 // Karma to end the run before the tests even started.
 113                 $qunitConfig = 'QUnit.config.autostart = false;'
 114                         . 'if (window.__karma__) {'
 115                         // karma-qunit's use of autostart=false and QUnit.start conflicts with ours.
 116                         // Hack around this by replacing 'karma.loaded' with a no-op and call it ourselves later.
 117                         // See <https://github.com/karma-runner/karma-qunit/issues/27>.
 118                         . 'window.__karma__.loaded = function () {};'
 119                         . '}';
 120
 121                 // The below is essentially a pure-javascript version of OutputPage::headElement().
 122                 $startup = $rl->makeModuleResponse( $startupContext, [
 123                         'startup' => $rl->getModule( 'startup' ),
 124                 ] );
 125                 // Embed page-specific mw.config variables.
 126                 // The current Special page shouldn't be relevant to tests, but various modules (which
 127                 // are loaded before the test suites), reference mw.config while initialising.
 128                 $code = ResourceLoader::makeConfigSetScript( $out->getJSVars() );
 129                 // Embed private modules as they're not allowed to be loaded dynamically
 130                 $code .= $rl->makeModuleResponse( $embedContext, [
 131                         'user.options' => $rl->getModule( 'user.options' ),
 132                         'user.tokens' => $rl->getModule( 'user.tokens' ),
 133                 ] );
 134                 // Catch exceptions (such as "dependency missing" or "unknown module") so that we
 135                 // always start QUnit. Re-throw so that they are caught and reported as global exceptions
 136                 // by QUnit and Karma.
 137                 $code .= '(function () {'
 138                         . 'var start = window.__karma__ ? window.__karma__.start : QUnit.start;'
 139                         . 'try {'
 140                         . 'mw.loader.using( ' . Xml::encodeJsVar( $modules ) . ' ).always( start );'
 141                         . '} catch ( e ) { start(); throw e; }'
 142                         . '}());';
 143
 144                 header( 'Content-Type: text/javascript; charset=utf-8' );
 145                 header( 'Cache-Control: private, no-cache, must-revalidate' );
 146                 header( 'Pragma: no-cache' );
 147                 echo $qunitConfig;
 148                 echo $startup;
 149                 // The following has to be deferred via RLQ because the startup module is asynchronous.
 150                 echo ResourceLoader::makeLoaderConditionalScript( $code );
 151         }
 152
 153         private function plainQUnit() {
 154                 $out = $this->getOutput();
 155                 $out->disable();
 156
 157                 $styles = $out->makeResourceLoaderLink( 'jquery.qunit',
 158                         ResourceLoaderModule::TYPE_STYLES
 159                 );
 160
 161                 // Use 'raw' because QUnit loads before ResourceLoader initialises (omit mw.loader.state call)
 162                 // Use 'test' to ensure OutputPage doesn't use the "async" attribute because QUnit must
 163                 // load before qunit/export.
 164                 $scripts = $out->makeResourceLoaderLink( 'jquery.qunit',
 165                         ResourceLoaderModule::TYPE_SCRIPTS,
 166                         [ 'raw' => true, 'sync' => true ]
 167                 );
 168
 169                 $head = implode( "\n", [ $styles, $scripts ] );
 170                 $summary = $this->getSummaryHtml();
 171                 $html = <<<HTML
 172 <!DOCTYPE html>
 173 <title>QUnit</title>
 174 $head
 175 $summary
 176 <div id="qunit"></div>
 177 HTML;
 178
 179                 $url = $this->getPageTitle( 'qunit/export' )->getFullURL( [
 180                         'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
 181                 ] );
 182                 $html .= "\n" . Html::linkedScript( $url );
 183
 184                 header( 'Content-Type: text/html; charset=utf-8' );
 185                 echo $html;
 186         }
 187
 188         /**
 189          * Return an array of subpages that this special page will accept.
 190          *
 191          * @return string[] subpages
 192          */
 193         public function getSubpagesForPrefixSearch() {
 194                 return self::$frameworks;
 195         }
 196
 197         protected function getGroupName() {
 198                 return 'other';
 199         }
 200 }