Page MenuHomePhabricator
Create Task
Maniphest T150848

Create a dispatching version of TermSearchInteractor
Closed, ResolvedPublic
Actions

Description

Scenario:

  • a Wikibase repository wants to use Properties from Wikidata, but locally defined Items

Solution:

  • the TermSearchInteractor underlying the wbsearchentities API module should know where to search for which kind of entity.

Implementation:

  • Implement a TermSearchInteractor that knows a target TermSearchInteractor for each entity type. Each such underlying TermSearchInteractor is configured to access a specific wiki.
  • Care must be taken that the correct ID mappings are applied when constructing the TermSearchResults.
  • The UI code remains completely oblivious to federation

Caveats:

  • we do not support searching for the same kind of entity on multiple repos, but this will likely be needed in the future.
  • merging search results from different repos is tricky, because relevance scores are not comparable between instances
  • Eventually, TermSearchResults should get a new field identifying the repository on which a match was found.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Add DispatchingTermSearchInteractormediawiki/extensions/Wikibasemaster+192 -0
Expose the name of the repository on which TermSearchResult was foundmediawiki/extensions/Wikibasemaster+21 -2
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT115858 Design improvements for mw.ForeignStructuredUpload.BookletLayout
 OpenNoneT115865 Insert image in content immediately after it's uploaded, skipping the "General settings" step
 DuplicateNoneT115864 Figure out if the description of the image can be used as the caption on-wiki
 OpenFeatureNoneT53032 When inserting an image, set its caption by default to be the Commons image description
 OpenFeatureNoneT39534 Wikimedia Commons should support searching by color
 DuplicateNoneT39535 Wikimedia Commons should support filtering by color
 ResolvedNoneT19503 Provide metadata support on Wikimedia Commons
 ResolvedNoneT51662 VisualEditor: Use Multimedia/Wikidata's proposed rich structured meta-data in the image insertion dialog
 ResolvedNoneT68108 [Epic] Store media information for files on Wikimedia Commons as structured data
 OpenNoneT109579 [Epic] Give more sister projects access to Wikidata
 OpenNoneT187900 There is no way to reference a specific quote on Wikiquote
 StalledNoneT71753 [Story] Wikibase / Wikidata support on Wikiquote
 ResolvedLydia_PintscherT146637 Wikidata 2016 Q4 goals
 ResolvedLydia_PintscherT150179 Wikidata 2017 Q1 goals
 ResolvedLydia_PintscherT76007 [Epic] add ability to link/refer to foreign items and properties (federation)
 ResolvedLydia_PintscherT149580 Allow access to entity data stored on "foreign" repositories (federation)
 ResolvedWMDE-leszekT150848 Create a dispatching version of TermSearchInteractor
 ResolvedWMDE-leszekT151053 Create repo-aware TermSqlIndex
 DeclinedWMDE-leszekT151210 Add repository name to TermIndexEntry
 ResolvedWMDE-leszekT151212 Make TermIndexEntry's constructor expect the instance of EntityId as an enity id, not the number
 ResolvedNoneT151573 Add repository name parameter to EntityIdComposer::composeEntityId
 ResolvedWMDE-leszekT151574 Add $repoName parameter to entity composer callbacks.
 ResolvedNoneT151575 Add composer callbacks to entitytype definitions of Property and Item
 ResolvedWMDE-leszekT152083 Expose the repository on which wbsearchentities match was found

Event Timeline

daniel created this task.Nov 16 2016, 12:39 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 16 2016, 12:39 PM
gerritbot subscribed.Nov 17 2016, 3:51 PM

Change 322118 had a related patch set uploaded (by WMDE-leszek):
Add DispatchingTermSearchInteractor

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

gerritbot added a project: Patch-For-Review.Nov 17 2016, 3:51 PM
WMDE-leszek claimed this task.Nov 17 2016, 3:53 PM
WMDE-leszek moved this task from proposed to doing on the WMDE-TLA-Team board.
Ladsgroup edited projects, added Wikidata-Former-Sprint-Board; removed WMDE-TLA-Team.Nov 18 2016, 10:27 AM
Ladsgroup moved this task from Proposed to Doing on the Wikidata-Former-Sprint-Board board.Nov 18 2016, 10:28 AM
WMDE-leszek added a comment.Nov 18 2016, 12:06 PM

Regarding this part:

Eventually, TermSearchResults should get a new field identifying the repository on which a match was found.

If I get it right, it could already be fetched from the matched entity id. It makes sense to expose the repository name, and would be easy to have it, e.g. simply by adding TermSearchResult::getRepositoryName. Do we still want to have a field for this in TermSearchResult, along with the public method returning the repository name?

gerritbot added a comment.Nov 18 2016, 12:21 PM

Change 322254 had a related patch set uploaded (by WMDE-leszek):
Expose the name of the repository on which TermSearchResult was found

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

daniel added a parent task: T151053: Create repo-aware TermSqlIndex.Nov 18 2016, 1:08 PM
daniel mentioned this in T151307: Provide access to property info from remote repositories.Nov 24 2016, 5:35 PM
daniel removed a parent task: T151053: Create repo-aware TermSqlIndex.Nov 24 2016, 6:02 PM
daniel added a subtask: T151053: Create repo-aware TermSqlIndex.
daniel added a comment.Nov 30 2016, 6:36 PM

Most of this is done now. I'm wondering whether we want to explicitly expose the repo on which a match was found via the wbsearchentities API module. It's implicit in the entity IDs, but the client should not need to decode the IDs in order to indicate where a match was found.

Note that this will not be necessary for the baseline, where entity types are bound to repositories. But when we support using e.g. properties from different repos, we may want to indicate which property comes from where, to allow the user an informed choice of which vocabulary to use.

gerritbot added a comment.Nov 30 2016, 6:58 PM

Change 322118 merged by jenkins-bot:
Add DispatchingTermSearchInteractor

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

gerritbot added a comment.Nov 30 2016, 7:02 PM

Change 322254 merged by jenkins-bot:
Expose the name of the repository on which TermSearchResult was found

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

WMDE-leszek mentioned this in T152083: Expose the repository on which wbsearchentities match was found.Dec 1 2016, 9:06 AM
WMDE-leszek created subtask T152083: Expose the repository on which wbsearchentities match was found.

@daniel: I agree, it makes a lot of sense to have it explicitly there. I've filed T152083 to track this (although, as you said, it is not top-priority thing for now).

daniel closed this task as Resolved.Dec 5 2016, 5:50 PM
daniel closed subtask T151053: Create repo-aware TermSqlIndex as Resolved.
Ladsgroup moved this task from Doing to Done on the Wikidata-Former-Sprint-Board board.Dec 6 2016, 1:05 AM
WMDE-leszek closed subtask T152083: Expose the repository on which wbsearchentities match was found as Resolved.Feb 15 2017, 10:43 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits