[EPIC] wbformatentities with both local and remote properties
Closed, ResolvedPublic13 Estimated Story Points
Actions

Assigned To

Authored By

	• Samantha_Alipio_WMDE
	Jun 22 2021, 8:39 AM

Description

As a user who already has a Wikibase containing properties, when I enable federated properties I want to see responses from both my local and the remote repository at the same time in the wbformatentities API.

This would mean with one local and one remote entity ID as an input to wbformatentities, the response would contain entity data from each of these entities.

We would limit this to only using standard content languages.

BDD
Scenario: Federated Property
Given I have enabled federated properties in a Wikibase containing local properties
When I call wbformatentities with a federated property entity ID
Then I see the link to the federated property with a label

Scenario: Local Property
Given I have enabled federated properties in a Wikibase containing local properties
When I call wbformatentities with a local entity ID
Then I see the link to the local property with a label

Scenario: Local & Federated Property
Given I have enabled federated properties in a Wikibase containing local properties
When I call wbgetentities with a local entity ID AND a federated entity ID
Then I see links to both the local and the federated property with a label

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	FP: Make TypeDispatchingExistenceChecker Type and Source Dispatching	mediawiki/extensions/Wikibase	master	+202 -62

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	Addshore	T285303 [EPIC] wbformatentities with both local and remote properties
Resolved	Rosalie_WMDE	T285453 Introduce and Use FederatedPropertyId
Resolved	Tarrow	T285454 Introduce and Test a FederatedPropertyAwareDispatchingIdParser
Resolved	Jakob_WMDE	T285455 Make an EntityExistenceChecker service that is aware of both types and sources of entities
Resolved	• Tonina_Zhelyazkova_WMDE	T285457 Figure out the right place to put the new FederatedPropertyId + Services
Resolved	Addshore	T285933 Services that need to become type and source dispatching aware
Resolved	Rosalie_WMDE	T285935 Disable EntityTypesDefinitionsFeddyPropsOverrider for entity type definitions
Resolved	Jakob_WMDE	T286060 Fix the testcase testFederatedPropertiesFailure which we currently skip
Resolved	Jakob_WMDE	T286199 Create a source and type dispatching EntityUrlLookup
Resolved	Jakob_WMDE	T286200 Create source and type dispatching PrefetchingTermLookup
Resolved	• Tonina_Zhelyazkova_WMDE	T286201 Create a source and type dispatching EntityTitleTextLookup
Resolved	Jakob_WMDE	T286202 Create a source and type dispatching EntityRedirectChecker
Resolved	• Tonina_Zhelyazkova_WMDE	T286203 Make EntityExistenceChecker use ServiceBySourceAndTypeDispatcher
Duplicate	None	T286205 Create Source And Type dispatching PrefetchingTermLookup
Resolved	Rosalie_WMDE	T286367 Make ApiEntityLookup work with FederatedPropertyId
Resolved	Jakob_WMDE	T287069 Add an e2e test covering wbformatentities for Federated Properties

Event Timeline

• Samantha_Alipio_WMDE created this task.Jun 22 2021, 8:39 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 22 2021, 8:39 AM

• Samantha_Alipio_WMDE moved this task from Backlog to Ready for story writing on the Wikibase - Federated Properties board.Jun 22 2021, 8:40 AM

• Samantha_Alipio_WMDE updated the task description. (Show Details)Jun 22 2021, 8:47 AM

• Samantha_Alipio_WMDE updated the task description. (Show Details)Jun 22 2021, 9:04 AM

• Samantha_Alipio_WMDE moved this task from Ready for story writing to Federation v2 - Sprint 1 on the Wikibase - Federated Properties board.Jun 22 2021, 9:07 AM

• Samantha_Alipio_WMDE edited projects, added Wikibase - Federated Properties (Federation v2 - Sprint 1); removed Wikibase - Federated Properties.

• Samantha_Alipio_WMDE moved this task from Federation v2 - Sprint 1 to Ready for story writing on the Wikibase - Federated Properties board.Jun 22 2021, 1:59 PM

• Samantha_Alipio_WMDE edited projects, added Wikibase - Federated Properties; removed Wikibase - Federated Properties (Federation v2 - Sprint 1).

