wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-24 07:43:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restore budget test with better guidance and special case FlaggedRevs

Browse source 
Restore the budget test with better guidance on the process to
handling this issue.

Bug: T360102
Change-Id: I1ca80945e2ef49604a85e1bec6004f30ad13924d
This commit is contained in:
Jon Robson 2024-03-14 09:25:56 -07:00
parent d966223b62
commit a67a260451
1 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
tests/phpunit/structure/PerformanceBudgetTest.php
View file

@ -3,6 +3,7 @@
namespace MediaWiki\Skins\Vector\Tests\Structure; namespace MediaWiki\Skins\Vector\Tests\Structure;
use DerivativeContext; use DerivativeContext;
use ExtensionRegistry;
use HashBagOStuff; use HashBagOStuff;
use MediaWiki\Output\OutputPage; use MediaWiki\Output\OutputPage;
use MediaWiki\Request\FauxRequest; use MediaWiki\Request\FauxRequest;
@ -142,8 +143,6 @@ class PerformanceBudgetTest extends MediaWikiIntegrationTestCase {
* @throws MediaWiki\Config\ConfigException * @throws MediaWiki\Config\ConfigException
*/ */
public function testTotalModulesSize( $skinName, $maxSizes ) { public function testTotalModulesSize( $skinName, $maxSizes ) {
$this->markTestSkipped( 'test unstable: T350338' );
$skin = $this->prepareSkin( $skinName ); $skin = $this->prepareSkin( $skinName );
$moduleStyles = $skin->getOutput()->getModuleStyles(); $moduleStyles = $skin->getOutput()->getModuleStyles();
$size = 0; $size = 0;
@ -151,6 +150,14 @@ class PerformanceBudgetTest extends MediaWikiIntegrationTestCase {
$size += $this->getContentTransferSize( $moduleName, $skinName ); $size += $this->getContentTransferSize( $moduleName, $skinName );
} }
$stylesMaxSize = $this->getSizeInBytes( $maxSizes[ 'styles' ] ); $stylesMaxSize = $this->getSizeInBytes( $maxSizes[ 'styles' ] );
// The flagged revisions extension is only loaded in certain environments.
// Since the environment is based on FlaggedRevs not being installed, extra budget is allocated.
// More context: https://phabricator.wikimedia.org/T360102#9632324
if ( ExtensionRegistry::getInstance()->isLoaded( 'FlaggedRevs' ) ) {
$stylesMaxSize += 1000;
}
$message = $this->createMessage( $skinName, $size, $stylesMaxSize, $moduleStyles ); $message = $this->createMessage( $skinName, $size, $stylesMaxSize, $moduleStyles );
$this->assertLessThanOrEqual( $stylesMaxSize, $size, $message ); $this->assertLessThanOrEqual( $stylesMaxSize, $size, $message );
$modulesScripts = $skin->getOutput()->getModules(); $modulesScripts = $skin->getOutput()->getModules();
@ -175,7 +182,13 @@ class PerformanceBudgetTest extends MediaWikiIntegrationTestCase {
* @return string * @return string
*/ */
private function createMessage( $skinName, $size, $maxSize, $modules, $scripts = false ) { private function createMessage( $skinName, $size, $maxSize, $modules, $scripts = false ) {
$debugInformation = "The following modules are enabled on page load:\n" . $debugInformation = "[PLEASE DO NOT SKIP THIS TEST. If this is blocking a deploy this might " .
"signal a potential performance regression with the desktop site." .
"Instead of skipping the test you can increase the value in bundlesize.config.json " .
"and create a ticket to investigate this error. If the error is > 1kb please tag " .
"this as a train blocker." .
"Please tag the ticket #Web-Team-Backlog.\n\n" .
"The following modules are enabled on page load:\n" .
implode( "\n", $modules ); implode( "\n", $modules );
$moduleType = $scripts ? 'scripts' : 'styles'; $moduleType = $scripts ? 'scripts' : 'styles';
return "T346813: Performance budget for $moduleType in skin" . return "T346813: Performance budget for $moduleType in skin" .
@ -183,8 +196,12 @@ class PerformanceBudgetTest extends MediaWikiIntegrationTestCase {
" Total size of $moduleType modules is " . $this->bytesToKbsRoundup( $size ) . " Kbs is greater" . " Total size of $moduleType modules is " . $this->bytesToKbsRoundup( $size ) . " Kbs is greater" .
" than the current budget size of " . $this->bytesToKbsRoundup( $maxSize ) . " Kbs" . " than the current budget size of " . $this->bytesToKbsRoundup( $maxSize ) . " Kbs" .
" (see Vector/bundlesize.config.json).\n" . " (see Vector/bundlesize.config.json).\n" .
"Please reduce $moduleType that you are loading on page load" . "If you are adding code on page load, please reduce $moduleType that you are loading on page load" .
" or talk to the skin maintainer about modifying the budget.\n" . " or talk to the web team about increasing the budget.\n" .
"If you are not adding code, and this seems to be an error, " .
"it is possible that something running without CI has bypassed this check and we " .
"can address this separately." .
"Please reach out to the web team to discuss this via Phabricator or #talk-to-web." .
"$debugInformation"; "$debugInformation";
} }