ResourceLoaderImage: Use hashes for versioning instead of timestamps
authorTimo Tijhof <krinklemail@gmail.com>
Wed, 17 Aug 2016 18:57:57 +0000 (11:57 -0700)
committerKrinkle <krinklemail@gmail.com>
Fri, 19 Aug 2016 00:05:33 +0000 (00:05 +0000)
Remove use of the deprecated getModifiedTime() method and incorporate
file information in getDefinitionSummary() directly, instead of relying
on the parent class to include getModifiedTime().

Change getDefinitionSummary() to append to the summary instead of
setting arbitrary keys in the array directly to avoid conflicts.
This matches the pattern used elsewhere.

Change ResourceLoaderImage to use file hashes instead of timestamps
to avoid needless cache invalidation. At Wikimedia these modules
tend to roll over every week due to git not storing timestamps.
See also T104950, 9112c9347bf37cee996.

Change-Id: I5d019bfb991c3b8042d1db14a853ba46cc690315

includes/resourceloader/ResourceLoaderImageModule.php

index 6cdab1b..43327c9 100644 (file)
@@ -393,6 +393,8 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
        public function getDefinitionSummary( ResourceLoaderContext $context ) {
                $this->loadFromDefinition();
                $summary = parent::getDefinitionSummary( $context );
+
+               $options = [];
                foreach ( [
                        'localBasePath',
                        'images',
@@ -401,29 +403,27 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
                        'selectorWithoutVariant',
                        'selectorWithVariant',
                ] as $member ) {
-                       $summary[$member] = $this->{$member};
+                       $options[$member] = $this->{$member};
                };
+
+               $summary[] = [
+                       'options' => $options,
+                       'fileHashes' => $this->getFileHashes( $context ),
+               ];
                return $summary;
        }
 
        /**
-        * Get the last modified timestamp of this module.
-        *
-        * @param ResourceLoaderContext $context Context in which to calculate
-        *     the modified time
-        * @return int UNIX timestamp
+        * Helper method for getDefinitionSummary.
         */
-       public function getModifiedTime( ResourceLoaderContext $context ) {
+       protected function getFileHashes( ResourceLoaderContext $context ) {
                $this->loadFromDefinition();
                $files = [];
                foreach ( $this->getImages( $context ) as $name => $image ) {
                        $files[] = $image->getPath( $context );
                }
-
                $files = array_values( array_unique( $files ) );
-               $filesMtime = max( array_map( [ __CLASS__, 'safeFilemtime' ], $files ) );
-
-               return $filesMtime;
+               return array_map( [ __CLASS__, 'safeFileHash' ], $files );
        }
 
        /**