• Samantha_Alipio_WMDE updated the task description. (Show Details)Jun 22 2021, 2:09 PM

• Samantha_Alipio_WMDE set the point value for this task to 13.Jun 22 2021, 2:17 PM

• Samantha_Alipio_WMDE moved this task from Ready for story writing to Ready for Breakdown on the Wikibase - Federated Properties board.

• Samantha_Alipio_WMDE moved this task from Ready for Breakdown to Federation v2 - Sprint 1 on the Wikibase - Federated Properties board.Jun 22 2021, 2:32 PM

• Samantha_Alipio_WMDE edited projects, added Wikibase - Federated Properties (Federation v2 - Sprint 1); removed Wikibase - Federated Properties.

Jakob_WMDE renamed this task from wbgetentities with both local and remote properties to wbformatentities with both local and remote properties.Jun 23 2021, 10:08 AM

Jakob_WMDE updated the task description. (Show Details)

Notes from task breakdown:

create a new class for these federated property ids that extends EntityId
create a FederatedPropertyAwareDispatchingEntityIdParser (or find a snappier name!) that wraps DispatchingEntityIdParser and creates new federated property ids from serialization or delegates to DispatchingEntityIdParser if the serialization is not a URI. The new parser can either directly create the new id objects or use a builder callback.
use FederatedPropertyAwareDispatchingEntityIdParser instead of DispatchingEntityIdParser if federated properties is enabled
FederatedPropertyAwareDispatchingEntityIdParser validates the concept URI and checks whether there is an entity source defined for that concept URI
all properties (federated or local) currently use LabelsProviderEntityIdHtmlLinkFormatter which depends on lots of services (EntityExistenceChecker, EntityTitleTextLookup, ...) that are swapped out by the entity type definitions when federated properties is enabled.

Dispatching by entity id and entity source

at the moment one entity type uniquely identifies an entity source. we're going to break that assumption!!! \o/
consequently we can no longer dispatch by entity type alone to get a service that does what it's supposed to do
therefore we should consider if the existing dispatching code should stay with an additional dimension (the entity source) or if we should build a new type of dispatching

consider replacing all uses of instanceof PropertyId with getType() === 'property'
consider investigating if old style federation entity id prefixes are used anywhere. are they flying around in the commons database?

Change 701135 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] WIP: introduce dispatching by source and type

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

gerritbot added a project: Patch-For-Review.Jun 23 2021, 3:50 PM

Change 701135 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] FP: Make TypeDispatchingExistenceChecker Type and Source Dispatching

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.14; 2021-07-12).Jun 29 2021, 2:00 PM

Maintenance_bot removed a project: Patch-For-Review.Jun 29 2021, 2:10 PM

Services that need to become type and source dispatching aware:

'WikibaseRepo.EntityIdHtmlLinkFormatterFactory'
- Either 'WikibaseRepo.EntityTitleLookup'
- Or 'WikibaseRepo.EntityTitleStoreLookup'

• Samantha_Alipio_WMDE renamed this task from wbformatentities with both local and remote properties to [EPIC] wbformatentities with both local and remote properties.Jul 7 2021, 9:08 AM

Tarrow moved this task from To do to Doing on the Wikibase - Federated Properties (Federation v2 - Sprint 1) board.Jul 7 2021, 9:08 AM

• Samantha_Alipio_WMDE edited projects, added Wikibase - Federated Properties (Federation v2 - Sprint 2); removed Wikibase - Federated Properties (Federation v2 - Sprint 1).Jul 7 2021, 9:09 AM

• Samantha_Alipio_WMDE moved this task from To do to Doing on the Wikibase - Federated Properties (Federation v2 - Sprint 2) board.

Addshore closed subtask T285457: Figure out the right place to put the new FederatedPropertyId + Services as Resolved.Jul 16 2021, 11:03 AM

Addshore closed subtask T285455: Make an EntityExistenceChecker service that is aware of both types and sources of entities as Resolved.

Addshore closed subtask T285454: Introduce and Test a FederatedPropertyAwareDispatchingIdParser as Resolved.

Addshore closed subtask T285453: Introduce and Use FederatedPropertyId as Resolved.