Maniphest T302065

{item_id}
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	Feb 18 2022, 10:55 AM

Description

See Gerrit patch 770444 for the error response specifications

code is a symbolic category of errors
message is a human readable error message

BDD
WHEN I request GET /entities/items/{item_id} with ID of item that does not exist
THEN I get 404 HTTP response
AND it contains a item-not-found code and a message "Could not find an item with the ID {item_id}"
AND a HTTP header Content-Language set to en

BDD
WHEN I request GET /entities/items/{item_id} with a text which is not an item ID
THEN I get 400 HTTP response
AND it contains a invalid-item-id code and a message "Not a valid item ID: {item_id}"
AND a HTTP header Content-Language set to en

BDD
WHEN I request GET /entities/items/{item_id} with a valid item ID
AND a generic server or database error occurs
THEN I get 500 HTTP response
AND it contains a unexpected-error code and a message "Unexpected Error"
AND a HTTP header Content-Language set to en

Not included in this story

internationalized/translated error message via Accept-Language HTTP header

Note:

using the built-in error mechanism from MediaWiki REST API is fine as long as the specification is met

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
REST: GetItemJsonPresenter to return JSON string	mediawiki/extensions/Wikibase	master	+41 -51
REST: Update GetItemResult for success and failure	mediawiki/extensions/Wikibase	master	+71 -12
REST: Added specs for GET /entities/items/item_id errors	mediawiki/extensions/Wikibase	master	+56 -2

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T335067 Epic: Wikidata Query Service stabilization
Resolved	Lydia_Pintscher	T314503 rollout of the new Wikibase REST API to Wikidata
Resolved	Ifrahkhanyaree_WMDE	T301859 Provide item data from Wikibase REST API
Resolved	WMDE-leszek	T302065 🟦 Handle errors in GET /entities/items/{item_id}
Resolved	WMDE-leszek	T303914 🟦 Create 404 error response for non existing item IDs in GET /entities/items/{item_id}
Resolved	WMDE-leszek	T303915 🟦 Create 500 error response on exceptions in GET /entities/items/{item_id}
Resolved	WMDE-leszek	T303918 🟦 Create a 400 HTTP response for invalid item IDs
Resolved	Silvan_WMDE	T304094 🟦 Add OpenAPI spec validation tests for error responses
Resolved	WMDE-leszek	T304305 Create an error presenter

Event Timeline

WMDE-leszek created this task.Feb 18 2022, 10:55 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 18 2022, 10:55 AM

WMDE-leszek added a parent task: T301859: Provide item data from Wikibase REST API.Feb 21 2022, 9:41 AM

WMDE-leszek mentioned this in T302054: 🟪 Create a simple implementation of GET /entities/items/{item_id}.Feb 21 2022, 11:16 AM

WMDE-leszek updated the task description. (Show Details)Mar 3 2022, 8:59 AM

WMDE-leszek updated the task description. (Show Details)Mar 3 2022, 1:22 PM

Silvan_WMDE updated the task description. (Show Details)Mar 3 2022, 2:46 PM

Silvan_WMDE set the point value for this task to 5.

Change 770444 had a related patch set uploaded (by WMDE-leszek; author: WMDE-leszek):

[mediawiki/extensions/Wikibase@master] REST: Added specs for GET /entities/items/item_id errors

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

gerritbot added a project: Patch-For-Review.Mar 14 2022, 8:27 AM

WMDE-leszek moved this task from Backlog to Sprint 2 on the Wikibase Product Platform (v1) board.Mar 14 2022, 1:14 PM

WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 2); removed Wikibase Product Platform (v1).

Silvan_WMDE renamed this task from Handle incorrect input in GET /entities/items/{item_id} to Handle errors in GET /entities/items/{item_id}.Mar 14 2022, 1:27 PM

Task Breakdown Notes

T303914: 🟦 Create 404 error response for non existing item IDs in GET /entities/items/{item_id}

return null from WikibaseEntityLookupItemRevisionRetriever in case no entity revision can be found for a given ID
if item revision is null, then an error result (with isSuccessful() == false) will be returned from the GetItem use case
the RouteHandler will create an error response (set http status, code, message) based on the GetItemResult

T303918: 🟦 Create a 400 HTTP response for invalid item IDs

create a Validator on the "use case level" that will check the item ID from the request and return a ValidatioResult object
if the ValdationResult has violations, an error result (with isSuccessful() == false) will be returned from the GetItem use case
the RouteHandler will create an error response (set http status, code, message) based on the GetItemResult

T303915: 🟦 Create 500 error response on exceptions in GET /entities/items/{item_id}

catch exceptions in the use case and return an error result (with isSuccessful() == false)
the RouteHandler will create an error response (set http status, code, message) based on the GetItemResult

Silvan_WMDE updated the task description. (Show Details)Mar 15 2022, 12:19 PM

Ollie.Shotton_WMDE renamed this task from Handle errors in GET /entities/items/{item_id} to 🟦 Handle errors in GET /entities/items/{item_id}.Mar 16 2022, 8:47 AM

Change 771344 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@master] REST: Update GetItemResult for success and failure results

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

Change 771383 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@master] REST: GetItemJsonPresenter return a JSON string instead of a JSON encodable array

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

@Silvan_WMDE @Ollie.Shotton_WMDE @Jakob_WMDE note that I've changed the expected error code and messages based on a recent discussion.

Ollie.Shotton_WMDE updated the task description. (Show Details)Mar 18 2022, 9:51 AM

Change 770444 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Added specs for GET /entities/items/item_id errors

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

Change 771344 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Update GetItemResult for success and failure

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.1; 2022-03-21-early).Mar 18 2022, 3:00 PM

Change 771383 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: GetItemJsonPresenter to return JSON string

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

Silvan_WMDE closed subtask T304094: 🟦 Add OpenAPI spec validation tests for error responses as Resolved.Mar 24 2022, 9:22 AM

Silvan_WMDE moved this task from To Do to Product Verification on the Wikibase Product Platform (v1) (Sprint 2) board.Mar 24 2022, 1:30 PM

Works as expected, thank you!

I've discovered two glitches to (possibly) follow up on:

item-not-found case's error message could use a colon. Was missing from the BDD desccription (was included in the OpenAPI specification however!) so not blocking this. Fixed in: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/773552
Potentially it would be intended to have a consistent code and message keys also used in the errors when no ID is provided, which is currently caught by the mediawiki rest api "framework". This has not be covered in the specification, so again, not a problem to consider this done. For example see: https://wikidata.beta.wmflabs.org/w/rest.php/wikibase/v0/entities/items/. I will create a dedicated task for it if I find it a necessary change.