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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
|
<?php
namespace MediaWiki\Tests\Parser\Parsoid;
use Composer\Semver\Semver;
use LogicException;
use MediaWiki\Content\JsonContent;
use MediaWiki\Content\WikitextContent;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\Page\PageIdentityValue;
use MediaWiki\Parser\Parsoid\Config\PageConfig;
use MediaWiki\Parser\Parsoid\HtmlToContentTransform;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWikiIntegrationTestCase;
use Psr\Log\NullLogger;
use Wikimedia\Parsoid\Core\ClientError;
use Wikimedia\Parsoid\Core\SelserData;
use Wikimedia\Parsoid\Parsoid;
use Wikimedia\Parsoid\Utils\ContentUtils;
use Wikimedia\Stats\Emitters\NullEmitter;
use Wikimedia\Stats\StatsCache;
use Wikimedia\Stats\StatsFactory;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \MediaWiki\Parser\Parsoid\HtmlToContentTransform
* @group Database
*/
class HtmlToContentTransformTest extends MediaWikiIntegrationTestCase {
private const MODIFIED_HTML = '<html><head>' .
'<meta charset="utf-8"/><meta property="mw:htmlVersion" content="2.4.0"/></head>' .
'<body>Modified HTML</body></html>';
private const ORIG_BODY = '<body>Original Content</body>';
private const ORIG_HTML = '<html>' . self::ORIG_BODY . '</html>';
private const ORIG_DATA_MW = [ 'ids' => [ 'mwAQ' => [] ] ];
private const ORIG_DATA_PARSOID = [ 'ids' => [ 'mwAQ' => [ 'pi' => [ [ [ 'k' => '1' ] ] ] ] ] ];
private const MODIFIED_DATA_MW = [ 'ids' => [ 'mwAQ' => [
'parts' => [ [
'template' => [
'target' => [ 'wt' => '1x', 'href' => './Template:1x' ],
'params' => [ '1' => [ 'wt' => 'hi' ] ],
'i' => 0
]
] ]
] ] ];
private function setOriginalData( HtmlToContentTransform $transform ) {
$transform->setOriginalRevisionId( 1 );
$transform->setOriginalSchemaVersion( '2.4.0' );
$transform->setOriginalHtml( self::ORIG_HTML );
$transform->setOriginalDataMW( self::ORIG_DATA_MW );
$transform->setOriginalDataParsoid( self::ORIG_DATA_PARSOID );
}
private function createHtmlToContentTransform( $html = '' ) {
return new HtmlToContentTransform(
$html ?? self::ORIG_HTML,
PageIdentityValue::localIdentity( 7, NS_MAIN, 'Test' ),
new Parsoid(
$this->getServiceContainer()->getParsoidSiteConfig(),
$this->getServiceContainer()->getParsoidDataAccess()
),
MainConfigSchema::getDefaultValue( MainConfigNames::ParsoidSettings ),
$this->getServiceContainer()->getParsoidPageConfigFactory(),
$this->getServiceContainer()->getContentHandlerFactory()
);
}
private function createHtmlToContentTransformWithOriginalData( $html = '', ?array $options = null ) {
$transform = $this->createHtmlToContentTransform( $html );
$options ??= [
'contentmodel' => 'wikitext',
'offsetType' => 'byte',
];
// Set some options to assert on $transform object.
$transform->setOptions( $options );
$this->setOriginalData( $transform );
return $transform;
}
public function testGetOriginalBodyRequiresValidDataParsoid() {
$transform = $this->createHtmlToContentTransform( self::ORIG_HTML );
$transform->setOriginalSchemaVersion( '2.4.0' );
$transform->setOriginalHtml( self::ORIG_HTML );
// Invalid data-parsoid structure!
$transform->setOriginalDataParsoid( [ 'foo' => 'bar' ] );
$exception = new ClientError( 'Invalid data-parsoid was provided.' );
$this->expectException( get_class( $exception ) );
$this->expectExceptionMessage( $exception->getMessage() );
// Should throw because setOriginalDataParsoid got bad data.
// Note that setOriginalDataParsoid can't validate immediately, because it
// may not know the schema version. The order in which the setters are called
// should not matter. All checks happen in getters.
$transform->getOriginalBody();
}
public function testHasOriginalHtml() {
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML );
$this->assertFalse( $transform->hasOriginalHtml() );
$transform->setOriginalDataParsoid( self::ORIG_DATA_PARSOID );
$this->assertFalse( $transform->hasOriginalHtml() );
$transform->setOriginalHtml( self::ORIG_HTML );
$this->assertTrue( $transform->hasOriginalHtml() );
}
public function testGetOriginalSchemaVersion() {
$transform = $this->createHtmlToContentTransform( self::ORIG_HTML ); // no version inline
$this->assertSame( Parsoid::defaultHTMLVersion(), $transform->getOriginalSchemaVersion() );
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML ); // has version inline
$this->assertSame( '2.4.0', $transform->getOriginalSchemaVersion() );
$transform->setOriginalSchemaVersion( '2.3.0' );
$this->assertSame( '2.3.0', $transform->getOriginalSchemaVersion() );
}
public function testGetSchemaVersion() {
$transform = $this->createHtmlToContentTransform( self::ORIG_HTML ); // no version inline
$this->assertSame( Parsoid::defaultHTMLVersion(), $transform->getSchemaVersion() );
// Should have an effect, since the HTML has no version specified inline
$transform->setOriginalSchemaVersion( '2.3.0' );
$this->assertSame( '2.3.0', $transform->getSchemaVersion() );
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML ); // has version inline
$this->assertSame( '2.4.0', $transform->getSchemaVersion() );
// Should have no impact, since the HTML has a version specified inline
$transform->setOriginalSchemaVersion( '2.3.0' );
$this->assertSame( '2.4.0', $transform->getSchemaVersion() );
}
public function testHasOriginalDataParsoid() {
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML );
$this->assertFalse( $transform->hasOriginalDataParsoid() );
$transform->setOriginalDataParsoid( self::ORIG_DATA_PARSOID );
$this->assertTrue( $transform->hasOriginalDataParsoid() );
}
public function testGetOriginalHtml() {
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML );
$this->assertFalse( $transform->hasOriginalHtml() );
$transform->setOriginalSchemaVersion( '2.4.0' );
$transform->setOriginalHtml( self::ORIG_HTML );
$this->assertTrue( $transform->hasOriginalHtml() );
$this->assertSame( self::ORIG_HTML, $transform->getOriginalHtml() );
}
public function testGetOriginalBody() {
$transform = $this->createHtmlToContentTransform( self::MODIFIED_HTML );
$transform->setOriginalSchemaVersion( '2.4.0' );
$transform->setOriginalHtml( self::ORIG_HTML );
$this->assertSame(
self::ORIG_BODY,
ContentUtils::toXML( $transform->getOriginalBody() )
);
}
private function assertTransformHasOriginalContent( HtmlToContentTransform $transform, $text ) {
$this->assertTrue( $transform->knowsOriginalContent() );
$access = TestingAccessWrapper::newFromObject( $transform );
/** @var PageConfig $pageConfig */
$pageConfig = $access->getPageConfig();
$this->assertSame( $text, $pageConfig->getPageMainContent() );
/** @var ?SelserData $selserData */
$selserData = $access->getSelserData();
$this->assertNotNull( $selserData );
}
public function testOldId() {
$text = 'Lorem Ipsum';
$rev = $this->editPage( __METHOD__, $text )->getValue()['revision-record'];
$transform = $this->createHtmlToContentTransformWithOriginalData();
$transform->setOriginalRevisionId( $rev->getId() );
$this->assertSame( $rev->getId(), $transform->getOriginalRevisionId() );
$this->assertTransformHasOriginalContent( $transform, $text );
}
public function testSetOriginalRevision() {
$text = 'Lorem Ipsum';
$page = PageIdentityValue::localIdentity( 17, NS_MAIN, 'Test' );
$rev = new MutableRevisionRecord( $page );
$rev->setContent( SlotRecord::MAIN, new WikitextContent( $text ) );
$transform = $this->createHtmlToContentTransformWithOriginalData();
$transform->setOriginalRevision( $rev );
$this->assertSame( $rev->getId(), $transform->getOriginalRevisionId() );
$this->assertTransformHasOriginalContent( $transform, $text );
}
public function testSetOriginalText() {
$text = 'Lorem Ipsum';
$transform = $this->createHtmlToContentTransformWithOriginalData();
$transform->setOriginalText( $text );
$this->assertTransformHasOriginalContent( $transform, $text );
}
public function testSetOriginalContent() {
$text = 'Lorem Ipsum';
$transform = $this->createHtmlToContentTransformWithOriginalData();
$transform->setOriginalContent( new JsonContent( $text ) );
$this->assertTransformHasOriginalContent( $transform, $text );
$this->assertSame( CONTENT_MODEL_JSON, $transform->getContentModel() );
}
public function testOptions() {
$transform = $this->createHtmlToContentTransformWithOriginalData( '', [] );
$this->assertSame( 'wikitext', $transform->getContentModel() );
$this->assertSame( 'byte', $transform->getOffsetType() );
$transform->setOptions( [
'contentmodel' => 'text',
'offsetType' => 'ucs2',
] );
$this->assertSame( 'text', $transform->getContentModel() );
$this->assertSame( 'ucs2', $transform->getOffsetType() );
}
/**
* Assert that in case we set only one of the options, the other(s)
* should fall back to their correct defaults.
*/
public function testOptionsForIndividualDefaults() {
$transform = $this->createHtmlToContentTransformWithOriginalData( '', [] );
$this->assertSame( 'wikitext', $transform->getContentModel() );
$this->assertSame( 'byte', $transform->getOffsetType() );
$transform = $this->createHtmlToContentTransformWithOriginalData( '', [] );
// Set only content model
$transform->setOptions( [ 'contentmodel' => 'text' ] );
$this->assertSame( 'text', $transform->getContentModel() );
$this->assertSame( 'byte', $transform->getOffsetType() );
$transform = $this->createHtmlToContentTransformWithOriginalData( '', [] );
// Set only offset type
$transform->setOptions( [ 'offsetType' => 'ucs2' ] );
$this->assertSame( 'wikitext', $transform->getContentModel() );
$this->assertSame( 'ucs2', $transform->getOffsetType() );
}
private function getTextFromFile( string $name ): string {
return trim( file_get_contents( __DIR__ . "/data/Transform/$name" ) );
}
public function testDowngrade() {
$html = $this->getTextFromFile( 'Minimal.html' ); // Uses profile version 2.4.0
$transform = $this->createHtmlToContentTransform( $html );
$transform->setMetrics( StatsFactory::newNull() );
$transform->setOriginalSchemaVersion( '999.0.0' );
$transform->setOriginalHtml( $html );
$transform->setOriginalDataParsoid( self::ORIG_DATA_PARSOID );
// should automatically apply downgrade
$oldBody = $transform->getOriginalBody();
// all getters should now reflect the state after the downgrade.
// we expect a version >= 2.4.0 and < 3.0.0. So use ^2.4.0
$this->assertTrue( Semver::satisfies( $transform->getOriginalSchemaVersion(), '^2.4.0' ) );
$this->assertNotSame( $html, $transform->getOriginalHtml() );
$this->assertNotSame( $oldBody, ContentUtils::toXML( $transform->getOriginalBody() ) );
}
public function testModifiedDataMW() {
$html = $this->getTextFromFile( 'Minimal-999.html' ); // Uses profile version 2.4.0
$transform = $this->createHtmlToContentTransform( $html );
$transform->setOriginalHtml( self::ORIG_HTML );
$transform->setOriginalDataParsoid( self::ORIG_DATA_PARSOID );
$transform->setModifiedDataMW( self::MODIFIED_DATA_MW );
// should automatically apply downgrade
$doc = $transform->getModifiedDocument();
$html = ContentUtils::toXML( $doc );
// all getters should now reflect the state after the downgrade.
$this->assertNotSame( '"hi"', $html );
}
public function testMetrics() {
$html = '<html><body>xyz</body></html>'; // no schema version!
$transform = $this->createHtmlToContentTransform( $html );
$statsCache = new StatsCache();
$statsFactory = new StatsFactory( $statsCache, new NullEmitter(), new NullLogger() );
$transform->setMetrics( $statsFactory );
// getSchemaVersion should ioncrement the html2wt.original.version.notinline counter
// because the input HTML doesn't contain a schema version.
$transform->getSchemaVersion();
$this->assertCount( 1, $statsCache->getAllMetrics() );
$this->assertNotNull(
$statsCache->get(
'',
'html2wt_original_version_total',
'Wikimedia\Stats\Metrics\CounterMetric'
)->getName()
);
}
public function testHtmlSize() {
$html = '<html><body>hällö</body></html>'; // use some multi-byte characters
$transform = $this->createHtmlToContentTransform( $html );
// make sure it counts characters, not bytes
$this->assertSame( 31, $transform->getModifiedHtmlSize() );
}
public function testSetOriginalHTML() {
$html = '<html><body>xyz</body></html>'; // no schema version!
$transform = $this->createHtmlToContentTransform( $html );
// mainly check that this doesn't explode.
$transform->setOriginalSchemaVersion( '999.0.0' );
$transform->setOriginalHtml( 'hi' );
$this->assertTrue( $transform->hasOriginalHtml() );
$this->assertFalse( $transform->hasOriginalDataParsoid() );
}
public function testSetOriginalDataParsoidAfterGetModified() {
// Use HTML that contains a schema version!
// Otherwise, we won't trigger the right error.
$html = $this->getTextFromFile( 'Minimal.html' );
$transform = $this->createHtmlToContentTransform( $html );
$transform->getModifiedDocument();
$this->expectException( LogicException::class );
$this->expectExceptionMessage( 'getModifiedDocument()' );
$transform->setOriginalDataParsoid( [] );
}
public function testOffsetTypeMismatch() {
$transform = $this->createHtmlToContentTransform( self::ORIG_HTML );
$this->setOriginalData( $transform );
// Set some options to assert on $transform.
$transform->setOptions( [
'contentmodel' => 'wikitext',
'offsetType' => 'byte',
] );
$dataParsoid = self::ORIG_DATA_PARSOID;
$dataParsoid['offsetType'] = 'UCS2';
$transform->setOriginalDataParsoid( $dataParsoid );
$this->expectException( ClientError::class );
$transform->getOriginalBody();
}
public function testHtmlToWikitextContent() {
$transform = $this->createHtmlToContentTransform( self::ORIG_HTML );
// Set some options to assert on $transform.
$transform->setOptions( [
'contentmodel' => null,
'offsetType' => 'byte',
] );
$content = $transform->htmlToContent();
$this->assertInstanceOf( WikitextContent::class, $content );
$this->assertStringContainsString( 'Original Content', $content->getText() );
}
public function testHtmlToJsonContent() {
$jsonConfigHtml = $this->getTextFromFile( 'JsonConfig.html' );
$transform = $this->createHtmlToContentTransform( $jsonConfigHtml );
// Set some options to assert on $transform.
$transform->setOptions( [
'contentmodel' => CONTENT_MODEL_JSON,
'offsetType' => 'byte',
] );
$content = $transform->htmlToContent();
$this->assertInstanceOf( JsonContent::class, $content );
}
}
|
