🥦️ Handle conditional http headers in Wikibase REST API
Closed, ResolvedPublic8 Estimated Story Points
Actions

Assigned To

Authored By

	Jakob_WMDE
	Sep 21 2022, 10:31 AM

Description

Handle requests according to RFC 9110.
Cross check against https://docs.google.com/spreadsheets/d/1GzJAnv1g16ERDpLONmdFlkwsSIxc5Dw9w4xKCtUV_ho/edit#gid=20371120

Spec parameter descriptions

If-None-Match: Conditionally perform the request only if the resource has been modified since the specified entity revision numbers
If-Match: Conditionally perform the request only if the resource has not been modified since one of the specified entity revision numbers
If-Modified-Since: Conditionally perform the request only if the resource has been modified after the specified date
If-Unmodified-Since: Conditionally perform the request only if the resource has not been modified after the specified date

Note:

existing functionality is mostly correct except for the POST endpoint as seen in the spreadsheet
If-Match and If-Unmodified-Since on GET endpoints may also be incorrect
All combinations of conditional header and HTTP method to be covered in the specification and autodocs (i.e. even the less clear use cases)

Details

	Subject	Repo	Branch	Lines +/-
	REST: Make header descriptions more generic	mediawiki/extensions/Wikibase	master	+4 -4

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	WMDE-leszek	T318221 🥦️ Handle conditional http headers in Wikibase REST API
Resolved	Jakob_WMDE	T318715 🥦️ Cross check "What we want" table against RFC 9110
Resolved	Silvan_WMDE	T318716 🥦️ Handle `If-Match` header for GET requests
Resolved	Ollie.Shotton_WMDE	T318717 🥦️ Add missing conditional headers and corresponding responses to OAS definition for GET requests
Resolved	Ollie.Shotton_WMDE	T318719 🥦️ Add e2e-tests for missing conditional headers in "EDIT" requests
Resolved	Jakob_WMDE	T318791 🥦️ Ensure consistent handling of conditional request headers in AddItemStatementRouteHandler
Invalid	None	T318792 🥦️ Handle `If-Modified-Since` header for edit requests
Resolved	Ollie.Shotton_WMDE	T318793 🥦️ Add missing conditional headers and corresponding responses to OAS definition for edit requests
Resolved	Jakob_WMDE	T318795 🥦️ Handle If-None-Match: * for edit requests
Resolved	Ollie.Shotton_WMDE	T318796 🥦️ Handle `If-Unmodified-Since` header for get requests
Resolved	Jakob_WMDE	T318797 🥦️ Add e2e-tests for missing conditional headers in get requests
Resolved	Jakob_WMDE	T319382 🥦️ Submit upstream patch for ConditionalHeaderUtil If-None-Match wildcard handling

Event Timeline

Jakob_WMDE created this task.Sep 21 2022, 10:31 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 21 2022, 10:31 AM

Jakob_WMDE set the point value for this task to 8.Sep 21 2022, 10:31 AM

Jakob_WMDE moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.

WMDE-leszek mentioned this in T314134: Consider responding to non-POST requests providing If-None-Match, If-Modified-Since headers.Sep 21 2022, 11:10 AM

WMDE-leszek added a project: Story.Sep 27 2022, 9:03 AM

WMDE-leszek moved this task from Next to Sprint 14 on the Wikibase Product Platform (v1) board.Sep 27 2022, 10:04 AM

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

WMDE-leszek updated the task description. (Show Details)

WMDE-leszek subscribed.

Task Breakdown notes:

T318715: 🥦️ Cross check "What we want" table against RFC 9110
T318791: 🥦️ Ensure consistent handling of conditional request headers in AddItemStatementRouteHandler
- Change OAS definition according to the "What we want" table (B24, E24-G24 and J24/K24)
- Override checkPreconfditions()
- Add conditional request middleware to the AddItemStatementRouteHandler
- Add schema tests
T318795: 🥦️ Handle If-None-Match: * for edit requests
- Change OAS definition according to the "What we want" table (D24-D27)
- try to fix it in the MediaWiki framework ConditionalHeaderUtils, get feedback from owners
- at the same time, fix it in the PreconditionMiddleware on our side
T318716: 🥦️ Handle `If-Match` header for GET requests
- Change OAS definition according to the "What we want" table (E18-E21 and G18-G21)
- Change the PreconditionCheck to trigger status code 200 instead of 412 if the If-Match header condition is met
T318792: 🥦️ Handle `If-Modified-Since` header for edit requests
- Change OAS definition according to the "What we want" table (H24-H27)
- Change the PreconditionCheck to trigger status code 412 instead of 2xx if the If-Modified-Since header condition is not met
T318796: 🥦️ Handle `If-Unmodified-Since` header for get requests
- Change OAS definition according to the "What we want" table (J18-J21)
- Change the PreconditionCheck to trigger status code 2xx instead of 412 if the If-Unmodified-Since header condition is met
T318717: 🥦️ Add missing conditional headers and corresponding responses to OAS definition for GET requests
T318793: 🥦️ Add missing conditional headers and corresponding responses to OAS definition for edit requests
T318797: 🥦️ Add e2e-tests for missing conditional headers in get requests
T318719: 🥦️ Add e2e-tests for missing conditional headers in "EDIT" requests

Silvan_WMDE renamed this task from Handle conditional http headers in Wikibase REST API to 🥦️ Handle conditional http headers in Wikibase REST API.Sep 27 2022, 2:04 PM

WMDE-leszek updated the task description. (Show Details)Sep 27 2022, 8:38 PM

Jakob_WMDE closed subtask T318792: 🥦️ Handle `If-Modified-Since` header for edit requests as Invalid.Sep 28 2022, 4:11 PM

Silvan_WMDE updated the task description. (Show Details)Sep 30 2022, 9:32 AM

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

[mediawiki/extensions/Wikibase@master] REST: Make header descriptions more generic

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

gerritbot added a project: Patch-For-Review.Sep 30 2022, 10:00 AM

Change 837081 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Make header descriptions more generic

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

Maintenance_bot removed a project: Patch-For-Review.Sep 30 2022, 11:30 AM

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.4; 2022-10-03).Sep 30 2022, 12:00 PM