Implement search result fields augmentation approach in SearchHandler
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

Motivation

Once the technical approach from T250139 is confirmed, It should be implemented in code.

Add 2 hooks (naming TBD on gerrit review): "provideThumbnailsForPages" and "provideDescriptionForPages".
Contract for hooks the following: [ &$pageIds ], where $pageIds is an array of pageId=>null. Provided should amend it setting a value for a certain pageId instead of null.
provideThumbnailsForPages should provide objects of type ThumbnalInfo (exact type or name of class, or whatever it is TBD)
provideDescriptionForPages should provide objects of type string
SearchHandler (or some class in the 'core') should serialize the info provided by hooks in a proper way and augment the proper fields if the results with it.

Expected result

Hooks should be introduced
Tests that verifies that hooks are called in a proper way should be added
Augmentation logic that merges results with info provided from hooks should be implemented
Bot integration and Unit Tests that verifies the augmentation logic should be provided

Details

	Subject	Repo	Branch	Lines +/-
	rest: Add 'thumbnail' and 'description' fields to the search response	mediawiki/core	master	+534 -36

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T49145 Formally deprecate jQuery UI after we've stopped using jQuery UI in extensions and core
Open	None	T100270 Replace use of jQuery UI and MW UI with OOUI across all Wikimedia-deployed extensions and core
Open	None	T85394 Use OOUI suggestions/autocompletion components only (instead of jquery.suggestions, jquery.ui.autocomplete)
Open	None	T125725 [epic] Update autocomplete search box with metadata and remove and delete the old searchSuggest system
Open	None	T177251 Dead keys prevent autocomplete in search box
Resolved	ovasileva	T244392 [GOAL] Deploy the new Vue.js search experience
Resolved	Volker_E	T249299 [Epic] Build the new Vue.js search experience
Resolved	phuedx	T244287 Build the Vue.js search component network client
Invalid	None	T229661 Core REST API in MediaWiki
Resolved	• eprodromou	T245672 Search endpoint enhancement
Resolved	EvanProdromou	T245673 Reader gets page thumbnail with search results
Resolved	Peter.ovchyn	T250144 Implement search result fields augmentation approach in SearchHandler

Event Timeline

Peter.ovchyn created this task.Apr 14 2020, 10:27 AM

Peter.ovchyn triaged this task as Medium priority.Apr 14 2020, 5:05 PM

Peter.ovchyn updated the task description. (Show Details)

Peter.ovchyn set the point value for this task to 5.

Peter.ovchyn moved this task from Backlog to In Progress/Doing on the Platform Team Workboards (S&F Workboard) board.Apr 14 2020, 5:10 PM

Peter.ovchyn mentioned this in T250207: Implement getting the thumbnails in the PageImages extension.Apr 14 2020, 5:16 PM

Peter.ovchyn mentioned this in T250217: Implement getting the page description in Wikibase/client extension.Apr 14 2020, 6:25 PM

Peter.ovchyn mentioned this in T250139: Create generic technical approach to Augment search result .Apr 15 2020, 7:49 AM

Change 588999 had a related patch set uploaded (by Peter.ovchyn; owner: Peter.ovchyn):
[mediawiki/core@master] rest: WIP! Add 'thumbnail' and 'description' fields to the search response

https://gerrit.wikimedia.org/r/588999

gerritbot added a project: Patch-For-Review.Apr 15 2020, 12:33 PM

@daniel You wanted to have a strict type for thumbnails and serialize it in the core. Should I create something like ThumbnailValue?

In T250144#6058624, @Peter.ovchyn wrote:

@daniel You wanted to have a strict type for thumbnails and serialize it in the core. Should I create something like ThumbnailValue?

Yes, please. Though I'm wondering whether this should be specific to the search domain, to avoid over-generalizing. So perhaps we should call it something like SearchResultThumbnail.

Peter.ovchyn moved this task from In Progress/Doing to In Progress/In Review on the Platform Team Workboards (S&F Workboard) board.Apr 15 2020, 5:30 PM

Peter.ovchyn mentioned this in T251915: Use TitleFormatter instead of direct access in SearchHandler.May 5 2020, 4:18 PM

Change 588999 merged by jenkins-bot:
[mediawiki/core@master] rest: Add 'thumbnail' and 'description' fields to the search response

https://gerrit.wikimedia.org/r/588999

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.32; 2020-05-12).May 5 2020, 9:00 PM

Maintenance_bot removed a project: Patch-For-Review.May 5 2020, 9:10 PM

Peter.ovchyn moved this task from In Progress/In Review to Done on the Platform Team Workboards (S&F Workboard) board.May 6 2020, 2:20 PM

Peter.ovchyn mentioned this in T252063: Add integration tests that verify Thumbnails serialisation into JSON according to FileRepresentation specification.May 6 2020, 7:43 PM

Peter.ovchyn closed this task as Resolved.May 7 2020, 3:42 PM

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:41 PM

matthiasmullie mentioned this in T307034: [SPIKE] Result thumbnails questions.May 18 2022, 3:22 PM