Inconsistencies in Title->isValid and Title::newFromText documentation.
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• Pchelolo
	Aug 2 2019, 9:52 PM

Description

The Title::newFromText is documented as follows:

	 * Title objects returned by this method are guaranteed to be valid, and
	 * thus return true from the isValid() method.

however, this is not true. A simple example would be Title::newFromText( '#' )->isValid() === false.

I've modified one of the Title object tests to show that inconsistency is more widespread than just a single corner case. See https://gerrit.wikimedia.org/r/#/c/mediawiki/core/+/527660 and in particular the test failures for TitleTest there.

I'm wondering why Title::newFromText and Title::isValid use quite different (but similar) code paths? How about merging the two, like https://gerrit.wikimedia.org/r/c/mediawiki/core/+/527640 ?

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Title: make newFromText, isValid, and canExist behave consistently.	mediawiki/core	master	+263 -97

Customize query in gerrit

Related Objects

Mentioned In: T227817: Fatal error from Title->getTalkPage (Special:WhatLinksHere, Special:Contributions, …)

Event Timeline

• Pchelolo created this task.Aug 2 2019, 9:52 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 2 2019, 9:52 PM

• Pchelolo renamed this task from Inconsistencies in Title->isValid to Inconsistencies in Title->isValid and Title::newFromText documentation..Aug 2 2019, 9:53 PM

• Pchelolo mentioned this in T227817: Fatal error from Title->getTalkPage (Special:WhatLinksHere, Special:Contributions, …).Aug 2 2019, 9:56 PM

Assuming this task is about MediaWiki-General, hence adding project tag so others can find this task when searching for tasks under that code project.

• WDoranWMF moved this task from Inbox to Triage Meeting Inbox on the Platform Engineering board.Aug 5 2019, 1:13 PM

Relying on a guarantee that is not there, will cause ongoing problems if - at least - the documentation error is not fixed.

• WDoranWMF moved this task from Inbox to Ready (WIP:5) on the Platform Team Workboards (Clinic Duty Team) board.Aug 13 2019, 6:31 PM

daniel claimed this task.Aug 21 2019, 12:20 PM

daniel moved this task from Ready (WIP:5) to Doing(WIP:5) on the Platform Team Workboards (Clinic Duty Team) board.Aug 29 2019, 4:24 PM

Change 533271 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Title: make newFromText, isValid, and canExist behave consistently.

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

gerritbot added a project: Patch-For-Review.Aug 29 2019, 5:12 PM

daniel moved this task from Doing(WIP:5) to Waiting for Review on the Platform Team Workboards (Clinic Duty Team) board.Aug 29 2019, 5:13 PM

daniel moved this task from Waiting for Review to Doing(WIP:5) on the Platform Team Workboards (Clinic Duty Team) board.Aug 30 2019, 11:06 AM

• WDoranWMF moved this task from Doing(WIP:5) to Waiting for Review on the Platform Team Workboards (Clinic Duty Team) board.Sep 16 2019, 1:54 PM