Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

resourceloader: Remove support for Module::getModifiedTime() and getModifiedHash()

Browse source 
Deprecated since 1.26. No subclasses in Wikimedia Git define these methods,
no calls to methods by this name in Wikimedia Git.

If a module subclass were to still define such a method, it is simply
not called anymore. The version hash system introduced in 1.26 will
still invalidate modules based on wgCacheEpoch.

Bug: T94074
Change-Id: I65b2a625a30f22c8a9d14a3505605546fa5bab83
This commit is contained in:
Timo Tijhof 2018-06-05 01:56:54 +01:00
parent 1865739bb5
commit 96d25f6bcc
3 changed files with 2 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
RELEASE-NOTES-1.32
View file

@ -140,6 +140,8 @@ because of Phabricator reports.
were removed. Use the ParserCache class instead. were removed. Use the ParserCache class instead.
* ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback * ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback
instead. instead.
* Support for ResourceLoaderModule::getModifiedTime() and getModifiedHash(),
deprecated since 1.26, was removed. Use getDefinitionSummary() instead.
=== Deprecations in 1.32 === === Deprecations in 1.32 ===
* Use of a StartProfiler.php file is deprecated in favour of placing * Use of a StartProfiler.php file is deprecated in favour of placing

39
includes/resourceloader/ResourceLoaderModule.php
View file

@ -799,11 +799,6 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
* This method should be quick because it is frequently run by ResourceLoaderStartUpModule to * This method should be quick because it is frequently run by ResourceLoaderStartUpModule to
* propagate changes to the client and effectively invalidate cache. * propagate changes to the client and effectively invalidate cache.
* *
* For backward-compatibility, the following optional data providers are automatically included:
*
* - getModifiedTime()
* - getModifiedHash()
*
* @since 1.26 * @since 1.26
* @param ResourceLoaderContext $context * @param ResourceLoaderContext $context
* @return string Hash (should use ResourceLoader::makeHash) * @return string Hash (should use ResourceLoader::makeHash)
@ -833,18 +828,6 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
throw new LogicException( 'getDefinitionSummary must call parent method' ); throw new LogicException( 'getDefinitionSummary must call parent method' );
} }
$str = json_encode( $summary ); $str = json_encode( $summary );
$mtime = $this->getModifiedTime( $context );
if ( $mtime !== null ) {
// Support: MediaWiki 1.25 and earlier
$str .= strval( $mtime );
}
$mhash = $this->getModifiedHash( $context );
if ( $mhash !== null ) {
// Support: MediaWiki 1.25 and earlier
$str .= strval( $mhash );
}
} }
$this->versionHash[$contextHash] = ResourceLoader::makeHash( $str ); $this->versionHash[$contextHash] = ResourceLoader::makeHash( $str );
@ -915,28 +898,6 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
]; ];
} }
/**
* Get this module's last modification timestamp for a given context.
*
* @deprecated since 1.26 Use getDefinitionSummary() instead
* @param ResourceLoaderContext $context
* @return int|null UNIX timestamp
*/
public function getModifiedTime( ResourceLoaderContext $context ) {
return null;
}
/**
* Helper method for providing a version hash to getVersionHash().
*
* @deprecated since 1.26 Use getDefinitionSummary() instead
* @param ResourceLoaderContext $context
* @return string|null Hash
*/
public function getModifiedHash( ResourceLoaderContext $context ) {
return null;
}
/** /**
* Check whether this module is known to be empty. If a child class * Check whether this module is known to be empty. If a child class
* has an easy and cheap way to determine that this module is * has an easy and cheap way to determine that this module is

2
tests/phpunit/includes/resourceloader/ResourceLoaderModuleTest.php
View file

@ -4,8 +4,6 @@ class ResourceLoaderModuleTest extends ResourceLoaderTestCase {
/** /**
* @covers ResourceLoaderModule::getVersionHash * @covers ResourceLoaderModule::getVersionHash
* @covers ResourceLoaderModule::getModifiedTime
* @covers ResourceLoaderModule::getModifiedHash
*/ */
public function testGetVersionHash() { public function testGetVersionHash() {
$context = $this->getResourceLoaderContext(); $context = $this->getResourceLoaderContext();