2023-10-20 13:21:53 +00:00
|
|
|
<?php
|
|
|
|
|
|
2024-02-16 16:49:05 +00:00
|
|
|
namespace MediaWiki\Tests\OutputTransform;
|
2023-10-20 13:21:53 +00:00
|
|
|
|
2023-12-14 19:20:33 +00:00
|
|
|
use MediaWiki\Parser\ParserOutput;
|
2023-10-20 13:21:53 +00:00
|
|
|
use Wikimedia\Parsoid\Core\SectionMetadata;
|
|
|
|
|
use Wikimedia\Parsoid\Core\TOCData;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Consts and utils used for OutputTransform tests
|
|
|
|
|
*/
|
|
|
|
|
class TestUtils {
|
|
|
|
|
public const TEST_DOC = <<<EOF
|
|
|
|
|
<p>Test document.
|
|
|
|
|
</p>
|
|
|
|
|
<meta property="mw:PageProp/toc" />
|
Move section heading formatting to post-cache transform (take 2)
[Previously attempted in de0646843a346153f157dbb15f6a205655195612,
reverted in e72e1cd16368346b66853f68e2d13f9b416d5a11.]
Previously, Parser.php used Linker::makeHeadline() in order to
generate the `<h2><span class="mw-headline" id="...">...</span></h2>`
markup for section headings, and this was saved in the parser cache.
Now it generates heading tags with placeholder attributes like
`<h2 data-mw-...="..." ...>...</h2>`, and they are replaced in a
post-cache transform to generate the final heading markup, similarly
to how section edit links already worked.
The purpose of these changes is to allow changing the final markup
depending on skin options without splitting the parser cache (T13555).
Deployment and undeployment safety:
* The new post-cache transform has been already added in commit
Ibce512b3c4a52f74b2d2124f0159e306f2689ea5 for forward-compatibility
(so that if this patch is reverted, new parser cache entries
will still be shown correctly).
Implementation notes:
* There are many ways to keep the temporary information other than
`data-mw-...` attributes, but this way is the easiest to handle
in a post-cache transform (everything is on the DOM node we want
to modify), is compatible with other heading-enhancing code in
DiscussionTools and MobileFrontend, and remains human-readable
if the post-cache transform doesn't run.
* Sadly this code can't be reused to add section heading markup and
section edit links to Parsoid (T269630), because it lacks some of
the necessary metadata, and exposes the rest in ways that are
trickier to handle in a post-cache transform (on other DOM nodes
or outside the document).
Depends-On: If85f89c40834618f23dc0ace2e599efb3b6d5ed4
Bug: T13555
Change-Id: If04d72f427ec3c3730e757cbb3ade8840c09f7d3
2024-01-13 06:26:51 +00:00
|
|
|
<h2 data-mw-anchor="Section_1">Section 1<mw:editsection page="Test Page" section="1">Section 1</mw:editsection></h2>
|
2023-10-20 13:21:53 +00:00
|
|
|
<p>One
|
|
|
|
|
</p>
|
Move section heading formatting to post-cache transform (take 2)
[Previously attempted in de0646843a346153f157dbb15f6a205655195612,
reverted in e72e1cd16368346b66853f68e2d13f9b416d5a11.]
Previously, Parser.php used Linker::makeHeadline() in order to
generate the `<h2><span class="mw-headline" id="...">...</span></h2>`
markup for section headings, and this was saved in the parser cache.
Now it generates heading tags with placeholder attributes like
`<h2 data-mw-...="..." ...>...</h2>`, and they are replaced in a
post-cache transform to generate the final heading markup, similarly
to how section edit links already worked.
The purpose of these changes is to allow changing the final markup
depending on skin options without splitting the parser cache (T13555).
Deployment and undeployment safety:
* The new post-cache transform has been already added in commit
Ibce512b3c4a52f74b2d2124f0159e306f2689ea5 for forward-compatibility
(so that if this patch is reverted, new parser cache entries
will still be shown correctly).
Implementation notes:
* There are many ways to keep the temporary information other than
`data-mw-...` attributes, but this way is the easiest to handle
in a post-cache transform (everything is on the DOM node we want
to modify), is compatible with other heading-enhancing code in
DiscussionTools and MobileFrontend, and remains human-readable
if the post-cache transform doesn't run.
* Sadly this code can't be reused to add section heading markup and
section edit links to Parsoid (T269630), because it lacks some of
the necessary metadata, and exposes the rest in ways that are
trickier to handle in a post-cache transform (on other DOM nodes
or outside the document).
Depends-On: If85f89c40834618f23dc0ace2e599efb3b6d5ed4
Bug: T13555
Change-Id: If04d72f427ec3c3730e757cbb3ade8840c09f7d3
2024-01-13 06:26:51 +00:00
|
|
|
<h2 data-mw-anchor="Section_2">Section 2<mw:editsection page="Test Page" section="2">Section 2</mw:editsection></h2>
|
2023-10-20 13:21:53 +00:00
|
|
|
<p>Two
|
|
|
|
|
</p>
|
2024-01-15 21:43:49 +00:00
|
|
|
<h3 data-mw-anchor="Section_2.1">Section 2.1</h3>
|
2023-10-20 13:21:53 +00:00
|
|
|
<p>Two point one
|
|
|
|
|
</p>
|
Move section heading formatting to post-cache transform (take 2)
[Previously attempted in de0646843a346153f157dbb15f6a205655195612,
reverted in e72e1cd16368346b66853f68e2d13f9b416d5a11.]
Previously, Parser.php used Linker::makeHeadline() in order to
generate the `<h2><span class="mw-headline" id="...">...</span></h2>`
markup for section headings, and this was saved in the parser cache.
Now it generates heading tags with placeholder attributes like
`<h2 data-mw-...="..." ...>...</h2>`, and they are replaced in a
post-cache transform to generate the final heading markup, similarly
to how section edit links already worked.
The purpose of these changes is to allow changing the final markup
depending on skin options without splitting the parser cache (T13555).
Deployment and undeployment safety:
* The new post-cache transform has been already added in commit
Ibce512b3c4a52f74b2d2124f0159e306f2689ea5 for forward-compatibility
(so that if this patch is reverted, new parser cache entries
will still be shown correctly).
Implementation notes:
* There are many ways to keep the temporary information other than
`data-mw-...` attributes, but this way is the easiest to handle
in a post-cache transform (everything is on the DOM node we want
to modify), is compatible with other heading-enhancing code in
DiscussionTools and MobileFrontend, and remains human-readable
if the post-cache transform doesn't run.
* Sadly this code can't be reused to add section heading markup and
section edit links to Parsoid (T269630), because it lacks some of
the necessary metadata, and exposes the rest in ways that are
trickier to handle in a post-cache transform (on other DOM nodes
or outside the document).
Depends-On: If85f89c40834618f23dc0ace2e599efb3b6d5ed4
Bug: T13555
Change-Id: If04d72f427ec3c3730e757cbb3ade8840c09f7d3
2024-01-13 06:26:51 +00:00
|
|
|
<h2 data-mw-anchor="Section_3">Section 3<mw:editsection page="Test Page" section="4">Section 3</mw:editsection></h2>
|
2023-10-20 13:21:53 +00:00
|
|
|
<p>Three
|
|
|
|
|
</p>
|
|
|
|
|
EOF;
|
|
|
|
|
public const TEST_DOC_WITH_LINKS = <<<EOF
|
|
|
|
|
<p>Test document.
|
|
|
|
|
</p>
|
|
|
|
|
<meta property="mw:PageProp/toc" />
|
|
|
|
|
<h2><span class="mw-headline" id="Section_1">Section 1</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/w/index.php?title=Test_Page&action=edit&section=1" title="Edit section: Section 1">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
|
|
|
|
|
<p>One
|
|
|
|
|
</p>
|
|
|
|
|
<h2><span class="mw-headline" id="Section_2">Section 2</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/w/index.php?title=Test_Page&action=edit&section=2" title="Edit section: Section 2">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
|
|
|
|
|
<p>Two
|
|
|
|
|
</p>
|
|
|
|
|
<h3><span class="mw-headline" id="Section_2.1">Section 2.1</span></h3>
|
|
|
|
|
<p>Two point one
|
|
|
|
|
</p>
|
|
|
|
|
<h2><span class="mw-headline" id="Section_3">Section 3</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/w/index.php?title=Test_Page&action=edit&section=4" title="Edit section: Section 3">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
|
|
|
|
|
<p>Three
|
|
|
|
|
</p>
|
|
|
|
|
EOF;
|
|
|
|
|
public const TEST_DOC_WITHOUT_LINKS = <<<EOF
|
|
|
|
|
<p>Test document.
|
|
|
|
|
</p>
|
|
|
|
|
<meta property="mw:PageProp/toc" />
|
|
|
|
|
<h2><span class="mw-headline" id="Section_1">Section 1</span></h2>
|
|
|
|
|
<p>One
|
|
|
|
|
</p>
|
|
|
|
|
<h2><span class="mw-headline" id="Section_2">Section 2</span></h2>
|
|
|
|
|
<p>Two
|
|
|
|
|
</p>
|
|
|
|
|
<h3><span class="mw-headline" id="Section_2.1">Section 2.1</span></h3>
|
|
|
|
|
<p>Two point one
|
|
|
|
|
</p>
|
|
|
|
|
<h2><span class="mw-headline" id="Section_3">Section 3</span></h2>
|
|
|
|
|
<p>Three
|
|
|
|
|
</p>
|
|
|
|
|
EOF;
|
|
|
|
|
|
2024-03-01 19:28:21 +00:00
|
|
|
// In this test, the `>` is not escaped in the 'data-mw-anchor' attribute and tag content, which
|
|
|
|
|
// is allowed in HTML, but it's not the serialization used by the Parser. Extensions that modify
|
|
|
|
|
// the HTML, e.g. DiscussionTools, can cause this to appear.
|
|
|
|
|
public const TEST_DOC_ANGLE_BRACKETS = <<<HTML
|
|
|
|
|
<h2 data-mw-anchor=">">><mw:editsection page="Test Page" section="1">></mw:editsection></h2>
|
|
|
|
|
HTML;
|
|
|
|
|
public const TEST_DOC_ANGLE_BRACKETS_WITH_LINKS = <<<HTML
|
|
|
|
|
<h2><span class="mw-headline" id=">">></span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/w/index.php?title=Test_Page&action=edit&section=1" title="Edit section: >">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
|
|
|
|
|
HTML;
|
|
|
|
|
public const TEST_DOC_ANGLE_BRACKETS_WITHOUT_LINKS = <<<HTML
|
|
|
|
|
<h2><span class="mw-headline" id=">">></span></h2>
|
|
|
|
|
HTML;
|
|
|
|
|
|
2023-10-20 13:21:53 +00:00
|
|
|
public const TEST_TO_DEDUP = <<<EOF
|
|
|
|
|
<p>This is a test document.</p>
|
|
|
|
|
<style data-mw-deduplicate="duplicate1">.Duplicate1 {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate1">.Duplicate1 {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate2">.Duplicate2 {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate1">.Duplicate1 {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate2">.Duplicate2 {}</style>
|
|
|
|
|
<style data-mw-not-deduplicate="duplicate1">.Duplicate1 {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate1">.Same-attribute-different-content {}</style>
|
|
|
|
|
<style data-mw-deduplicate="duplicate3">.Duplicate1 {}</style>
|
|
|
|
|
<style>.Duplicate1 {}</style>
|
|
|
|
|
EOF;
|
|
|
|
|
|
|
|
|
|
public static function initSections( ParserOutput $po ): void {
|
|
|
|
|
$po->setTOCData( new TOCData( SectionMetadata::fromLegacy( [
|
|
|
|
|
'index' => "1",
|
|
|
|
|
'level' => 1,
|
|
|
|
|
'toclevel' => 1,
|
|
|
|
|
'number' => "1",
|
|
|
|
|
'line' => "Section 1",
|
|
|
|
|
'anchor' => "Section_1"
|
|
|
|
|
] ), SectionMetadata::fromLegacy( [
|
|
|
|
|
'index' => "2",
|
|
|
|
|
'level' => 1,
|
|
|
|
|
'toclevel' => 1,
|
|
|
|
|
'number' => "2",
|
|
|
|
|
'line' => "Section 2",
|
|
|
|
|
'anchor' => "Section_2"
|
|
|
|
|
] ), SectionMetadata::fromLegacy( [
|
|
|
|
|
'index' => "3",
|
|
|
|
|
'level' => 2,
|
|
|
|
|
'toclevel' => 2,
|
|
|
|
|
'number' => "2.1",
|
|
|
|
|
'line' => "Section 2.1",
|
|
|
|
|
'anchor' => "Section_2.1"
|
|
|
|
|
] ), SectionMetadata::fromLegacy( [
|
|
|
|
|
'index' => "4",
|
|
|
|
|
'level' => 1,
|
|
|
|
|
'toclevel' => 1,
|
|
|
|
|
'number' => "3",
|
|
|
|
|
'line' => "Section 3",
|
|
|
|
|
'anchor' => "Section_3"
|
|
|
|
|
] ), ) );
|
|
|
|
|
}
|
|
|
|
|
}
|
