wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-27 16:30:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Don't load ReferencePreviews when not enabled in the config"

Browse source
This commit is contained in:
jenkins-bot 2024-04-30 10:27:39 +00:00 committed by Gerrit Code Review
parent 7d3fcb651d f0d7406811
commit d777be6c29
3 changed files with 70 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
src/Hooks/CiteHooks.php
View file

@ -92,29 +92,32 @@ class CiteHooks implements
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules
*/
public function onResourceLoaderRegisterModules( ResourceLoader $resourceLoader ): void {
if ( ExtensionRegistry::getInstance()->isLoaded( 'Popups' ) ) {
$dir = dirname( __DIR__, 2 ) . '/modules/';
$resourceLoader->register( [
'ext.cite.referencePreviews' => [
'localBasePath' => $dir . '/ext.cite.referencePreviews',
'remoteExtPath' => 'Cite/modules/ext.cite.referencePreviews',
'dependencies' => [
'ext.popups.main',
],
'styles' => [
'referencePreview.less',
],
'packageFiles' => [
'index.js',
'constants.js',
'createReferenceGateway.js',
'createReferencePreview.js',
'isReferencePreviewsEnabled.js',
'referencePreviewsInstrumentation.js'
]
]
] );
if ( !$resourceLoader->getConfig()->get( 'CiteReferencePreviews' ) ||
!ExtensionRegistry::getInstance()->isLoaded( 'Popups' )
) {
return;
}
$resourceLoader->register( [
'ext.cite.referencePreviews' => [
'localBasePath' => dirname( __DIR__, 2 ) . '/modules/ext.cite.referencePreviews',
'remoteExtPath' => 'Cite/modules/ext.cite.referencePreviews',
'dependencies' => [
'ext.popups.main',
],
'styles' => [
'referencePreview.less',
],
'packageFiles' => [
'index.js',
'constants.js',
'createReferenceGateway.js',
'createReferencePreview.js',
'isReferencePreviewsEnabled.js',
'referencePreviewsInstrumentation.js'
]
]
] );
}
/**

2
src/ReferencePreviews/ReferencePreviewsContext.php
View file

@ -38,6 +38,8 @@ class ReferencePreviewsContext {
if (
// T243822: Temporarily disabled in the mobile skin
$skin->getSkinName() === 'minerva' ||
// The feature flag is also checked in the ResourceLoaderRegisterModules hook handler
// and technically redundant here, but it's cheap; better safe than sorry
!$this->config->get( 'CiteReferencePreviews' ) ||
$this->gadgetsIntegration->isRefToolTipsGadgetEnabled( $user ) ||
$this->gadgetsIntegration->isNavPopupsGadgetEnabled( $user )

50
tests/phpunit/CiteHooksTest.php
View file

@ -4,6 +4,8 @@ namespace Cite\Tests;
use ApiQuerySiteinfo;
use Cite\Hooks\CiteHooks;
use MediaWiki\Config\HashConfig;
use MediaWiki\ResourceLoader\ResourceLoader;
use MediaWiki\User\Options\StaticUserOptionsLookup;
/**
@ -12,30 +14,64 @@ use MediaWiki\User\Options\StaticUserOptionsLookup;
*/
class CiteHooksTest extends \MediaWikiIntegrationTestCase {
public function testOnResourceLoaderGetConfigVars() {
/**
* @dataProvider provideBooleans
*/
public function testOnResourceLoaderGetConfigVars( bool $enabled ) {
$vars = [];
$config = $this->getServiceContainer()->getMainConfig();
$config = new HashConfig( [
'CiteVisualEditorOtherGroup' => $enabled,
'CiteResponsiveReferences' => $enabled,
'CiteBookReferencing' => $enabled,
] );
$citeHooks = new CiteHooks( new StaticUserOptionsLookup( [] ) );
$citeHooks->onResourceLoaderGetConfigVars( $vars, 'vector', $config );
$this->assertArrayHasKey( 'wgCiteVisualEditorOtherGroup', $vars );
$this->assertArrayHasKey( 'wgCiteResponsiveReferences', $vars );
$this->assertSame( [
'wgCiteVisualEditorOtherGroup' => $enabled,
'wgCiteResponsiveReferences' => $enabled,
'wgCiteBookReferencing' => $enabled,
], $vars );
}
public function testOnAPIQuerySiteInfoGeneralInfo() {
/**
* @dataProvider provideBooleans
*/
public function testOnResourceLoaderRegisterModules( bool $enabled ) {
$this->markTestSkippedIfExtensionNotLoaded( 'Popups' );
$resourceLoader = $this->createMock( ResourceLoader::class );
$resourceLoader->method( 'getConfig' )
->willReturn( new HashConfig( [ 'CiteReferencePreviews' => $enabled ] ) );
$resourceLoader->expects( $this->exactly( (int)$enabled ) )
->method( 'register' );
$citeHooks = new CiteHooks( new StaticUserOptionsLookup( [] ) );
$citeHooks->onResourceLoaderRegisterModules( $resourceLoader );
}
/**
* @dataProvider provideBooleans
*/
public function testOnAPIQuerySiteInfoGeneralInfo( bool $enabled ) {
$api = $this->createMock( ApiQuerySiteinfo::class );
$api->expects( $this->once() )
->method( 'getConfig' )
->willReturn( $this->getServiceContainer()->getMainConfig() );
->willReturn( new HashConfig( [ 'CiteResponsiveReferences' => $enabled ] ) );
$data = [];
$citeHooks = new CiteHooks( new StaticUserOptionsLookup( [] ) );
$citeHooks->onAPIQuerySiteInfoGeneralInfo( $api, $data );
$this->assertArrayHasKey( 'citeresponsivereferences', $data );
$this->assertSame( [ 'citeresponsivereferences' => $enabled ], $data );
}
public static function provideBooleans() {
yield [ true ];
yield [ false ];
}
}