golem
/
VectorGOLEM
9
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Disable table of contents in article body 

This will currently remove table of contents in article body
for legacy and modern skin.

To prevent us deploying this in current form, a check is
added in generateHTML

This requires an adjustment of OverridableConfigRequirement to
support requirements which do not vary on whether the user is
logged in or not.

Bug: T297610
Change-Id: I847a284229e498b3aa04c16ea3f84c360e735052
This commit is contained in:
jdlrobson 2021-12-15 09:51:44 -08:00 committed by Clare Ming
parent 5a8a3d0d13
commit ef59d7b973
4 changed files with 28 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
includes/FeatureManagement/Requirements/OverridableConfigRequirement.php
View File

@ -188,6 +188,10 @@ final class OverridableConfigRequirement implements Requirement {
'logged_in' => $thisConfig,
'logged_out' => $thisConfig,
];
} elseif ( array_key_exists( 'default', $thisConfig ) ) {
$thisConfig = [
'default' => $thisConfig['default'],
];
} else {
$thisConfig = [
'logged_in' => $thisConfig['logged_in'] ?? false,
@ -196,6 +200,8 @@ final class OverridableConfigRequirement implements Requirement {
}
// Fallback to config.
return $thisConfig[ $this->user->isRegistered() ? 'logged_in' : 'logged_out' ];
return array_key_exists( 'default', $thisConfig ) ?
$thisConfig[ 'default' ] :
$thisConfig[ $this->user->isRegistered() ? 'logged_in' : 'logged_out' ];
}
}

1
includes/ServiceWiring.php
View File

@ -198,7 +198,6 @@ return [
Constants::FEATURE_TABLE_OF_CONTENTS,
[
Constants::REQUIREMENT_FULLY_INITIALISED,
Constants::REQUIREMENT_LATEST_SKIN_VERSION,
Constants::REQUIREMENT_TABLE_OF_CONTENTS
]
);

22
includes/SkinVector.php
View File

@ -110,6 +110,18 @@ class SkinVector extends SkinMustache {
*/
private const OPT_OUT_LINK_TRACKING_CODE = 'vctw1';
/**
* Updates the constructor to conditionally disable table of contents in article
* body.
* Note, the constructor can only check feature flags that do not vary on whether the
* user is logged in e.g. features with the 'default' key set.
* @inheritDoc
*/
public function __construct( array $options ) {
$options['toc'] = !$this->isTableOfContentsVisibleInSidebar();
parent::__construct( $options );
}
/**
* Whether or not the legacy version of the skin is being used.
*
@ -375,6 +387,12 @@ class SkinVector extends SkinMustache {
public function generateHTML() {
if ( $this->isLegacy() ) {
$this->options['template'] = 'skin-legacy';
if ( $this->isTableOfContentsVisibleInSidebar() ) {
throw new RuntimeException(
'The table of contents flag cannot safely be applied without ' .
'breaking legacy Vector. Please fix T291098 before applying.'
);
}
}
return parent::generateHTML();
}
@ -466,7 +484,7 @@ class SkinVector extends SkinMustache {
*
* @return bool
*/
private function isTableOfContentsVisible(): bool {
private function isTableOfContentsVisibleInSidebar(): bool {
$featureManager = VectorServices::getFeatureManager();
return $featureManager->isFeatureEnabled( Constants::FEATURE_TABLE_OF_CONTENTS );
}
@ -508,7 +526,7 @@ class SkinVector extends SkinMustache {
'is-language-in-content-top' => $this->isLanguagesInContentAt( 'top' ),
'is-language-in-content-bottom' => $this->isLanguagesInContentAt( 'bottom' ),
'is-vector-table-of-contents-visible' => $this->isTableOfContentsVisible(),
'is-vector-table-of-contents-visible' => $this->isTableOfContentsVisibleInSidebar(),
'data-search-box' => $this->getSearchData(
$parentData['data-search-box'],

3
skin.json
View File

@ -423,8 +423,7 @@
},
"VectorTableOfContents": {
"value": {
"logged_in": false,
"logged_out": false
"default": false
},
"description": "@var When `VectorTableOfContents` is enabled, the sticky table of contents is shown."
}