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
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
namespace MediaWiki\Tests\ResourceLoader;
use EmptyResourceLoader;
use HashBagOStuff;
use MediaWiki\ResourceLoader\MessageBlobStore;
use MediaWiki\ResourceLoader\ResourceLoader;
use MediaWikiCoversValidator;
use Psr\Log\NullLogger;
use ResourceLoaderTestModule;
use WANObjectCache;
/**
* @group ResourceLoader
* @covers \MediaWiki\ResourceLoader\MessageBlobStore
*/
class MessageBlobStoreTest extends \PHPUnit\Framework\TestCase {
use MediaWikiCoversValidator;
private const NAME = 'test.blobstore';
/** @var WANObjectCache */
private $wanCache;
/** @var float */
private $clock;
protected function setUp(): void {
parent::setUp();
$this->wanCache = new WANObjectCache( [
'cache' => new HashBagOStuff()
] );
$this->clock = 1301655600.000;
$this->wanCache->setMockTime( $this->clock );
}
public function testBlobCreation() {
$rl = new EmptyResourceLoader();
$rl->register( self::NAME, [
'factory' => function () {
return $this->makeModule( [ 'mainpage' ] );
}
] );
$blobStore = $this->makeBlobStore( null, $rl );
$blob = $blobStore->getBlob( $rl->getModule( self::NAME ), 'en' );
$this->assertEquals( '{"mainpage":"Main Page"}', $blob, 'Generated blob' );
}
public function testBlobCreation_empty() {
$module = $this->makeModule( [] );
$rl = new EmptyResourceLoader();
$blobStore = $this->makeBlobStore( null, $rl );
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{}', $blob, 'Generated blob' );
}
public function testBlobCreation_unknownMessage() {
$module = $this->makeModule( [ 'i-dont-exist', 'mainpage', 'i-dont-exist2' ] );
$rl = new EmptyResourceLoader();
$blobStore = $this->makeBlobStore( null, $rl );
// Generating a blob should continue without errors,
// with keys of unknown messages excluded from the blob.
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"mainpage":"Main Page"}', $blob, 'Generated blob' );
}
public function testMessageCachingAndPurging() {
$rl = new EmptyResourceLoader();
// Register it so that MessageBlobStore::updateMessage can
// discover it from the registry as a module that uses this message.
$rl->register( self::NAME, [
'factory' => function () {
return $this->makeModule( [ 'example' ] );
}
] );
$module = $rl->getModule( self::NAME );
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
// Advance this new WANObjectCache instance to a normal state,
// by doing one "get" and letting its hold off period expire.
// Without this, the first real "get" would lazy-initialise the
// checkKey and thus reject the first "set".
$blobStore->getBlob( $module, 'en' );
$this->clock += 20;
// Arrange version 1 of a message
$blobStore->expects( $this->once() )
->method( 'fetchMessage' )
->willReturn( 'First version' );
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"First version"}', $blob, 'Blob for v1' );
// Arrange version 2
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
$blobStore->expects( $this->once() )
->method( 'fetchMessage' )
->willReturn( 'Second version' );
$this->clock += 20;
// Assert
// We do not validate whether a cached message is up-to-date.
// Instead, changes to messages will send us a purge.
// When cache is not purged or expired, it must be used.
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"First version"}', $blob, 'Reuse cached v1 blob' );
// Purge cache
$blobStore->updateMessage( 'example' );
$this->clock += 20;
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"Second version"}', $blob, 'Updated blob for v2' );
}
public function testPurgeEverything() {
$module = $this->makeModule( [ 'example' ] );
$rl = new EmptyResourceLoader();
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
// Advance this new WANObjectCache instance to a normal state.
$blobStore->getBlob( $module, 'en' );
$this->clock += 20;
// Arrange version 1 and 2
$blobStore->expects( $this->exactly( 2 ) )
->method( 'fetchMessage' )
->will( $this->onConsecutiveCalls( 'First', 'Second' ) );
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"First"}', $blob, 'Blob for v1' );
$this->clock += 20;
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"First"}', $blob, 'Blob for v1 again' );
// Purge everything
$blobStore->clear();
$this->clock += 20;
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"example":"Second"}', $blob, 'Blob for v2' );
}
public function testValidateAgainstModuleRegistry() {
// Arrange version 1 of a module
$module = $this->makeModule( [ 'foo' ] );
$rl = new EmptyResourceLoader();
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
$blobStore->expects( $this->once() )
->method( 'fetchMessage' )
->willReturnMap( [
// message key, language code, message value
[ 'foo', 'en', 'Hello' ],
] );
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"foo":"Hello"}', $blob, 'Blob for v1' );
// Arrange version 2 of module
// While message values may be out of date, the set of messages returned
// must always match the set of message keys required by the module.
// We do not receive purges for this because no messages were changed.
$module = $this->makeModule( [ 'foo', 'bar' ] );
$rl = new EmptyResourceLoader();
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
$blobStore->expects( $this->exactly( 2 ) )
->method( 'fetchMessage' )
->willReturnMap( [
// message key, language code, message value
[ 'foo', 'en', 'Hello' ],
[ 'bar', 'en', 'World' ],
] );
// Assert
$blob = $blobStore->getBlob( $module, 'en' );
$this->assertEquals( '{"foo":"Hello","bar":"World"}', $blob, 'Blob for v2' );
}
public function testSetLoggedIsVoid() {
$blobStore = $this->makeBlobStore();
$this->assertNull( $blobStore->setLogger( new NullLogger() ) );
}
private function makeBlobStore( $methods = null, $rl = null ) {
$blobStore = $this->getMockBuilder( MessageBlobStore::class )
->setConstructorArgs( [
$rl ?? $this->createMock( ResourceLoader::class ),
null,
$this->wanCache
] )
->onlyMethods( $methods ?: [] )
->getMock();
return $blobStore;
}
private function makeModule( array $messages ) {
$module = new ResourceLoaderTestModule( [ 'messages' => $messages ] );
$module->setName( self::NAME );
return $module;
}
}
|
