getServiceContainer()->getResourceLoader(); $resourceLoader->setDependencyStore( new KeyValueDependencyStore( new HashBagOStuff() ) ); $request = new FauxRequest( [ 'lang' => 'en', 'modules' => $moduleName, 'skin' => $skinName, ] ); $context = new Context( $resourceLoader, $request ); $module = $resourceLoader->getModule( $moduleName ); $contentContext = new \MediaWiki\ResourceLoader\DerivativeContext( $context ); $contentContext->setOnly( $module->getType() === Module::LOAD_STYLES ? Module::TYPE_STYLES : Module::TYPE_COMBINED ); // Create a module response for the given module and calculate the size $content = $resourceLoader->makeModuleResponse( $contentContext, [ $moduleName => $module ] ); $contentTransferSize = strlen( gzencode( $content, 9 ) ); // Adjustments for core modules [T343407] $contentTransferSize -= 17; return $contentTransferSize; } /** * Prepares a skin for testing, assigning context and output page * * @param string $skinName * * @return \Skin * @throws \SkinException */ protected function prepareSkin( string $skinName ): \Skin { $skinFactory = $this->getServiceContainer()->getSkinFactory(); $skin = $skinFactory->makeSkin( $skinName ); $title = $this->getExistingTestPage()->getTitle(); $context = new DerivativeContext( RequestContext::getMain() ); $context->setTitle( $title ); $context->setSkin( $skin ); $outputPage = new OutputPage( $context ); $context->setOutput( $outputPage ); $skin->setContext( $context ); $outputPage->setTitle( $title ); $outputPage->output( true ); return $skin; } /** * Converts a string to bytes * * @param string|int|float $size * * @return float|int */ private function getSizeInBytes( $size ) { if ( is_string( $size ) ) { if ( strpos( $size, 'KB' ) !== false || strpos( $size, 'kB' ) !== false ) { $size = (float)str_replace( [ 'KB', 'kB', ' KB', ' kB' ], '', $size ); $size = $size * 1024; } elseif ( strpos( $size, 'B' ) !== false ) { $size = (float)str_replace( [ ' B', 'B' ], '', $size ); } } return $size; } /** * Get the list of skins and their maximum size * * @return array */ public function provideSkinsForModulesSize() { $allowedSkins = [ 'vector-2022', 'vector' ]; $skins = []; foreach ( $allowedSkins as $skinName ) { $maxSizes = $this->getMaxSize( $skinName ); if ( empty( $maxSizes ) ) { continue; } $skins[ $skinName ] = [ $skinName, $maxSizes ]; } return $skins; } /** * Tests the size of modules in allowed skins * * @param string $skinName * @param array $maxSizes * * @dataProvider provideSkinsForModulesSize * @coversNothing * * @return void * @throws \Wikimedia\RequestTimeout\TimeoutException * @throws MediaWiki\Config\ConfigException */ public function testTotalModulesSize( $skinName, $maxSizes ) { $this->markTestSkipped( 'test unstable: T350338' ); $skin = $this->prepareSkin( $skinName ); $moduleStyles = $skin->getOutput()->getModuleStyles(); $size = 0; foreach ( $moduleStyles as $moduleName ) { $size += $this->getContentTransferSize( $moduleName, $skinName ); } $stylesMaxSize = $this->getSizeInBytes( $maxSizes[ 'styles' ] ); $message = $this->createMessage( $skinName, $size, $stylesMaxSize, $moduleStyles ); $this->assertLessThanOrEqual( $stylesMaxSize, $size, $message ); $modulesScripts = $skin->getOutput()->getModules(); $size = 0; foreach ( $modulesScripts as $moduleName ) { $size += $this->getContentTransferSize( $moduleName, $skinName ); } $scriptsMaxSize = $this->getSizeInBytes( $maxSizes[ 'scripts' ] ); $message = $this->createMessage( $skinName, $size, $scriptsMaxSize, $modulesScripts, true ); $this->assertLessThanOrEqual( $scriptsMaxSize, $size, $message ); } /** * Creates a message for the assertion * * @param string $skinName * @param int|float $size * @param int|float $maxSize * @param array $modules * @param bool $scripts * * @return string */ private function createMessage( $skinName, $size, $maxSize, $modules, $scripts = false ) { $debugInformation = "The following modules are enabled on page load:\n" . implode( "\n", $modules ); $moduleType = $scripts ? 'scripts' : 'styles'; return "T346813: Performance budget for $moduleType in skin" . " $skinName on main article namespace has been exceeded." . " Total size of $moduleType modules is " . $this->bytesToKbsRoundup( $size ) . " Kbs is greater" . " than the current budget size of " . $this->bytesToKbsRoundup( $maxSize ) . " Kbs" . " (see Vector/bundlesize.config.json).\n" . "Please reduce $moduleType that you are loading on page load" . " or talk to the skin maintainer about modifying the budget.\n" . "$debugInformation"; } /** * Converts bytes to Kbs and rounds up to the nearest 0.1 * * @param int|float $sizeInBytes * * @return float */ private function bytesToKbsRoundup( $sizeInBytes ) { return ceil( ( $sizeInBytes * 10 ) / 1024 ) / 10; } }