media returns 500 error when more than 100 media files present
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	santhosh
	Oct 11 2020, 6:05 AM

Description

/page/{title}/links/media returns 500 error when more than 100 media files present, but as per documentation at https://www.mediawiki.org/wiki/API:REST_API/Reference#Get_files_on_page, 500 error is supposed to happen if the page has more than 500 media files.

The following examples illustrate the issue:
https://en.wikipedia.org/w/rest.php/v1/page/Barcelona/links/media
https://en.wikipedia.org/w/rest.php/v1/page/India/links/media

{"messageTranslations":{"en":"Too many media links found on title India (100 allowed)"},"httpCode":500,"httpReason":"Internal Server Error"}

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Change error code for rest-media-too-many-links	mediawiki/core	master	+34 -4
	Change error code for rest-media-too-many-links	mediawiki/core	master	+1 -1

Customize query in gerrit

Related Objects

Mentioned In: T305389: Investigate pagination in the REST API

Event Timeline

santhosh created this task.Oct 11 2020, 6:05 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 11 2020, 6:05 AM

DannyS712 added a project: MediaWiki-REST-API.Oct 11 2020, 7:34 AM

DannyS712 changed the subtype of this task from "Task" to "Bug Report".

subins2000 subscribed.Oct 11 2020, 8:53 AM

Reedy added a project: Performance Issue.Oct 11 2020, 4:55 PM

Reedy added a project: Wikimedia-production-error.

• Krinkle moved this task from Untriaged to Oct 2020 on the Wikimedia-production-error board.Oct 23 2020, 9:11 PM

• Krinkle added a project: Platform Engineering.

Since 100 is the limit defined in the code, I've updated the documentation accordingly.

500 is clearly not a correct status code. 500 indicates an unknown server error, here it's a very much a known error - we were lazy and didn't implement pagination.

If we want to continue being lazy and not adding pagination, we can maybe at least return 501 Not implemented, it would be much less confusing.

• AMooney triaged this task as Medium priority.Nov 10 2020, 9:27 PM

• AMooney edited projects, added Platform Team Workboards (Green); removed Platform Engineering.

In T265204#6575588, @Pchelolo wrote:

If we want to continue being lazy and not adding pagination, we can maybe at least return 501 Not implemented, it would be much less confusing.

Indeed. Or 507 (insufficient memory).

Any 50x error will result in this task being reported and/or re-opened as that indicates a fault in a service we run. If users aren't meant to ask for this information, or we refuse to support providing it, then that seems like a client error, and thus 40x, and thus cacheable by the CDN and not a risk to backend floods.

404 would be fairly generic, but an improvement over the status quo and mitigate the raised error levels and production risk, and thus resolve this task.

Daimona mentioned this in T305389: Investigate pagination in the REST API.Apr 4 2022, 6:35 PM

Daimona subscribed.

• Krinkle moved this task from Oct 2020 to Older on the Wikimedia-production-error board.Sep 8 2022, 4:21 PM

• Krinkle edited projects, added API Platform; removed Platform Team Workboards (Green), Core Platform Team Initiatives (MW REST API in PHP).Aug 18 2023, 7:31 PM

• FGoodwin claimed this task.Sep 19 2023, 9:42 PM

Change 959065 had a related patch set uploaded (by Fgoodwin; author: Fgoodwin):

[mediawiki/core@master] Change error code for rest-media-too-many-links

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

gerritbot added a project: Patch-For-Review.Sep 19 2023, 10:05 PM

Change 961472 had a related patch set uploaded (by Fgoodwin; author: Fgoodwin):

[mediawiki/core@master] Adds test

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

Change 961472 merged by jenkins-bot:

[mediawiki/core@master] Change error code for rest-media-too-many-links

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

Change 959065 abandoned by BPirkle:

[mediawiki/core@master] Change error code for rest-media-too-many-links

Reason:

Abandoned in favor of https://gerrit.wikimedia.org/r/c/mediawiki/core/+/961472

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

Per discussion in code review, we went with a 400 error if the limit is exceeded.

Marking this as resolved. There is still a TODO in the code for adding pagination, but that change, if we ever do it, can be handled under a separate task.

Maintenance_bot removed a project: Patch-For-Review.Oct 2 2023, 9:30 PM

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.29; 2023-10-03).Oct 2 2023, 10:00 PM

Docs updated here: https://www.mediawiki.org/w/index.php?title=API%3AREST_API%2FReference&diff=6135965&oldid=6001713

/page/{title}/links/media returns 500 error when more than 100 media files presentClosed, ResolvedPublicBUG REPORTActions

Description

Details

Related Objects

Event Timeline

/page/{title}/links/media returns 500 error when more than 100 media files present
Closed, ResolvedPublicBUG REPORT
Actions