Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/tests/phpunit/integration/includes/Rest/Handler/HTMLTransformInputTest.php

224 lines
6.3 KiB
PHP
Raw Normal View History

Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
<?php
namespace MediaWiki\Tests\Rest\Handler;
use Exception;
use MediaWiki\Rest\Handler\HTMLTransformInput;
use MediaWikiIntegrationTestCase;
use Wikimedia\Parsoid\Core\ClientError;
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
use Wikimedia\Parsoid\Utils\ContentUtils;
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
/**
* @covers \MediaWiki\Rest\Handler\HTMLTransformInput
*/
class HTMLTransformInputTest extends MediaWikiIntegrationTestCase {
private const ORIG_BODY = '<body>Original HTML</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 getOriginalData() {
$profileVersion = '2.4.0';
$htmlProfileUri = 'https://www.mediawiki.org/wiki/Specs/HTML/' . $profileVersion;
$dataParsoidProfileUri = 'https://www.mediawiki.org/wiki/Specs/data-parsoid/' . $profileVersion;
$dataMwProfileUri = 'https://www.mediawiki.org/wiki/Specs/data-mw/' . $profileVersion;
$htmlContentType = "text/html;profile=\"$htmlProfileUri\"";
$dataParsoidContentType = "application/json;profile=\"$dataParsoidProfileUri\"";
$dataMwContentType = "application/json;profile=\"$dataMwProfileUri\"";
return [
'revid' => 1,
'html' => [
'body' => self::ORIG_HTML,
'headers' => [
'content-type' => $htmlContentType,
],
],
'data-mw' => [
'body' => self::ORIG_DATA_MW,
'headers' => [
'content-type' => $dataMwContentType,
],
],
'data-parsoid' => [
'body' => self::ORIG_DATA_PARSOID,
'headers' => [
'content-type' => $dataParsoidContentType,
],
],
];
}
private function newHTMLTransformInput() {
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
$input = new HTMLTransformInput( self::ORIG_HTML );
Rest: offsetType is not in the options sub-array This patch fixes an issue that happened when the assumption was made that offsetType is in the opts sub-array but it's really not part of it. It's directly in attributes, copied from envOptions, which causes the offset type to always be byte. Change-Id: I5d1a8a7cdfe13c22a2afa70128203050a4b5f98a
2022-07-26 10:33:42 +00:00
$originalData = $this->getOriginalData();
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
// Set some options to assert on $input.
Rest: offsetType is not in the options sub-array This patch fixes an issue that happened when the assumption was made that offsetType is in the opts sub-array but it's really not part of it. It's directly in attributes, copied from envOptions, which causes the offset type to always be byte. Change-Id: I5d1a8a7cdfe13c22a2afa70128203050a4b5f98a
2022-07-26 10:33:42 +00:00
$input->setOptions( [
'contentmodel' => 'wikitext',
'offsetType' => 'byte',
] );
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
$input->setInputFormat( 'pagebundle' );
$input->setModifiedDataMW( [ self::MODIFIED_DATA_MW ] );
Rest: offsetType is not in the options sub-array This patch fixes an issue that happened when the assumption was made that offsetType is in the opts sub-array but it's really not part of it. It's directly in attributes, copied from envOptions, which causes the offset type to always be byte. Change-Id: I5d1a8a7cdfe13c22a2afa70128203050a4b5f98a
2022-07-26 10:33:42 +00:00
$input->setOriginalRevisionId( $originalData['revid'] );
$input->setOriginalData( $originalData );
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
return $input;
}
public function provideBadOriginalData() {
$base = $this->getOriginalData();
$orig = $base;
unset( $orig['html']['headers']['content-type'] );
yield 'no html content type' => [
$orig,
new ClientError( 'Content-type of original html is missing.' )
];
$orig = $base;
$orig['html']['headers']['content-type'] = 'xyz';
yield 'bad html content type' => [
$orig,
new ClientError( 'Content-type of original html is missing.' )
];
$orig = $base;
unset( $orig['data-parsoid']['body']['ids'] );
yield 'missing ids key in data-parsoid' => [
$orig,
new ClientError( 'Invalid data-parsoid was provided.' )
];
}
/**
* @dataProvider provideBadOriginalData
*
* @param array $original
* @param Exception $exception
*
* @return void
* @throws ClientError
*/
public function testBadOriginalData( array $original, Exception $exception ) {
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
$input = new HTMLTransformInput( self::ORIG_HTML );
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
$this->expectException( get_class( $exception ) );
$this->expectExceptionMessage( $exception->getMessage() );
$input->setOriginalData( $original );
$input->getOriginalSchemaVersion();
$input->getOriginalPageBundle();
}
public function testHasOriginalHtml() {
$ctx = $this->newHTMLTransformInput();
$this->assertTrue( $ctx->hasOriginalHtml() );
}
public function testGetOriginalSchemaVersion() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame( '2.4.0', $ctx->getOriginalSchemaVersion() );
}
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
public function testGetSchemaVersion() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame( '2.4.0', $ctx->getSchemaVersion() );
}
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
public function testInputIsPageBundle() {
$ctx = $this->newHTMLTransformInput();
$this->assertTrue( $ctx->inputIsPageBundle() );
}
public function testGetOriginalPageBundle() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame(
self::ORIG_HTML,
$ctx->getOriginalPageBundle()->html
);
}
public function testGetOriginalHtml() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame(
self::ORIG_HTML,
$ctx->getOriginalHtml()
);
}
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
public function testGetOriginalBody() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame(
self::ORIG_BODY,
ContentUtils::toXML( $ctx->getOriginalBody() )
);
}
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
public function testGetModifiedPageBundle() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame(
[ self::MODIFIED_DATA_MW ],
$ctx->getModifiedPageBundle( '1.1' )->mw
);
}
public function testHasModifiedDataMw() {
$ctx = $this->newHTMLTransformInput();
$this->assertTrue( $ctx->hasModifiedDataMw() );
}
public function testOldId() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame( 1, $ctx->getOriginalRevisionId() );
}
public function testGetContentModel() {
$ctx = $this->newHTMLTransformInput();
$this->assertSame( 'wikitext', $ctx->getContentModel() );
}
public function testGetEnvOpts() {
$ctx = $this->newHTMLTransformInput();
Rest: offsetType is not in the options sub-array This patch fixes an issue that happened when the assumption was made that offsetType is in the opts sub-array but it's really not part of it. It's directly in attributes, copied from envOptions, which causes the offset type to always be byte. Change-Id: I5d1a8a7cdfe13c22a2afa70128203050a4b5f98a
2022-07-26 10:33:42 +00:00
$this->assertSame( 'byte', $ctx->getOffsetType() );
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
}
Move dowgrade logic into HTMLTransformInput Moving lazy initialization logic into HTMLTransformInput to clarify flow of information. DEPLOY: Mention that we've fixed $htmlSize and it will affect metrics graphs when this roles out. Change-Id: If09afc4b933ec99561ac9e4d53383bd42a856eaa
2022-07-22 10:26:39 +00:00
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
$input = new HTMLTransformInput( $html );
$input->setInputFormat( 'pagebundle' );
$original = $this->getOriginalData();
// Specify newer profile version for original HTML
$original['html']['headers']['content-type'] = 'text/html;profile="https://www.mediawiki.org/wiki/Specs/HTML/999.0.0"';
// The profile version given inline in the original HTML doesn't matter, it's ignored
$original['html']['body'] = $html;
$input->setOriginalData( $original );
$oldBody = $input->getOriginalBody();
$input->downgradeOriginalData( '2.4.0' );
// all getters should now reflect the state after the downgrade.
$this->assertSame( '2.5.0', $input->getOriginalSchemaVersion() );
$this->assertNotSame( $html, $input->getOriginalHtml() );
$this->assertNotSame( $oldBody, ContentUtils::toXML( $input->getOriginalBody() ) );
}
Move knowledge about the attribs array out of TransformContext This renames TransformContext to HTMLTransformInput. It is becoming a wrapper around the input HTML, with a bunch of optional context data attached. This introduces a factory method for HTMLTransformInput, so we can extract knowledge about the structure of the $attribs array from HTMLTransformInput. This also allows us to inject Document objects and perhaps PageBundle objects, instead of just arrays. Change-Id: I66f9c5dbb50c6bf1f582adad7766422216482402
2022-07-20 18:19:59 +00:00
}
Reference in a new issue Copy permalink