Page MenuHomeWickedGov Phorge
Files F4069983

GlobalPreferencesTest.php
No OneTemporary
Actions

Size
9 KB
Referenced Files
None
Subscribers
None

GlobalPreferencesTest.php
View Options

<?php
namespace GlobalPreferences\Tests\Integration;
use GlobalPreferences\GlobalPreferencesFactory;
use GlobalPreferences\Storage;
use MediaWiki\Context\RequestContext;
use MediaWiki\HTMLForm\Field\HTMLCheckMatrix;
use MediaWiki\MainConfigNames;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWikiIntegrationTestCase;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \GlobalPreferences\GlobalPreferencesFactory
* @covers \GlobalPreferences\Storage
* @group GlobalPreferences
* @group Database
*/
class GlobalPreferencesTest extends MediaWikiIntegrationTestCase {
protected function setUp(): void {
parent::setUp();
$this->overrideConfigValues( [
MainConfigNames::CentralIdLookupProvider => 'local',
'GlobalPreferencesDB' => false,
] );
// Prevent cache hits in GlobalPreferences\Storage
$this->setMainCache( CACHE_NONE );
}
public function testService() {
$factory = $this->getServiceContainer()->getPreferencesFactory();
$this->assertInstanceOf( GlobalPreferencesFactory::class, $factory );
}
public function testStorage() {
$user = $this->getTestUser()->getUser();
$gpStorage = new Storage( $user->getId() );
// No prefs to start with.
$this->assertSame( [], $gpStorage->load() );
// Save one, and retrieve it.
$gpStorage->save( [ 'testpref' => 'test' ], [ 'testpref' ] );
$this->assertCount( 1, $gpStorage->load() );
// Save different ones, and it should overwrite.
$gpStorage->save( [ 'testpref2' => 'test2' ], [ 'testpref', 'testpref2' ] );
$this->assertCount( 1, $gpStorage->load() );
$gpStorage->save(
[ 'testpref2' => 'test2', 'testpref3' => 'test3' ],
[ 'testpref2', 'testpref3' ]
);
$this->assertCount( 2, $gpStorage->load() );
// Delete all (in two stages).
$gpStorage->delete( [ 'testpref' ] );
$this->assertEquals(
[ 'testpref2' => 'test2', 'testpref3' => 'test3' ],
$gpStorage->load()
);
$gpStorage->delete();
$this->assertSame( [], $gpStorage->load() );
}
public function testUserPreference() {
$user = $this->getTestUser()->getUser();
$services = $this->getServiceContainer();
$userOptionsManager = $services->getUserOptionsManager();
/** @var GlobalPreferencesFactory $globalPreferences */
$globalPreferences = $services->getPreferencesFactory();
$globalPreferences->setAutoGlobals( [] );
// Set up the context.
// Once preference definitions don't require the context, this can be removed.
$context = RequestContext::getMain();
$context->setTitle( Title::makeTitle( NS_MAIN, 'Test' ) );
// Confirm the site default.
$this->assertEquals( 'en', $userOptionsManager->getOption( $user, 'language' ) );
$this->assertEquals( [], $globalPreferences->getGlobalPreferencesValues( $user ) );
// Set a local preference.
$userOptionsManager->setOption( $user, 'language', 'bn' );
$userOptionsManager->saveOptions( $user );
$this->assertEquals( 'bn', $userOptionsManager->getOption( $user, 'language' ) );
// Set it to be global (with a different value).
$globalPreferences->setGlobalPreferences( $user, [ 'language' => 'de' ], $context );
$this->assertEquals(
[ 'language' => 'de' ],
$globalPreferences->getGlobalPreferencesValues( $user )
);
$this->assertEquals( 'de', $userOptionsManager->getOption( $user, 'language' ) );
$globalPreferences->setGlobalPreferences( $user, [ 'language' => 'ru' ], $context );
$this->assertEquals( 'ru', $userOptionsManager->getOption( $user, 'language' ) );
// Then unglobalize it, and it should return to the local value.
$globalPreferences->setGlobalPreferences( $user, [], $context );
$this->assertEquals( [], $globalPreferences->getGlobalPreferencesValues( $user ) );
// @TODO Instance caching on User doesn't clear User::$mOptionOverrides
// $this->assertEquals( 'bn', $userOptionsManager->getOption( $user, 'language' ) );
}
public function testAutoGlobals() {
$user = $this->getTestUser()->getUser();
$services = $this->getServiceContainer();
$userOptionsManager = $services->getUserOptionsManager();
/** @var GlobalPreferencesFactory $globalPreferences */
$globalPreferences = $services->getPreferencesFactory();
$globalPreferences->setAutoGlobals( [] );
// Set up the context.
// Once preference definitions don't require the context, this can be removed.
$context = RequestContext::getMain();
$context->setTitle( Title::makeTitle( NS_MAIN, 'Test' ) );
// Set it to be global (with a different value).
$globalPreferences->setGlobalPreferences( $user, [ 'language' => 'de' ], $context );
$this->assertEquals(
[ 'language' => 'de' ],
$globalPreferences->getGlobalPreferencesValues( $user )
);
$this->assertEquals( 'de', $userOptionsManager->getOption( $user, 'language' ) );
$globalPreferences->setGlobalPreferences( $user, [ 'language' => 'ru' ], $context );
$this->assertEquals( 'ru', $userOptionsManager->getOption( $user, 'language' ) );
// Make it autoglobal
$globalPreferences->setAutoGlobals( [ 'language' ] );
$userOptionsManager = $services->getUserOptionsManager();
$userOptionsManager->setOption( $user, 'language', 'sq' );
$userOptionsManager->saveOptions( $user );
$this->assertEquals(
[ 'language' => 'sq' ],
$globalPreferences->getGlobalPreferencesValues( $user )
);
}
public function testGetPreferencesGlobalWhenInfoTypeIsGlobalised() {
$this->setUserLang( 'qqx' );
$user = $this->getTestUser()->getUser();
$globalPreferencesFactory = TestingAccessWrapper::newFromObject(
$this->getServiceContainer()->getPreferencesFactory()
);
$globalPreferences = $globalPreferencesFactory->getPreferencesGlobal(
$user,
[ 'foo-description' => [ 'type' => 'info', 'canglobal' => true, 'default' => 'Foo' ] ],
[], RequestContext::getMain()
);
// Verify that the foo-description preference is globalised, but without an associated checkbox
$this->assertArrayHasKey( 'foo-description', $globalPreferences );
$this->assertArrayNotHasKey( 'foo-description-global', $globalPreferences );
// Verify that the foo-description preference is unmodified.
$this->assertArrayEquals(
[ 'type' => 'info', 'canglobal' => true, 'default' => 'Foo' ],
$globalPreferences['foo-description']
);
// Verify that the 'restoreprefs' preference is always present.
$this->assertArrayHasKey( 'restoreprefs', $globalPreferences );
}
/**
* @dataProvider provideIsGlobalizablePreference
*
* @param string $message
* @param bool $expected
* @param string $name
* @param array $info
*/
public function testIsGlobalizablePreference( $message, $expected, $name, array $info ) {
/** @var GlobalPreferencesFactory $globalPreferences */
$globalPreferences = TestingAccessWrapper::newFromObject(
$this->getServiceContainer()->getPreferencesFactory()
);
// Not calling directly because TestingAccessWrapper strips reference otherwise
$result = call_user_func_array(
[ $globalPreferences, 'isGlobalizablePreference' ],
[ $name, &$info ]
);
$this->assertEquals( $expected, $result, $message );
}
public static function provideIsGlobalizablePreference() {
return [
// message, expected, name, info
[
'Globalize simple text preferences',
true,
'foo',
[
'type' => 'text',
],
],
[
'Globalize select controls',
true,
'language',
[
'type' => 'select',
'options' => [ 'foo' => 'bar', 'baz' => 'quux' ],
],
],
[
'Globalize preferences with known class',
true,
'foo',
[
'class' => HTMLCheckMatrix::class,
],
],
[
'Globalize preferences with known class alias',
true,
'foo',
[
'class' => \HTMLCheckMatrix::class,
],
],
[
'Ignore info "preferences"',
false,
'username',
[
"label-message" => [
"username",
"Foo"
],
"default" => "Foo",
"section" => "personal/info",
],
],
[
'Ignore preferences explicitly marked as non-global',
false,
'foo',
[
'type' => 'text',
'noglobal' => true,
],
],
[
'Ignore checkboxes added by this very extension',
false,
'foo-global',
[
'type' => 'text',
],
],
[
'Ignore disabled preferences',
false,
'foo',
[
'type' => 'text',
'disabled' => true,
],
],
[
'Globalize preferences with disabled=false',
true,
'foo',
[
'type' => 'text',
'disabled' => false,
],
],
[
'Ignore preferences with disallowed names',
false,
'realname',
[
'type' => 'text',
],
],
[
'Ignore preferences with unknown class',
false,
'foo',
[
'class' => 'SomethingNew',
],
],
[
'Globalize preferences with canglobal as true',
true,
'pref-description',
[
'type' => 'info',
'canglobal' => true,
],
]
];
}
public function testFactoryGetUserId() {
$user1 = User::createNew( 'User1' );
$user2 = User::createNew( 'User2' );
$services = $this->getServiceContainer();
/** @var GlobalPreferencesFactory $globalPreferences */
$globalPreferences = $services->getPreferencesFactory();
// We're using LocalIdLookup so the local ID is the same as the global ID
$this->assertSame( $user1->getId(), $globalPreferences->getUserID( $user1 ) );
// Is the cache confusing the two users?
$this->assertSame( $user2->getId(), $globalPreferences->getUserID( $user2 ) );
// Does the cache prevent DB queries?
// SpecialGlobalPreferences needs a stable state (T314741).
$this->getDb()->newDeleteQueryBuilder()
->deleteFrom( 'user' )
->where( [ 'user_id' => $user2->getId() ] )
->caller( __METHOD__ )->execute();
$this->assertSame( $user2->getId(), $globalPreferences->getUserID( $user2 ) );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 23:11 (11 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1c/a6/f5b47e9c559d388b0642bfc52300
Default Alt Text
GlobalPreferencesTest.php (9 KB)

Event Timeline