1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Specials;
use HttpError;
use MediaWiki\Config\HashConfig;
use MediaWiki\Config\MultiConfig;
use MediaWiki\Html\Html;
use MediaWiki\MainConfigNames;
use MediaWiki\Request\FauxRequest;
use MediaWiki\ResourceLoader as RL;
use MediaWiki\ResourceLoader\ResourceLoader;
use MediaWiki\SpecialPage\SpecialPage;
/**
* @ingroup SpecialPage
* @ingroup 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\"." );
}
}
/**
* Used on both GUI (Special:JavaScriptTest) and the exportJS route
*/
private function getModulesForComponentOrThrow( ?string $component ): array {
$out = $this->getOutput();
$rl = $out->getResourceLoader();
$req = $this->getContext()->getRequest();
$modules = $rl->getTestSuiteModuleNames();
if ( $component !== null ) {
$module = 'test.' . $component;
if ( !in_array( 'test.' . $component, $modules ) ) {
throw new HttpError(
404,
"No test module found for the '$component' component.\n"
. "Make sure the extension is enabled via wfLoadExtension(),\n"
. "and register a test module via the QUnitTestModules attribute in extension.json.",
'Unknown test module',
);
}
$modules = [ 'test.' . $component ];
}
return $modules;
}
/**
* Send the standalone JavaScript payload.
*
* Loaded by the GUI (on Special:JavaScriptTest), and by the CLI (via grunt-karma).
*/
private function exportJS() {
$out = $this->getOutput();
$req = $this->getContext()->getRequest();
$rl = $out->getResourceLoader();
// Allow framing (disabling wgBreakFrames). Otherwise, mediawiki.page.ready
// will close this tab when running from CLI using karma-qunit.
$out->getMetadata()->setPreventClickjacking( false );
$query = [
'lang' => 'qqx',
'skin' => 'fallback',
'debug' => $req->getRawVal( 'debug' ),
'target' => 'test',
];
$embedContext = new RL\Context( $rl, new FauxRequest( $query ) );
$query['only'] = 'scripts';
$startupContext = new RL\Context( $rl, new FauxRequest( $query ) );
$component = $req->getRawVal( 'component' );
$modules = $this->getModulesForComponentOrThrow( $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(),
] );
// 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
. Html::encodeJsCall( 'mw.loader.load', [ $modules ] )
);
$encModules = Html::encodeJsVar( $modules );
$code .= ResourceLoader::makeInlineCodeWithModule( 'mediawiki.base', <<<JAVASCRIPT
// Wait for each module individually, so that partial failures wont break the page
// completely by rejecting the promise before all/ any modules are loaded.
var promises = $encModules.map( function( module ) {
return mw.loader.using( module ).promise();
} );
Promise.allSettled( promises ).then( QUnit.start );
JAVASCRIPT
);
header( 'Content-Type: text/javascript; charset=utf-8' );
header( 'Cache-Control: private, no-cache, must-revalidate' );
echo $code;
}
private function renderPage() {
$req = $this->getContext()->getRequest();
$component = $req->getRawVal( 'component' );
// If set, validate
$this->getModulesForComponentOrThrow( $component );
$basePath = $this->getConfig()->get( MainConfigNames::ResourceBasePath );
$headHtml = implode( "\n", [
Html::linkedStyle( "$basePath/resources/lib/qunitjs/qunit.css" ),
Html::linkedStyle( "$basePath/resources/src/qunitjs/qunit-local.css" ),
] );
$scriptUrl = $this->getPageTitle( 'qunit/export' )->getFullURL( [
'debug' => $req->getRawVal( 'debug' ) ?? '0',
'component' => $component,
] );
$script = implode( "\n", [
Html::linkedScript( "$basePath/resources/lib/qunitjs/qunit.js" ),
Html::inlineScript( 'QUnit.config.autostart = false;' ),
Html::linkedScript( $scriptUrl ),
] );
header( 'Content-Type: text/html; charset=utf-8' );
echo <<<HTML
<!DOCTYPE html>
<title>QUnit</title>
$headHtml
<div id="qunit"></div>
<div id="qunit-fixture"></div>
$script
HTML;
}
protected function getGroupName() {
return 'other';
}
}
/** @deprecated class alias since 1.41 */
class_alias( SpecialJavaScriptTest::class, 'SpecialJavaScriptTest' );
|
