Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replace direct use of $wgRestPath with wfScript()

Browse source 
Follows-up Idb5b0d21adc6. Avoid hardcoded references to REST internal
configuration variables, which create awkward "APIs" in the long run.
These are hard to deprecate or detect use of, and even harder to
normalize/support once variations exist. E.g. in T189966 and T233886,
I've been working to remove the concept of dynamic config in favour of
the uncomputed values being only valid as configuration for the
component that owns the variable, instead of using Config as public
API to read non-normalized information that belongs to a different
component.

By making the recipient responsible for any dynamic computation, it
also becomes clear that these are in fact not normalized or validated,
which can expose any number of unpredictable behaviours if used
directly. Consider special values like `false` or `null` and the
responsibility for interpreting that. Accessing these from a stable
function also gives a natural place for deprecation to happen. The
alternative, is for dynamic computation to happen in Setup.php for
all variabls, and only ever grow and become an append-only dumping
ground for every thing that we feel at some point needs validation,
normalization or expansion, which doesn't scale well, hence I reversed
this trend in T189966/T233886.

As it happens, RestPath actually is already computed, albeit very
trivially. This patch opens the way for someone to remove that in
favour of PathRouter accept `false` directly and expanding (and testing)
that code there instead.

As for REST API, the only stable and universally supported entrypoint
is /w/rest.php. Unlike some older entry points, we don't support
moving or removing the rest.php file. We do support routing/aliasing
additional paths to it.

Change-Id: I589a8aed8db3b8e7b72e4505749bb7ef25a755d9
This commit is contained in:
Timo Tijhof 2024-05-21 22:04:08 +01:00 committed by Krinkle
parent d8783f856e
commit 217d47d46e
3 changed files with 8 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
includes/Output/OutputPage.php
View file

@ -4133,11 +4133,10 @@ class OutputPage extends ContextSource {
}
# OpenSearch description link
$restPath = $config->get( MainConfigNames::RestPath );
$tags['opensearch'] = Html::element( 'link', [
'rel' => 'search',
'type' => 'application/opensearchdescription+xml',
'href' => "$restPath/v1/search",
'href' => wfScript( 'rest' ) . '/v1/search',
'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
] );

4
opensearch_desc.php
View file

@ -34,8 +34,8 @@ define( 'MW_ENTRY_POINT', 'opensearch_desc' );
require_once __DIR__ . '/includes/WebStart.php';
$url = $wgRestPath . '/v1/search';
$ctype = $wgRequest->getVal( 'ctype' );
$url = wfScript( 'rest' ) . '/v1/search';
$ctype = $wgRequest->getRawVal( 'ctype' );
if ( $ctype !== null ) {
$url = wfAppendQuery( $url, [ 'ctype' => $ctype ] );

15
tests/qunit/resources/mediawiki.util/util.test.js
View file

@ -192,16 +192,11 @@ QUnit.module( 'mediawiki.util', QUnit.newMwEnvironment( {
wgScriptPath: '/w'
} );
assert.strictEqual( util.wikiScript(), mw.config.get( 'wgScript' ),
'wikiScript() returns wgScript'
);
assert.strictEqual( util.wikiScript( 'index' ), mw.config.get( 'wgScript' ),
'wikiScript( index ) returns wgScript'
);
assert.strictEqual( util.wikiScript( 'load' ), '/w/l.php',
'wikiScript( load ) returns /w/l.php'
);
assert.strictEqual( util.wikiScript( 'api' ), '/w/api.php', 'API path' );
assert.strictEqual( util.wikiScript(), '/w/i.php', 'default' );
assert.strictEqual( util.wikiScript( 'index' ), '/w/i.php', 'index' );
assert.strictEqual( util.wikiScript( 'load' ), '/w/l.php', 'load' );
assert.strictEqual( util.wikiScript( 'api' ), '/w/api.php', 'api' );
assert.strictEqual( util.wikiScript( 'rest' ), '/w/rest.php', 'rest' );
} );
QUnit.test( 'addCSS', ( assert ) => {