This greatly simplifies logic required to compute module versions.
It also makes it significantly less error-prone.
Since
f37cee996e, we support hashes as versions (instead of timestamps).
This means we can build a hash of the content directly, instead of compiling a
large array with all values that may influence the module content somehow.
Benefits:
* Remove all methods and logic related to querying database and disk for
timestamps, revision numbers, definition summaries, cache epochs, and more.
* No longer needlessly invalidate cache as a result of no-op changes to
implementation datails. Due to inclusion of absolute file paths in the
definition summary, cache was always invalidated when moving wikis to newer
MediaWiki branches; even if the module observed no actual changes.
* When changes are reverted within a certain period of time, old caches can now
be re-used. The module would produce the same version hash as before.
Previously when a change was deployed and then reverted, all web clients (even
those that never saw the bad version) would have re-fetch modules because the
version increased.
Updated unit tests to account for the change in version. New default version of
empty test modules is: "mvgTPvXh". For the record, this comes from the base64
encoding of the SHA1 digest of the JSON serialised form of the module content:
> $str = '{"scripts":"","styles":{"css":[]},"messagesBlob":"{}"}';
> echo base64_encode(sha1($str, true));
> FEb3+VuiUm/fOMfod1bjw/te+AQ=
Enabled content versioning for the data modules in MediaWiki core:
* EditToolbarModule
* JqueryMsgModule
* LanguageDataModule
* LanguageNamesModule
* SpecialCharacterDataModule
* UserCSSPrefsModule
* UserDefaultsModule
* UserOptionsModule
The FileModule and base class explicitly disable it for now and keep their
current behaviour of using the definition summary. We may remove it later, but
that requires more performance testing first.
Explicitly disable it in the WikiModule class to avoid breakage when the
default changes.
Ref T98087.
Change-Id: I782df43c50dfcfb7d7592f744e13a3a0430b0dc6
}
/**
- * @param ResourceLoaderContext $context
- * @return array
+ * @return bool
*/
- public function getDefinitionSummary( ResourceLoaderContext $context ) {
- $summary = parent::getDefinitionSummary( $context );
- $summary[] = array(
- 'lessVars' => $this->getLessVars( $context ),
- );
- return $summary;
+ public function enableModuleContentVersion() {
+ return true;
}
/**
return $this->raw;
}
+ /**
+ * Disable module content versioning.
+ *
+ * This class uses getDefinitionSummary() instead, to avoid filesystem overhead
+ * involved with building the full module content inside a startup request.
+ *
+ * @return bool
+ */
+ public function enableModuleContentVersion() {
+ return false;
+ }
+
/**
* Helper method to gather file mtimes for getDefinitionSummary.
*
}
/**
- * @param ResourceLoaderContext $context
- * @return array|null
+ * @return bool
*/
- public function getDefinitionSummary( ResourceLoaderContext $context ) {
- $summary = parent::getDefinitionSummary( $context );
- $summary[] = array(
- 'sanitizerData' => Sanitizer::getRecognizedTagData()
- );
- return $summary;
+ public function enableModuleContentVersion() {
+ return true;
}
}
}
/**
- * @param ResourceLoaderContext $context
- * @return string Hash
+ * @return bool
*/
- public function getModifiedHash( ResourceLoaderContext $context ) {
- return md5( serialize( $this->getData( $context ) ) );
+ public function enableModuleContentVersion() {
+ return true;
}
/**
protected $targets = array( 'desktop', 'mobile' );
-
/**
* @param ResourceLoaderContext $context
* @return array
}
/**
- * @param ResourceLoaderContext $context
- * @return string Hash
+ * @return bool
*/
- public function getModifiedHash( ResourceLoaderContext $context ) {
- return md5( serialize( $this->getData( $context ) ) );
+ public function enableModuleContentVersion() {
+ return true;
}
}
$contextHash = $context->getHash();
if ( !array_key_exists( $contextHash, $this->versionHash ) ) {
- $summary = $this->getDefinitionSummary( $context );
- if ( !isset( $summary['_cacheEpoch'] ) ) {
- throw new Exception( 'getDefinitionSummary must call parent method' );
- }
- $str = json_encode( $summary );
+ if ( $this->enableModuleContentVersion() ) {
+ // Detect changes directly
+ $str = json_encode( $this->getModuleContent( $context ) );
+ } else {
+ // Infer changes based on definition and other metrics
+ $summary = $this->getDefinitionSummary( $context );
+ if ( !isset( $summary['_cacheEpoch'] ) ) {
+ throw new Exception( 'getDefinitionSummary must call parent method' );
+ }
+ $str = json_encode( $summary );
- $mtime = $this->getModifiedTime( $context );
- if ( $mtime !== null ) {
- // Support: MediaWiki 1.25 and earlier
- $str .= strval( $mtime );
- }
+ $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 );
+ $mhash = $this->getModifiedHash( $context );
+ if ( $mhash !== null ) {
+ // Support: MediaWiki 1.25 and earlier
+ $str .= strval( $mhash );
+ }
}
$this->versionHash[$contextHash] = ResourceLoader::makeHash( $str );
return $this->versionHash[$contextHash];
}
+ /**
+ * Whether to generate version hash based on module content.
+ *
+ * If a module requires database or file system access to build the module
+ * content, consider disabling this in favour of manually tracking relevant
+ * aspects in getDefinitionSummary(). See getVersionHash() for how this is used.
+ *
+ * @return bool
+ */
+ public function enableModuleContentVersion() {
+ return false;
+ }
+
/**
* Get the definition summary for this module.
*
}
/**
- * @param ResourceLoaderContext $context
- * @return string Hash
+ * @return bool
*/
- public function getModifiedHash( ResourceLoaderContext $context ) {
- return md5( serialize( $this->getData() ) );
+ public function enableModuleContentVersion() {
+ return true;
}
/**
protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
/**
- * @param ResourceLoaderContext $context
- * @return array|int|mixed
+ * @return bool
*/
- public function getModifiedTime( ResourceLoaderContext $context ) {
- return wfTimestamp( TS_UNIX, $context->getUserObj()->getTouched() );
+ public function enableModuleContentVersion() {
+ return true;
}
/**
*/
class ResourceLoaderUserDefaultsModule extends ResourceLoaderModule {
- /* Protected Members */
-
protected $targets = array( 'desktop', 'mobile' );
- /* Methods */
-
/**
- * @param ResourceLoaderContext $context
- * @return string Hash
+ * @return bool
*/
- public function getModifiedHash( ResourceLoaderContext $context ) {
- return md5( serialize( User::getDefaultOptions() ) );
+ public function enableModuleContentVersion() {
+ return true;
}
/**
}
/**
- * @param ResourceLoaderContext $context
- * @return int
+ * @return bool
*/
- public function getModifiedTime( ResourceLoaderContext $context ) {
- return wfTimestamp( TS_UNIX, $context->getUserObj()->getTouched() );
+ public function enableModuleContentVersion() {
+ return true;
}
/**
return $styles;
}
+ /**
+ * Disable module content versioning.
+ *
+ * This class does not support generating content outside of a module
+ * request due to foreign database support.
+ *
+ * See getDefinitionSummary() for meta-data versioning.
+ *
+ * @return bool
+ */
+ public function enableModuleContentVersion() {
+ return false;
+ }
+
/**
* @param ResourceLoaderContext $context
* @return array
public function isRaw() {
return $this->isRaw;
}
+
+ public function enableModuleContentVersion() {
+ return true;
+ }
}
class ResourceLoaderFileModuleTestModule extends ResourceLoaderFileModule {
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK"
+ "wvTifjse"
]
] );',
) ),
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK"
+ "wvTifjse"
],
[
"test.group.foo",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-foo"
],
[
"test.group.bar",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-bar"
]
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK"
+ "wvTifjse"
]
] );'
) ),
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK",
+ "wvTifjse",
[],
null,
"example"
} );mw.loader.register( [
[
"test.x.core",
- "XyCC+PSK"
+ "wvTifjse"
],
[
"test.x.polyfill",
- "XyCC+PSK",
+ "wvTifjse",
[],
null,
null,
],
[
"test.y.polyfill",
- "XyCC+PSK",
+ "wvTifjse",
[],
null,
null,
],
[
"test.z.foo",
- "XyCC+PSK",
+ "wvTifjse",
[
0,
1,
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK"
+ "wvTifjse"
],
[
"test.x.core",
- "XyCC+PSK"
+ "wvTifjse"
],
[
"test.x.util",
- "XyCC+PSK",
+ "wvTifjse",
[
1
]
],
[
"test.x.foo",
- "XyCC+PSK",
+ "wvTifjse",
[
1
]
],
[
"test.x.bar",
- "XyCC+PSK",
+ "wvTifjse",
[
2
]
],
[
"test.x.quux",
- "XyCC+PSK",
+ "wvTifjse",
[
3,
4,
],
[
"test.group.foo.1",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-foo"
],
[
"test.group.foo.2",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-foo"
],
[
"test.group.bar.1",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-bar"
],
[
"test.group.bar.2",
- "XyCC+PSK",
+ "wvTifjse",
[],
"x-bar",
"example"
$this->assertEquals(
'mw.loader.addSource({"local":"/w/load.php"});'
. 'mw.loader.register(['
-. '["test.blank","XyCC+PSK"],'
-. '["test.min","XyCC+PSK",[0],null,null,'
+. '["test.blank","wvTifjse"],'
+. '["test.min","wvTifjse",[0],null,null,'
. '"return!!(window.JSON\u0026\u0026JSON.parse\u0026\u0026JSON.stringify);"'
. ']]);',
$module->getModuleRegistrations( $context ),
} );mw.loader.register( [
[
"test.blank",
- "XyCC+PSK"
+ "wvTifjse"
],
[
"test.min",
- "XyCC+PSK",
+ "wvTifjse",
[
0
],
dépôts / lhc / web / wiklou.git / commitdiff