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
|
<?php
namespace MediaWiki\Tests\Parser\Parsoid;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\ParserOutputFlags;
use MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter;
use MediaWikiUnitTestCase;
use Wikimedia\Bcp47Code\Bcp47CodeValue;
use Wikimedia\Parsoid\Core\PageBundle;
/**
* @covers \MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter
*/
class PageBundleParserOutputConverterTest extends MediaWikiUnitTestCase {
/** @dataProvider provideParserOutputFromPageBundle */
public function testParserOutputFromPageBundle( PageBundle $pageBundle ) {
$output = PageBundleParserOutputConverter::parserOutputFromPageBundle( $pageBundle );
$this->assertSame( $pageBundle->html, $output->getRawText() );
$extensionData = $output->getExtensionData( PageBundleParserOutputConverter::PARSOID_PAGE_BUNDLE_KEY );
$this->assertSame( $pageBundle->mw, $extensionData['mw'] );
$this->assertSame( $pageBundle->parsoid, $extensionData['parsoid'] );
$this->assertSame( $pageBundle->headers, $extensionData['headers'] );
if ( isset( $pageBundle->headers['content-language'] ) ) {
$this->assertSame( $pageBundle->headers['content-language'], $extensionData['headers']['content-language'] );
$this->assertSame( $pageBundle->headers['content-language'], (string)$output->getLanguage() );
}
$this->assertSame( $pageBundle->version, $extensionData['version'] );
$this->assertSame( $pageBundle->contentmodel, $extensionData['contentmodel'] );
}
/** @dataProvider provideParserOutputFromPageBundle */
public function testParserOutputFromPageBundleShouldPreserveMetadata( PageBundle $pageBundle ) {
// Create a ParserOutput with some metadata properties already set.
$original = new ParserOutput();
$original->setExtensionData( 'test-key', 'test-data' );
$original->setOutputFlag( ParserOutputFlags::NO_GALLERY );
$original->setPageProperty( 'forcetoc', '' );
$original->recordOption( 'test1' );
$original->recordOption( 'test2' );
$original->setLanguage( new Bcp47CodeValue( 'fr' ) );
// This should preserve the metadata.
$output = PageBundleParserOutputConverter::parserOutputFromPageBundle( $pageBundle, $original );
$this->assertSame( $pageBundle->html, $output->getRawText() );
// Check the page bundle data
$extensionData = $output->getExtensionData( PageBundleParserOutputConverter::PARSOID_PAGE_BUNDLE_KEY );
$this->assertSame( $pageBundle->mw, $extensionData['mw'] );
$this->assertSame( $pageBundle->parsoid, $extensionData['parsoid'] );
$this->assertSame( $pageBundle->headers, $extensionData['headers'] );
$this->assertSame( $pageBundle->headers['content-language'], $extensionData['headers']['content-language'] );
$this->assertSame( $pageBundle->version, $extensionData['version'] );
$this->assertSame( $pageBundle->contentmodel, $extensionData['contentmodel'] );
// Check our additional metadata properties
$this->assertSame( 'test-data', $output->getExtensionData( 'test-key' ) );
$this->assertSame( true, $output->getOutputFlag( ParserOutputFlags::NO_GALLERY ) );
$this->assertSame( '', $output->getPageProperty( 'forcetoc' ) );
$this->assertSame( [ 'test1', 'test2' ], $output->getUsedOptions() );
// Some meta-data can be overridden
if ( isset( $pageBundle->headers['content-language'] ) ) {
$this->assertSame(
$pageBundle->headers['content-language'],
(string)$output->getLanguage()
);
} else {
$this->assertSame( 'fr', (string)$output->getLanguage() );
}
// Check that $original and $output can be modified independently of each other
$original->setRawText( 'new text version' );
$this->assertNotSame( 'new text version', $output->getRawText() );
}
public static function provideParserOutputFromPageBundle() {
yield 'should convert PageBundle containing data-parsoid and data-mw' => [
new PageBundle(
'html content',
[ 'ids' => '1.33' ],
[ 'ids' => '1.33' ],
'1.x',
[ 'content-language' => 'abc' ],
'testing'
)
];
yield 'should convert PageBundle that contains no data-parsoid or data-mw' => [
new PageBundle(
'html content',
[],
[],
'1.x',
[ 'content-language' => null ]
)
];
}
/** @dataProvider providePageBundleFromParserOutput */
public function testPageBundleFromParserOutput( ParserOutput $parserOutput ) {
$pageBundle = PageBundleParserOutputConverter::pageBundleFromParserOutput( $parserOutput );
$this->assertSame( $parserOutput->getRawText(), $pageBundle->html );
$extensionData = $parserOutput->getExtensionData(
PageBundleParserOutputConverter::PARSOID_PAGE_BUNDLE_KEY
);
$this->assertSame( $extensionData['parsoid'] ?? [], $pageBundle->parsoid );
$this->assertSame( $extensionData['mw'] ?? [], $pageBundle->mw );
// NOTE: We default to "0.0.0" as a fix for T325137. We can go back to null
// once PageBundle::responseData is more robust.
$this->assertSame( $extensionData['version'] ?? '0.0.0', $pageBundle->version );
$this->assertSame( $extensionData['headers'] ?? [], $pageBundle->headers );
$this->assertSame( $extensionData['contentmodel'] ?? null, $pageBundle->contentmodel );
if ( isset( $extensionData['headers']['content-language'] ) ) {
$this->assertSame(
$extensionData['headers']['content-language'],
$pageBundle->headers['content-language']
);
}
if ( $parserOutput->getLanguage() ) {
$this->assertSame(
$parserOutput->getLanguage(),
$pageBundle->headers['content-language']
);
}
}
public function providePageBundleFromParserOutput() {
yield 'should convert ParsoidOutput containing data-parsoid and data-mw' => [
$this->getParsoidOutput(
'hello world',
[
'parsoid' => [ 'ids' => '1.22' ],
'mw' => [],
'version' => '2.x',
'headers' => [ 'content-language' => 'xyz' ],
'testing'
]
)
];
yield 'should convert ParsoidOutput that does not contain data-parsoid or data-mw' => [
$this->getParsoidOutput(
'hello world',
[
'parsoid' => null,
'mw' => null,
'version' => null,
'headers' => [ 'content-language' => null ]
]
)
];
}
public function testLanguageTransfer() {
$parserOutput = new ParserOutput( '' );
$parserOutput->setLanguage( new Bcp47CodeValue( 'de' ) );
$pb = PageBundleParserOutputConverter::pageBundleFromParserOutput( $parserOutput );
$this->assertIsString( $pb->headers['content-language'] );
$this->assertEquals( 'de', $pb->headers['content-language'] );
}
private function getParsoidOutput(
string $rawText,
?array $pageBundleData
): ParserOutput {
$parserOutput = new ParserOutput( $rawText );
$parserOutput->setExtensionData(
PageBundleParserOutputConverter::PARSOID_PAGE_BUNDLE_KEY, $pageBundleData
);
return $parserOutput;
}
}
|
