includes/ResourceLoader/StartUpModule.php - mediawiki/core - Gitiles

 <?php
 /**
  * @license GPL-2.0-or-later
  * @file
  * @author Trevor Parscal
  * @author Roan Kattouw
  */
 namespace MediaWiki\ResourceLoader;

 use DomainException;
 use Exception;
 use MediaWiki\MainConfigNames;
 use Wikimedia\RequestTimeout\TimeoutException;

 /**
  * Module for ResourceLoader initialization.
  *
  * See also <https://www.mediawiki.org/wiki/ResourceLoader/Architecture#Startup_Module>
  *
  * The startup module, as being called only from ClientHtml, has
  * the ability to vary based on extra query parameters, in addition to those
  * from Context:
  *
  * - safemode: Only register modules that have ORIGIN_CORE as their origin.
  *   This disables ORIGIN_USER modules and mw.loader.store. (T185303, T145498)
  *   See also: OutputPage::disallowUserJs()
  *
  * @ingroup ResourceLoader
  * @internal
  */
 class StartUpModule extends Module {

 	/**
 	 * Cache version for client-side ResourceLoader module storage.
 	 * Like ResourceLoaderStorageVersion but not configurable.
 	 */
 	private const STORAGE_VERSION = '3';

 	/** @var int[] */
 	private array $groupIds = [
 		// These reserved numbers MUST start at 0 and not skip any. These are preset
 		// for forward compatibility so that they can be safely referenced by mediawiki.js,
 		// even when the code is cached and the order of registrations (and implicit
 		// group ids) changes between versions of the software.
 		self::GROUP_USER => 0,
 		self::GROUP_PRIVATE => 1,
 	];

 	/**
 	 * Recursively get all explicit and implicit dependencies for to the given module.
 	 *
 	 * @param array $registryData
 	 * @param string $moduleName
 	 * @param array<string,true> &$handled Internal parameter for recursion.
 	 * @return array
 	 * @throws CircularDependencyError
 	 */
 	protected static function getImplicitDependencies(
 		array $registryData,
 		string $moduleName,
 		array &$handled
 	): array {
 		static $dependencyCache = [];

 		// No modules will be added or changed server-side after this point,
 		// so we can safely cache parts of the tree for re-use.
 		if ( !isset( $dependencyCache[$moduleName] ) ) {
 			if ( !isset( $registryData[$moduleName] ) ) {
 				// Unknown module names are allowed here, this is only an optimisation.
 				// Checks for illegal and unknown dependencies happen as PHPUnit structure tests,
 				// and also client-side at run-time.
 				$dependencyCache[$moduleName] = [];
 				return [];
 			}

 			$data = $registryData[$moduleName];
 			$flat = $data['dependencies'];

 			// Prevent recursion
 			$handled[$moduleName] = true;
 			foreach ( $data['dependencies'] as $dependency ) {
 				if ( isset( $handled[$dependency] ) ) {
 					// If we encounter a circular dependency, then stop the optimiser and leave the
 					// original dependencies array unmodified. Circular dependencies are not
 					// supported in ResourceLoader. Awareness of them exists here so that we can
 					// optimise the registry when it isn't broken, and otherwise transport the
 					// registry unchanged. The client will handle this further.
 					throw new CircularDependencyError();
 				}
 				// Recursively add the dependencies of the dependencies
 				$flat = array_merge(
 					$flat,
 					self::getImplicitDependencies( $registryData, $dependency, $handled )
 				);
 			}

 			$dependencyCache[$moduleName] = $flat;
 		}

 		return $dependencyCache[$moduleName];
 	}

 	/**
 	 * Optimize the dependency tree in $this->modules.
 	 *
 	 * The optimization basically works like this:
 	 * 	Given we have module A with the dependencies B and C
 	 * 		and module B with the dependency C.
 	 * 	Now we don't have to tell the client to explicitly fetch module
 	 * 		C as that's already included in module B.
 	 *
 	 * This way we can reasonably reduce the amount of module registration
 	 * data send to the client.
 	 *
 	 * @param array[] &$registryData Modules keyed by name with properties:
 	 *  - string 'version'
 	 *  - array 'dependencies'
 	 *  - string|null 'group'
 	 *  - string 'source'
 	 * @phan-param array<string,array{version:string,dependencies:array,group:?string,source:string}> &$registryData
 	 */
 	public static function compileUnresolvedDependencies( array &$registryData ): void {
 		foreach ( $registryData as &$data ) {
 			$dependencies = $data['dependencies'];
 			try {
 				foreach ( $data['dependencies'] as $dependency ) {
 					$depCheck = [];
 					$implicitDependencies = self::getImplicitDependencies( $registryData, $dependency, $depCheck );
 					$dependencies = array_diff( $dependencies, $implicitDependencies );
 				}
 			} catch ( CircularDependencyError ) {
 				// Leave unchanged
 				$dependencies = $data['dependencies'];
 			}

 			// Rebuild keys
 			$data['dependencies'] = array_values( $dependencies );
 		}
 	}

 	/**
 	 * Get registration code for all modules.
 	 *
 	 * @param Context $context
 	 * @return string JavaScript code for registering all modules with the client loader
 	 */
 	public function getModuleRegistrations( Context $context ): string {
 		$resourceLoader = $context->getResourceLoader();
 		// Future developers: Use WebRequest::getRawVal() instead getVal().
 		// The getVal() method performs slow Language+UTF logic. (f303bb9360)
 		$safemode = $context->getRequest()->getRawVal( 'safemode' ) === '1';
 		$skin = $context->getSkin();

 		$moduleNames = $resourceLoader->getModuleNames();

 		// Preload with a batch so that the below calls to getVersionHash() for each module
 		// don't require on-demand loading of more information.
 		try {
 			$resourceLoader->preloadModuleInfo( $moduleNames, $context );
 		} catch ( TimeoutException $e ) {
 			throw $e;
 		} catch ( Exception $e ) {
 			// Don't fail the request (T152266)
 			// Also print the error in the main output
 			$resourceLoader->outputErrorAndLog( $e,
 				'Preloading module info from startup failed: {exception}',
 				[ 'exception' => $e ]
 			);
 		}

 		// Get registry data
 		$states = [];
 		$registryData = [];
 		foreach ( $moduleNames as $name ) {
 			$module = $resourceLoader->getModule( $name );
 			$moduleSkins = $module->getSkins();
 			if (
 				( $safemode && $module->getOrigin() > Module::ORIGIN_CORE_INDIVIDUAL )
 				|| ( $moduleSkins !== null && !in_array( $skin, $moduleSkins ) )
 			) {
 				continue;
 			}

 			if ( $module instanceof StartUpModule ) {
 				// Don't register 'startup' to the client because loading it lazily or depending
 				// on it doesn't make sense, because the startup module *is* the client.
 				// Registering would be a waste of bandwidth and memory and risks somehow causing
 				// it to load a second time.

 				// ATTENTION: Because of the line below, this is not going to cause infinite recursion.
 				// Think carefully before making changes to this code!
 				// The below code is going to call Module::getVersionHash() for every module.
 				// For StartUpModule (this module) the hash is computed based on the manifest content,
 				// which is the very thing we are computing right here. As such, this must skip iterating
 				// over 'startup' itself.
 				continue;
 			}

 			// Optimization: Exclude modules in the `noscript` group. These are only ever used
 			// directly by HTML without use of JavaScript (T291735).
 			if ( $module->getGroup() === self::GROUP_NOSCRIPT ) {
 				continue;
 			}

 			try {
 				// The version should be formatted by ResourceLoader::makeHash and be of
 				// length ResourceLoader::HASH_LENGTH (or empty string).
 				// The getVersionHash method is final and is covered by tests, as is makeHash().
 				$versionHash = $module->getVersionHash( $context );
 			} catch ( TimeoutException $e ) {
 				throw $e;
 			} catch ( Exception $e ) {
 				// Don't fail the request (T152266)
 				// Also print the error in the main output
 				$resourceLoader->outputErrorAndLog( $e,
 					'Calculating version for "{module}" failed: {exception}',
 					[
 						'module' => $name,
 						'exception' => $e,
 					]
 				);
 				$versionHash = '';
 				$states[$name] = 'error';
 			}

 			$skipFunction = $module->getSkipFunction();
 			if ( $skipFunction !== null && !$context->getDebug() ) {
 				$skipFunction = ResourceLoader::filter( 'minify-js', $skipFunction );
 			}

 			$registryData[$name] = [
 				'version' => $versionHash,
 				'dependencies' => $module->getDependencies( $context ),
 				'group' => $this->getGroupId( $module->getGroup() ),
 				'source' => $module->getSource(),
 				'skip' => $skipFunction,
 			];
 		}

 		self::compileUnresolvedDependencies( $registryData );

 		// Register sources
 		$sources = $oldSources = $resourceLoader->getSources();
 		$this->getHookRunner()->onResourceLoaderModifyEmbeddedSourceUrls( $sources );
 		if ( array_keys( $sources ) !== array_keys( $oldSources ) ) {
 			throw new DomainException( 'ResourceLoaderModifyEmbeddedSourceUrls hook must not add or remove sources' );
 		}
 		$out = ResourceLoader::makeLoaderSourcesScript( $context, $sources );

 		// Figure out the different call signatures for mw.loader.register
 		$registrations = [];
 		foreach ( $registryData as $name => $data ) {
 			// Call mw.loader.register(name, version, dependencies, group, source, skip)
 			$registrations[] = [
 				$name,
 				$data['version'],
 				$data['dependencies'],
 				$data['group'],
 				// Swap default (local) for null
 				$data['source'] === 'local' ? null : $data['source'],
 				$data['skip']
 			];
 		}

 		// Register modules
 		$out .= "\n" . ResourceLoader::makeLoaderRegisterScript( $context, $registrations );

 		if ( $states ) {
 			$out .= "\n" . ResourceLoader::makeLoaderStateScript( $context, $states );
 		}

 		return $out;
 	}

 	private function getGroupId( ?string $groupName ): ?int {
 		if ( $groupName === null ) {
 			return null;
 		}

 		if ( !array_key_exists( $groupName, $this->groupIds ) ) {
 			$this->groupIds[$groupName] = count( $this->groupIds );
 		}

 		return $this->groupIds[$groupName];
 	}

 	/**
 	 * Base modules implicitly available to all modules.
 	 */
 	private function getBaseModules(): array {
 		return [ 'jquery', 'mediawiki.base' ];
 	}

 	/**
 	 * Get the localStorage key for the entire module store. The key references
 	 * $wgDBname to prevent clashes between wikis under the same web domain.
 	 *
 	 * @return string localStorage item key for JavaScript
 	 */
 	private function getStoreKey(): string {
 		return 'MediaWikiModuleStore:' . $this->getConfig()->get( MainConfigNames::DBname );
 	}

 	/**
 	 * @see $wgResourceLoaderMaxQueryLength
 	 * @return int
 	 */
 	private function getMaxQueryLength(): int {
 		$len = $this->getConfig()->get( MainConfigNames::ResourceLoaderMaxQueryLength );
 		// - Ignore -1, which in MW 1.34 and earlier was used to mean "unlimited".
 		// - Ignore invalid values, e.g. non-int or other negative values.
 		if ( $len === false || $len < 0 ) {
 			// Default
 			$len = 2000;
 		}
 		return $len;
 	}

 	/**
 	 * Get the key on which the JavaScript module cache (mw.loader.store) will vary.
 	 *
 	 * @param Context $context
 	 * @return string String of concatenated vary conditions
 	 */
 	private function getStoreVary( Context $context ): string {
 		return implode( ':', [
 			$context->getSkin(),
 			self::STORAGE_VERSION,
 			$this->getConfig()->get( MainConfigNames::ResourceLoaderStorageVersion ),
 			$context->getLanguage(),
 		] );
 	}

 	/**
 	 * @param Context $context
 	 * @return string|array JavaScript code
 	 */
 	public function getScript( Context $context ) {
 		global $IP;
 		$conf = $this->getConfig();

 		if ( $context->getOnly() !== 'scripts' ) {
 			return '/* Requires only=scripts */';
 		}

 		$enableJsProfiler = $conf->get( MainConfigNames::ResourceLoaderEnableJSProfiler );

 		$startupCode = file_get_contents( "$IP/resources/src/startup/startup.js" );

 		$mwLoaderCode = file_get_contents( "$IP/resources/src/startup/mediawiki.js" ) .
 			file_get_contents( "$IP/resources/src/startup/mediawiki.loader.js" ) .
 			file_get_contents( "$IP/resources/src/startup/mediawiki.requestIdleCallback.js" );
 		if ( $conf->get( MainConfigNames::ResourceLoaderEnableJSProfiler ) ) {
 			$mwLoaderCode .= file_get_contents( "$IP/resources/src/startup/profiler.js" );
 		}

 		// Perform replacements for mediawiki.js
 		$mwLoaderPairs = [
 			// This should always be an object, even if the base vars are empty
 			// (such as when using the default lang/skin).
 			'$VARS.reqBase' => $context->encodeJson( (object)$context->getReqBase() ),
 			'$VARS.baseModules' => $context->encodeJson( $this->getBaseModules() ),
 			'$VARS.maxQueryLength' => $context->encodeJson(
 				// In debug mode, let the client fetch each module in
 				// its own dedicated request (T85805).
 				// This is effectively the equivalent of ClientHtml::makeLoad,
 				// which does this for stylesheets.
 				!$context->getDebug() ? $this->getMaxQueryLength() : 0
 			),
 			'$VARS.storeEnabled' => $context->encodeJson(
 				$conf->get( MainConfigNames::ResourceLoaderStorageEnabled )
 					&& !$context->getDebug()
 					&& $context->getRequest()->getRawVal( 'safemode' ) !== '1'
 			),
 			'$VARS.storeKey' => $context->encodeJson( $this->getStoreKey() ),
 			'$VARS.storeVary' => $context->encodeJson( $this->getStoreVary( $context ) ),
 			'$VARS.groupUser' => $context->encodeJson( $this->getGroupId( self::GROUP_USER ) ),
 			'$VARS.groupPrivate' => $context->encodeJson( $this->getGroupId( self::GROUP_PRIVATE ) ),
 			'$VARS.sourceMapLinks' => $context->encodeJson(
 				$conf->get( MainConfigNames::ResourceLoaderEnableSourceMapLinks )
 			),

 			// When profiling is enabled, insert the calls.
 			// When disabled (the default), insert nothing.
 			'$CODE.profileExecuteStart();' => $enableJsProfiler
 				? 'mw.loader.profiler.onExecuteStart( module );'
 				: '',
 			'$CODE.profileExecuteEnd();' => $enableJsProfiler
 				? 'mw.loader.profiler.onExecuteEnd( module );'
 				: '',
 			'$CODE.profileScriptStart();' => $enableJsProfiler
 				? 'mw.loader.profiler.onScriptStart( module );'
 				: '',
 			'$CODE.profileScriptEnd();' => $enableJsProfiler
 				? 'mw.loader.profiler.onScriptEnd( module );'
 				: '',

 			// Debug stubs
 			'$CODE.consoleLog();' => $context->getDebug()
 				? 'console.log.apply( console, arguments );'
 				: '',

 			// As a paranoia measure, create a window.QUnit placeholder that shadows any
 			// DOM global (e.g. for <h2 id="QUnit">), to avoid test code in prod (T356768).
 			'$CODE.undefineQUnit();' => !$conf->get( MainConfigNames::EnableJavaScriptTest )
 				? 'window.QUnit = undefined;'
 				: '',
 		];
 		$mwLoaderCode = strtr( $mwLoaderCode, $mwLoaderPairs );

 		// Perform string replacements for startup.js
 		$pairs = [
 			// Raw JavaScript code (not JSON)
 			'$CODE.registrations();' => trim( $this->getModuleRegistrations( $context ) ),
 			'$CODE.defineLoader();' => $mwLoaderCode,
 		];
 		$startupCode = strtr( $startupCode, $pairs );

 		return [
 			'plainScripts' => [
 				[
 					'virtualFilePath' => new FilePath(
 						'resources/src/startup/startup.js',
 						MW_INSTALL_PATH,
 						$conf->get( MainConfigNames::ResourceBasePath )
 					),
 					'content' => $startupCode,
 				],
 			],
 		];
 	}

 	public function supportsURLLoading(): bool {
 		return false;
 	}

 	public function enableModuleContentVersion(): bool {
 		// Enabling this means that ResourceLoader::getVersionHash will simply call getScript()
 		// and hash it to determine the version (as used by E-Tag HTTP response header).
 		return true;
 	}
 }
	<?php
	/**
	* @license GPL-2.0-or-later
	* @file
	* @author Trevor Parscal
	* @author Roan Kattouw
	*/
	namespace MediaWiki\ResourceLoader;

	use DomainException;
	use Exception;
	use MediaWiki\MainConfigNames;
	use Wikimedia\RequestTimeout\TimeoutException;

	/**
	* Module for ResourceLoader initialization.
	*
	* See also <https://www.mediawiki.org/wiki/ResourceLoader/Architecture#Startup_Module>
	*
	* The startup module, as being called only from ClientHtml, has
	* the ability to vary based on extra query parameters, in addition to those
	* from Context:
	*
	* - safemode: Only register modules that have ORIGIN_CORE as their origin.
	* This disables ORIGIN_USER modules and mw.loader.store. (T185303, T145498)
	* See also: OutputPage::disallowUserJs()
	*
	* @ingroup ResourceLoader
	* @internal
	*/
	class StartUpModule extends Module {

	/**
	* Cache version for client-side ResourceLoader module storage.
	* Like ResourceLoaderStorageVersion but not configurable.
	*/
	private const STORAGE_VERSION = '3';

	/** @var int[] */
	private array $groupIds = [
	// These reserved numbers MUST start at 0 and not skip any. These are preset
	// for forward compatibility so that they can be safely referenced by mediawiki.js,
	// even when the code is cached and the order of registrations (and implicit
	// group ids) changes between versions of the software.
	self::GROUP_USER => 0,
	self::GROUP_PRIVATE => 1,
	];

	/**
	* Recursively get all explicit and implicit dependencies for to the given module.
	*
	* @param array $registryData
	* @param string $moduleName
	* @param array<string,true> &$handled Internal parameter for recursion.
	* @return array
	* @throws CircularDependencyError
	*/
	protected static function getImplicitDependencies(
	array $registryData,
	string $moduleName,
	array &$handled
	): array {
	static $dependencyCache = [];

	// No modules will be added or changed server-side after this point,
	// so we can safely cache parts of the tree for re-use.
	if ( !isset( $dependencyCache[$moduleName] ) ) {
	if ( !isset( $registryData[$moduleName] ) ) {
	// Unknown module names are allowed here, this is only an optimisation.
	// Checks for illegal and unknown dependencies happen as PHPUnit structure tests,
	// and also client-side at run-time.
	$dependencyCache[$moduleName] = [];
	return [];
	}

	$data = $registryData[$moduleName];
	$flat = $data['dependencies'];

	// Prevent recursion
	$handled[$moduleName] = true;
	foreach ( $data['dependencies'] as $dependency ) {
	if ( isset( $handled[$dependency] ) ) {
	// If we encounter a circular dependency, then stop the optimiser and leave the
	// original dependencies array unmodified. Circular dependencies are not
	// supported in ResourceLoader. Awareness of them exists here so that we can
	// optimise the registry when it isn't broken, and otherwise transport the
	// registry unchanged. The client will handle this further.
	throw new CircularDependencyError();
	}
	// Recursively add the dependencies of the dependencies
	$flat = array_merge(
	$flat,
	self::getImplicitDependencies( $registryData, $dependency, $handled )
	);
	}

	$dependencyCache[$moduleName] = $flat;
	}

	return $dependencyCache[$moduleName];
	}

	/**
	* Optimize the dependency tree in $this->modules.
	*
	* The optimization basically works like this:
	* Given we have module A with the dependencies B and C
	* and module B with the dependency C.
	* Now we don't have to tell the client to explicitly fetch module
	* C as that's already included in module B.
	*
	* This way we can reasonably reduce the amount of module registration
	* data send to the client.
	*
	* @param array[] &$registryData Modules keyed by name with properties:
	* - string 'version'
	* - array 'dependencies'
	* - string\|null 'group'
	* - string 'source'
	* @phan-param array<string,array{version:string,dependencies:array,group:?string,source:string}> &$registryData
	*/
	public static function compileUnresolvedDependencies( array &$registryData ): void {
	foreach ( $registryData as &$data ) {
	$dependencies = $data['dependencies'];
	try {
	foreach ( $data['dependencies'] as $dependency ) {
	$depCheck = [];
	$implicitDependencies = self::getImplicitDependencies( $registryData, $dependency, $depCheck );
	$dependencies = array_diff( $dependencies, $implicitDependencies );
	}
	} catch ( CircularDependencyError ) {
	// Leave unchanged
	$dependencies = $data['dependencies'];
	}

	// Rebuild keys
	$data['dependencies'] = array_values( $dependencies );
	}
	}

	/**
	* Get registration code for all modules.
	*
	* @param Context $context
	* @return string JavaScript code for registering all modules with the client loader
	*/
	public function getModuleRegistrations( Context $context ): string {
	$resourceLoader = $context->getResourceLoader();
	// Future developers: Use WebRequest::getRawVal() instead getVal().
	// The getVal() method performs slow Language+UTF logic. (f303bb9360)
	$safemode = $context->getRequest()->getRawVal( 'safemode' ) === '1';
	$skin = $context->getSkin();

	$moduleNames = $resourceLoader->getModuleNames();

	// Preload with a batch so that the below calls to getVersionHash() for each module
	// don't require on-demand loading of more information.
	try {
	$resourceLoader->preloadModuleInfo( $moduleNames, $context );
	} catch ( TimeoutException $e ) {
	throw $e;
	} catch ( Exception $e ) {
	// Don't fail the request (T152266)
	// Also print the error in the main output
	$resourceLoader->outputErrorAndLog( $e,
	'Preloading module info from startup failed: {exception}',
	[ 'exception' => $e ]
	);
	}

	// Get registry data
	$states = [];
	$registryData = [];
	foreach ( $moduleNames as $name ) {
	$module = $resourceLoader->getModule( $name );
	$moduleSkins = $module->getSkins();
	if (
	( $safemode && $module->getOrigin() > Module::ORIGIN_CORE_INDIVIDUAL )
	\|\| ( $moduleSkins !== null && !in_array( $skin, $moduleSkins ) )
	) {
	continue;
	}

	if ( $module instanceof StartUpModule ) {
	// Don't register 'startup' to the client because loading it lazily or depending
	// on it doesn't make sense, because the startup module is the client.
	// Registering would be a waste of bandwidth and memory and risks somehow causing
	// it to load a second time.

	// ATTENTION: Because of the line below, this is not going to cause infinite recursion.
	// Think carefully before making changes to this code!
	// The below code is going to call Module::getVersionHash() for every module.
	// For StartUpModule (this module) the hash is computed based on the manifest content,
	// which is the very thing we are computing right here. As such, this must skip iterating
	// over 'startup' itself.
	continue;
	}

	// Optimization: Exclude modules in the `noscript` group. These are only ever used
	// directly by HTML without use of JavaScript (T291735).
	if ( $module->getGroup() === self::GROUP_NOSCRIPT ) {
	continue;
	}

	try {
	// The version should be formatted by ResourceLoader::makeHash and be of
	// length ResourceLoader::HASH_LENGTH (or empty string).
	// The getVersionHash method is final and is covered by tests, as is makeHash().
	$versionHash = $module->getVersionHash( $context );
	} catch ( TimeoutException $e ) {
	throw $e;
	} catch ( Exception $e ) {
	// Don't fail the request (T152266)
	// Also print the error in the main output
	$resourceLoader->outputErrorAndLog( $e,
	'Calculating version for "{module}" failed: {exception}',
	[
	'module' => $name,
	'exception' => $e,
	]
	);
	$versionHash = '';
	$states[$name] = 'error';
	}

	$skipFunction = $module->getSkipFunction();
	if ( $skipFunction !== null && !$context->getDebug() ) {
	$skipFunction = ResourceLoader::filter( 'minify-js', $skipFunction );
	}

	$registryData[$name] = [
	'version' => $versionHash,
	'dependencies' => $module->getDependencies( $context ),
	'group' => $this->getGroupId( $module->getGroup() ),
	'source' => $module->getSource(),
	'skip' => $skipFunction,
	];
	}

	self::compileUnresolvedDependencies( $registryData );

	// Register sources
	$sources = $oldSources = $resourceLoader->getSources();
	$this->getHookRunner()->onResourceLoaderModifyEmbeddedSourceUrls( $sources );
	if ( array_keys( $sources ) !== array_keys( $oldSources ) ) {
	throw new DomainException( 'ResourceLoaderModifyEmbeddedSourceUrls hook must not add or remove sources' );
	}
	$out = ResourceLoader::makeLoaderSourcesScript( $context, $sources );

	// Figure out the different call signatures for mw.loader.register
	$registrations = [];
	foreach ( $registryData as $name => $data ) {
	// Call mw.loader.register(name, version, dependencies, group, source, skip)
	$registrations[] = [
	$name,
	$data['version'],
	$data['dependencies'],
	$data['group'],
	// Swap default (local) for null
	$data['source'] === 'local' ? null : $data['source'],
	$data['skip']
	];
	}

	// Register modules
	$out .= "\n" . ResourceLoader::makeLoaderRegisterScript( $context, $registrations );

	if ( $states ) {
	$out .= "\n" . ResourceLoader::makeLoaderStateScript( $context, $states );
	}

	return $out;
	}

	private function getGroupId( ?string $groupName ): ?int {
	if ( $groupName === null ) {
	return null;
	}

	if ( !array_key_exists( $groupName, $this->groupIds ) ) {
	$this->groupIds[$groupName] = count( $this->groupIds );
	}

	return $this->groupIds[$groupName];
	}

	/**
	* Base modules implicitly available to all modules.
	*/
	private function getBaseModules(): array {
	return [ 'jquery', 'mediawiki.base' ];
	}

	/**
	* Get the localStorage key for the entire module store. The key references
	* $wgDBname to prevent clashes between wikis under the same web domain.
	*
	* @return string localStorage item key for JavaScript
	*/
	private function getStoreKey(): string {
	return 'MediaWikiModuleStore:' . $this->getConfig()->get( MainConfigNames::DBname );
	}

	/**
	* @see $wgResourceLoaderMaxQueryLength
	* @return int
	*/
	private function getMaxQueryLength(): int {
	$len = $this->getConfig()->get( MainConfigNames::ResourceLoaderMaxQueryLength );
	// - Ignore -1, which in MW 1.34 and earlier was used to mean "unlimited".
	// - Ignore invalid values, e.g. non-int or other negative values.
	if ( $len === false \|\| $len < 0 ) {
	// Default
	$len = 2000;
	}
	return $len;
	}

	/**
	* Get the key on which the JavaScript module cache (mw.loader.store) will vary.
	*
	* @param Context $context
	* @return string String of concatenated vary conditions
	*/
	private function getStoreVary( Context $context ): string {
	return implode( ':', [
	$context->getSkin(),
	self::STORAGE_VERSION,
	$this->getConfig()->get( MainConfigNames::ResourceLoaderStorageVersion ),
	$context->getLanguage(),
	] );
	}

	/**
	* @param Context $context
	* @return string\|array JavaScript code
	*/
	public function getScript( Context $context ) {
	global $IP;
	$conf = $this->getConfig();

	if ( $context->getOnly() !== 'scripts' ) {
	return '/* Requires only=scripts */';
	}

	$enableJsProfiler = $conf->get( MainConfigNames::ResourceLoaderEnableJSProfiler );

	$startupCode = file_get_contents( "$IP/resources/src/startup/startup.js" );

	$mwLoaderCode = file_get_contents( "$IP/resources/src/startup/mediawiki.js" ) .
	file_get_contents( "$IP/resources/src/startup/mediawiki.loader.js" ) .
	file_get_contents( "$IP/resources/src/startup/mediawiki.requestIdleCallback.js" );
	if ( $conf->get( MainConfigNames::ResourceLoaderEnableJSProfiler ) ) {
	$mwLoaderCode .= file_get_contents( "$IP/resources/src/startup/profiler.js" );
	}

	// Perform replacements for mediawiki.js
	$mwLoaderPairs = [
	// This should always be an object, even if the base vars are empty
	// (such as when using the default lang/skin).
	'$VARS.reqBase' => $context->encodeJson( (object)$context->getReqBase() ),
	'$VARS.baseModules' => $context->encodeJson( $this->getBaseModules() ),
	'$VARS.maxQueryLength' => $context->encodeJson(
	// In debug mode, let the client fetch each module in
	// its own dedicated request (T85805).
	// This is effectively the equivalent of ClientHtml::makeLoad,
	// which does this for stylesheets.
	!$context->getDebug() ? $this->getMaxQueryLength() : 0
	),
	'$VARS.storeEnabled' => $context->encodeJson(
	$conf->get( MainConfigNames::ResourceLoaderStorageEnabled )
	&& !$context->getDebug()
	&& $context->getRequest()->getRawVal( 'safemode' ) !== '1'
	),
	'$VARS.storeKey' => $context->encodeJson( $this->getStoreKey() ),
	'$VARS.storeVary' => $context->encodeJson( $this->getStoreVary( $context ) ),
	'$VARS.groupUser' => $context->encodeJson( $this->getGroupId( self::GROUP_USER ) ),
	'$VARS.groupPrivate' => $context->encodeJson( $this->getGroupId( self::GROUP_PRIVATE ) ),
	'$VARS.sourceMapLinks' => $context->encodeJson(
	$conf->get( MainConfigNames::ResourceLoaderEnableSourceMapLinks )
	),

	// When profiling is enabled, insert the calls.
	// When disabled (the default), insert nothing.
	'$CODE.profileExecuteStart();' => $enableJsProfiler
	? 'mw.loader.profiler.onExecuteStart( module );'
	: '',
	'$CODE.profileExecuteEnd();' => $enableJsProfiler
	? 'mw.loader.profiler.onExecuteEnd( module );'
	: '',
	'$CODE.profileScriptStart();' => $enableJsProfiler
	? 'mw.loader.profiler.onScriptStart( module );'
	: '',
	'$CODE.profileScriptEnd();' => $enableJsProfiler
	? 'mw.loader.profiler.onScriptEnd( module );'
	: '',

	// Debug stubs
	'$CODE.consoleLog();' => $context->getDebug()
	? 'console.log.apply( console, arguments );'
	: '',

	// As a paranoia measure, create a window.QUnit placeholder that shadows any
	// DOM global (e.g. for <h2 id="QUnit">), to avoid test code in prod (T356768).
	'$CODE.undefineQUnit();' => !$conf->get( MainConfigNames::EnableJavaScriptTest )
	? 'window.QUnit = undefined;'
	: '',
	];
	$mwLoaderCode = strtr( $mwLoaderCode, $mwLoaderPairs );

	// Perform string replacements for startup.js
	$pairs = [
	// Raw JavaScript code (not JSON)
	'$CODE.registrations();' => trim( $this->getModuleRegistrations( $context ) ),
	'$CODE.defineLoader();' => $mwLoaderCode,
	];
	$startupCode = strtr( $startupCode, $pairs );

	return [
	'plainScripts' => [
	[
	'virtualFilePath' => new FilePath(
	'resources/src/startup/startup.js',
	MW_INSTALL_PATH,
	$conf->get( MainConfigNames::ResourceBasePath )
	),
	'content' => $startupCode,
	],
	],
	];
	}

	public function supportsURLLoading(): bool {
	return false;
	}

	public function enableModuleContentVersion(): bool {
	// Enabling this means that ResourceLoader::getVersionHash will simply call getScript()
	// and hash it to determine the version (as used by E-Tag HTTP response header).
	return true;
	}
	}