Create PageURLLookup service
Open, Needs TriagePublic
Actions

Assigned To

Authored By

	daniel
	May 7 2021, 9:04 PM

Description

The PageURLLookup service should provide a new home for the URL related methods in the Title class.

Rough interface draft:

class PageURLLookup {
    public function getPrefixedURL( $page );
    public function getFullURL( $page, $query = '', $query2 = false, $proto = PROTO_RELATIVE )( $page );
    public function getFullUrlForRedirect( $page, $query = '', $proto = PROTO_CURRENT );
    public function getLocalURL( $page, $query = '', $query2 = false );
    public function getLinkURL(  $page, $query = '', $query2 = false, $proto = false );
    public function getInternalURL(  $page, $query = '', $query2 = false );
    public function getCanonicalURL(  $page, $query = '', $query2 = false );
}

We can make $page be of type PageReference|LinkTarget for convenience.

Alternative Design
We can make a Linkable entity that has all the getter from Title. Title could even implement that interface. And we could have two new implementations, one wrapping a Pagereference, the other wrapping a LinkTarget.

We's then need a factory for such Linkable entities, though.

Details

Subject	Repo	Branch	Lines +/-
Add benchmark for Title URL mapping	mediawiki/core	master	+146 -2
Introduce PageLinkLookup	mediawiki/core	master	+2 K -206
WIP: Introduce LinkUrlResolver	mediawiki/core	master	+2 K -189

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	daniel	T282283 Create PageURLLookup service
Open	None	T287343 Remove hooks from Title::get**URL methods
Open	None	T292796 Benchmark LinkUrlResolver

Event Timeline

daniel created this task.May 7 2021, 9:04 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 7 2021, 9:04 PM

daniel updated the task description. (Show Details)May 7 2021, 9:30 PM

daniel moved this task from Unsorted pile to PageStore pile on the Platform Team Workboards (MW Expedition) board.Jun 8 2021, 11:40 AM

• Pchelolo mentioned this in T89937: Remove GetLocalURL::Internal hack from CommonsMetadata.Jul 25 2021, 7:13 PM

I think that we need to return PSR-7 URIInterface.

Proposal:

/**
  * UriInterface with nice utility and MW-specific features. Not sure it's needed.
  */
class MWUriInterface extends UriInterface {
   
   public function __construct( UriInterface $uri );

   public function withQueryArray( array $query ): MWUriInterface;
   public function addQuery( string $additionalQuery ): MWUriInterface;
   public function addQueryArray( array $additionalQuery): MWUriInterface;
   // Override all mutator methods to return MWUriInterface
}

// Lazily parses the URI if any of the parts accessors are called.
class LazyUri implements UriInterface {
   public function __construct( string $uri )
   public function __toString() {
     return $this->uri;
  }
}

interface PageUriResolver {
    public function getAbsoluteURL( LinkTarget|PageReference $page ): MWUriInterface;
    public function getLocalURL( LinkTarget|PageReference $page): MWUriInterface;
    public function getInternalURL( LinkTarget|PageReference $page ): MWUriInterface;
    public function getCanonicalURL( LinkTarget|PageReference $page ): MWUriInterface;
}

Open questions:

Should we pass $query right away, or should we call URIInterface query manipulation methods on the result? I like the latter.
Same with fragment - some of the methods are only different in whether fragment is provided.
$proto - many alternatives. Can use UriInterface::withScheme to set the protocol, can pass the desired protocol in a constructor and make a factory. Need to assess the callers.