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

Merge "CodexModule: Also print dev mode warning when loading full library"

Browse source
This commit is contained in:
jenkins-bot 2024-08-27 16:23:08 +00:00 committed by Gerrit Code Review
commit 7415ff9e0b
2 changed files with 31 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
includes/ResourceLoader/CodexModule.php
View file

@ -322,6 +322,15 @@ class CodexModule extends FileModule {
return $this->getConfig()->get( MainConfigNames::CodexDevelopmentDir ) !== null; return $this->getConfig()->get( MainConfigNames::CodexDevelopmentDir ) !== null;
} }
private function getDevelopmentWarning() {
return $this->isDevelopmentMode() ?
Html::encodeJsCall( 'mw.log.warn', [
"You are using a local development version of Codex, which may not match the latest version. " .
"To disable this, set \$wgCodexDevelopmentDir = null;"
] ) :
'';
}
/** /**
* Decide which manifest file to use, based on the theme and the direction (LTR or RTL). * Decide which manifest file to use, based on the theme and the direction (LTR or RTL).
* *
@ -531,13 +540,7 @@ class CodexModule extends FileModule {
$syntheticExports = Html::encodeJsVar( HtmlJsCode::encodeObject( $exports ) ); $syntheticExports = Html::encodeJsVar( HtmlJsCode::encodeObject( $exports ) );
// Add a console warning in development mode // Add a console warning in development mode
$devWarning = ''; $devWarning = $this->getDevelopmentWarning();
if ( $this->isDevelopmentMode() ) {
$devWarning = Html::encodeJsCall( 'mw.log.warn', [
"You are using a local development version of Codex, which may not match the latest version. " .
"To disable this, set \$wgCodexDevelopmentDir = null;"
] );
}
// Proxy the synthetic exports object so that we can throw a useful error if a component // Proxy the synthetic exports object so that we can throw a useful error if a component
// is not defined in the module definition // is not defined in the module definition
@ -580,10 +583,26 @@ class CodexModule extends FileModule {
private function loadFullCodexLibrary( Context $context ) { private function loadFullCodexLibrary( Context $context ) {
// Add all Codex JS files to the module's package // Add all Codex JS files to the module's package
if ( !$this->isStyleOnly ) { if ( !$this->isStyleOnly ) {
$this->packageFiles[] = [ $jsFilePath = $this->makeFilePath( 'codex.umd.cjs' );
'name' => 'codex.js',
'file' => $this->makeFilePath( 'codex.umd.cjs' ) // Add a console warning in development mode
]; $devWarning = $this->getDevelopmentWarning();
if ( $devWarning ) {
$this->packageFiles[] = [
'name' => 'codex.js',
'callback' => static function () use ( $jsFilePath, $devWarning ) {
return $devWarning . ';' . file_get_contents( $jsFilePath->getLocalPath() );
},
'versionCallback' => static function () use ( $jsFilePath ) {
return $jsFilePath;
}
];
} else {
$this->packageFiles[] = [
'name' => 'codex.js',
'file' => $jsFilePath
];
}
} }
// Add all Codex CSS files to the module's package // Add all Codex CSS files to the module's package

2
tests/phpunit/includes/ResourceLoader/CodexModuleTest.php
View file

@ -375,7 +375,7 @@ class CodexModuleTest extends ResourceLoaderTestCase {
$packageFiles = $fullLibraryModule->getPackageFiles( $context ); $packageFiles = $fullLibraryModule->getPackageFiles( $context );
$this->assertEquals( $this->assertEquals(
$devDir . '/packages/codex/dist/codex.umd.cjs', $devDir . '/packages/codex/dist/codex.umd.cjs',
$packageFiles[ 'files' ][ 'codex.js' ][ 'filePath' ]->getLocalPath(), $packageFiles[ 'files' ][ 'codex.js' ][ 'versionFilePath' ]->getLocalPath(),
'Full library module script path is based on dev mode path' 'Full library module script path is based on dev mode path'
); );