Drop some code that now lives in core

The default thumbnail size (SearchResultThumbnailProvider::THUMBNAIL_SIZE),
the code to build a SearchResultThumbnail object from a File object
(SearchResultThumbnailProvider::buildSearchResultThumbnailFromFile),
and the code that provides thumbnails from NS_FILE pages (now already
provided in the hook's $results param) have essentially been adopted
in core and no longer need to be handled here.

Also updated test to reflect that NS_FILE results will no longer be
provided by this extension (since core already provides them)

Depends-On: I2a679b51758020d3e822da01a1bde1ae632b0b0a
Change-Id: I2eafc8556022432929973755d8cd76010ea24f39
Bug: T306883

extension.json

@@ -42,7 +42,7 @@
 		},
 		"search": {
 			"class": "PageImages\\Hooks\\SearchResultProvideThumbnailHookHandler",
-			"services": [ "PageProps", "RepoGroup" ]
+			"services": [ "SearchResultThumbnailProvider", "PageProps", "RepoGroup" ]
 		}
 	},
 	"JobClasses": {

includes/Hooks/SearchResultProvideThumbnailHookHandler.php

@@ -3,16 +3,16 @@
 namespace PageImages\Hooks;
 
 use MediaWiki\Page\PageIdentity;
-use MediaWiki\Search\Entity\SearchResultThumbnail;
 use MediaWiki\Search\Hook\SearchResultProvideThumbnailHook;
+use MediaWiki\Search\SearchResultThumbnailProvider;
 use PageImages\PageImages;
 use PageProps;
 use RepoGroup;
-use Title;
 
 class SearchResultProvideThumbnailHookHandler implements SearchResultProvideThumbnailHook {
 
-	public const THUMBNAIL_SIZE = 200;
+	/** @var SearchResultThumbnailProvider */
+	private $thumbnailProvider;
 
 	/** @var PageProps */
 	private $pageProps;
@@ -21,23 +21,37 @@ class SearchResultProvideThumbnailHookHandler implements SearchResultProvideThum
 	private $repoGroup;
 
 	/**
+	 * @param SearchResultThumbnailProvider $thumbnailProvider
 	 * @param PageProps $pageProps
 	 * @param RepoGroup $repoGroup
 	 */
-	public function __construct( PageProps $pageProps, RepoGroup $repoGroup ) {
+	public function __construct(
+		SearchResultThumbnailProvider $thumbnailProvider,
+		PageProps $pageProps,
+		RepoGroup $repoGroup
+	) {
+		$this->thumbnailProvider = $thumbnailProvider;
 		$this->pageProps = $pageProps;
 		$this->repoGroup = $repoGroup;
 	}
 
 	/**
-	 * Returns a list fileNames associated with given pages
+	 * Returns a list of fileNames for a given list of PageIdentity objects (outside of NS_FILE)
 	 *
-	 * @param array $pagesByPageId key-value array where key is pageID and value is Title
+	 * @param PageIdentity[] $identitiesByPageId key-value array of where key
+	 *   is pageId, value is PageIdentity
 	 * @return array
 	 */
-	private function getFileNamesForPageTitles( $pagesByPageId ): array {
+	private function getFileNamesByPageId( array $identitiesByPageId ): array {
+		$nonFileIdentitiesByPageId = array_filter(
+			$identitiesByPageId,
+			static function ( PageIdentity $pageIdentity ) {
+				return $pageIdentity->getNamespace() !== NS_FILE;
+			}
+		);
+
 		$propValues = $this->pageProps->getProperties(
-			$pagesByPageId,
+			$nonFileIdentitiesByPageId,
 			PageImages::getPropNames( PageImages::LICENSE_ANY )
 		);
 		$fileNames = array_map( static function ( $prop ) {
@@ -47,82 +61,27 @@ class SearchResultProvideThumbnailHookHandler implements SearchResultProvideThum
 		}, $propValues );
 
 		return array_filter( $fileNames, static function ( $fileName ) {
-			return $fileName != null;
+			return $fileName !== null;
 		} );
 	}
 
 	/**
-	 * Returns a list fileNames for with given LinkTarget, where title is NS_FILE
+	 * @param array $pageIdentities array that contain $pageId => PageIdentity.
-	 *
-	 * @param array $linkFileTargetsByPageId key-value array of where key
-	 *   is pageId, value is LinkTarget
-	 * @return array
-	 */
-	private function getFileNamesForFileTitles( $linkFileTargetsByPageId ): array {
-		return array_map( static function ( $linkFileTarget ) {
-			return $linkFileTarget->getDBkey();
-		}, $linkFileTargetsByPageId );
-	}
-
-	/**
-	 * Returns thumbnails for given list
-	 *
-	 * @param array $titlesByPageId a key value array where key is pageId and value is Title
-	 * @param int $size size of thumbnail height and width in points
-	 * @return SearchResultThumbnail[]
-	 */
-	private function getThumbnails( array $titlesByPageId, int $size ): array {
-		$pagesByPageId = array_filter( $titlesByPageId, static function ( $title ) {
-			return !$title->inNamespace( NS_FILE );
-		} );
-		$titleFilesByPageId = array_filter( $titlesByPageId, static function ( $title ) {
-			return $title->inNamespace( NS_FILE );
-		} );
-
-		$files = $this->getFileNamesForPageTitles( $pagesByPageId )
-			+ $this->getFileNamesForFileTitles( $titleFilesByPageId );
-
-		$res = [];
-		foreach ( $files as $pageId => $fileName ) {
-			$file = $this->repoGroup->findFile( $fileName );
-			if ( !$file ) {
-				continue;
-			}
-			$thumb = $file->transform( [ 'width' => $size , 'height' => $size ] );
-			if ( !$thumb || $thumb->isError() ) {
-				continue;
-			}
-
-			$localPath = $thumb->getLocalCopyPath();
-			$thumbSize = $localPath && file_exists( $localPath ) ? filesize( $localPath ) : null;
-
-			$res[$pageId] = new SearchResultThumbnail(
-				$thumb->getFile()->getMimeType(),
-				$thumbSize,
-				$thumb->getWidth(),
-				$thumb->getHeight(),
-				null,
-				wfExpandUrl( $thumb->getUrl(), PROTO_RELATIVE ),
-				$fileName
-			);
-		}
-
-		return $res;
-	}
-
-	/**
-	 * @param array $pageIdentities array that contain $pageId => SearchResultPageIdentity.
 	 * @param array &$results Placeholder for result. $pageId => SearchResultThumbnail
 	 * @param int|null $size size of thumbnail height and width in points
 	 */
 	public function onSearchResultProvideThumbnail( array $pageIdentities, &$results, int $size = null ): void {
-		$pageIdTitles = array_map( static function ( PageIdentity $identity ) {
+		$fileNamesByPageId = $this->getFileNamesByPageId( $pageIdentities );
-			return Title::makeTitle( $identity->getNamespace(), $identity->getDBkey() );
+		$results = $results ?? [];
-		}, $pageIdentities );
+		foreach ( $fileNamesByPageId as $pageId => $fileName ) {
-
+			$file = $this->repoGroup->findFile( $fileName );
-		$data = $this->getThumbnails( $pageIdTitles, $size ?? self::THUMBNAIL_SIZE );
+			if ( !$file ) {
-		foreach ( $data as $pageId => $thumbnail ) {
+				continue;
-			$results[ $pageId ] = $thumbnail;
+			}
+			$thumbnail = $this->thumbnailProvider->buildSearchResultThumbnailFromFile( $file, $size );
+			if ( $thumbnail ) {
+				$results[$pageId] = $thumbnail;
+			}
 		}
 	}
 }

tests/phpunit/Hooks/SearchResultProvideThumbnailHookHandlerTest.php

@@ -5,10 +5,12 @@ namespace PageImages\Tests\Hooks;
 use LocalFile;
 use MediaWiki\Page\PageIdentity;
 use MediaWiki\Page\PageIdentityValue;
+use MediaWiki\Search\SearchResultThumbnailProvider;
 use MediaWikiIntegrationTestCase;
 use PageImages\Hooks\SearchResultProvideThumbnailHookHandler;
 use PageImages\PageImages;
 use PageProps;
+use PHPUnit\Framework\MockObject\Stub\ReturnCallback;
 use RepoGroup;
 use ThumbnailImage;
 
@@ -68,17 +70,23 @@ class SearchResultProvideThumbnailHookHandlerTest extends MediaWikiIntegrationTe
 	 * Creates mock object for LocalFile
 	 * @param int $size
 	 * @param string $thumbFilePath
+	 * @param string $filename
 	 * @return LocalFile
 	 */
-	private function getMockLocalFile( int $size, $thumbFilePath ): LocalFile {
+	private function getMockLocalFile( int $size, $thumbFilePath, $filename ): LocalFile {
 		$file = $this->getMockBuilder( LocalFile::class )
 			->disableOriginalConstructor()
 			->onlyMethods( [
+				'getName',
 				'transform',
 				'getMimeType'
 			] )
 			->getMock();
 
+		$file->expects( $this->once() )
+			->method( 'getName' )
+			->willReturn( $filename );
+
 		$file->expects( $this->once() )
 			->method( 'transform' )
 			->with( [ 'width' => $size , 'height' => $size ] )
@@ -123,44 +131,42 @@ class SearchResultProvideThumbnailHookHandlerTest extends MediaWikiIntegrationTe
 			->onlyMethods( [ 'findFile' ] )
 			->getMock();
 
-		$repoGroup->expects( $this->exactly( 4 ) )
+		$findFileCallback = function ( $filename ) {
+			return $this->getMockLocalFile(
+				SearchResultThumbnailProvider::THUMBNAIL_SIZE,
+				__FILE__,
+				$filename
+			);
+		};
+		$repoGroup->expects( $this->exactly( 2 ) )
 			->method( 'findFile' )
-			->withConsecutive( [ 'File1.jpg' ], [ 'File2_any.jpg' ], [ 'dbKey3' ], [ 'dbKey4' ] )
+			->withConsecutive( [ 'File1.jpg' ], [ 'File2_any.jpg' ] )
 			->willReturnOnConsecutiveCalls(
-				$this->getMockLocalFile(
+				new ReturnCallback( $findFileCallback ),
-					SearchResultProvideThumbnailHookHandler::THUMBNAIL_SIZE,
-					__FILE__
-				),
-				null,
-				$this->getMockLocalFile(
-					SearchResultProvideThumbnailHookHandler::THUMBNAIL_SIZE,
-					false
-				),
 				null
 			);
 
-		$handler = new SearchResultProvideThumbnailHookHandler( $pageProps, $repoGroup );
+		$provider = new SearchResultThumbnailProvider( $repoGroup, $this->createHookContainer() );
+		$handler = new SearchResultProvideThumbnailHookHandler( $provider, $pageProps, $repoGroup );
 
 		$results = [ 1 => null, 2 => null, 3 => null, 4 => null ];
 		$handler->onSearchResultProvideThumbnail( $pageIdentities, $results );
 
 		$this->assertNull( $results[ 2 ] );
+		$this->assertNull( $results[ 3 ] );
 		$this->assertNull( $results[ 4 ] );
 
 		$this->assertNotNull( $results[ 1 ] );
 		$this->assertSame( 'File1.jpg', $results[ 1 ]->getName() );
 		$this->assertSame(
-			SearchResultProvideThumbnailHookHandler::THUMBNAIL_SIZE,
+			SearchResultThumbnailProvider::THUMBNAIL_SIZE,
 			$results[ 1 ]->getWidth()
 		);
 		$this->assertSame(
-			SearchResultProvideThumbnailHookHandler::THUMBNAIL_SIZE,
+			SearchResultThumbnailProvider::THUMBNAIL_SIZE,
 			$results[ 1 ]->getHeight()
 		);
 		$this->assertGreaterThan( 0, $results[ 1 ]->getSize() );
 		$this->assertSame( 'https://example.org/test.url', $results[ 1 ]->getUrl() );
-
-		$this->assertNotNull( $results[ 3 ] );
-		$this->assertNull( $results[ 3 ]->getSize() );
 	}
 }