Maniphest T100262

[SPIKE] Which API requests should be cached and for how long?
Closed, DeclinedPublic
Actions

Description

In API requests we can specify a cache time for queries that are unlikely to change.
You can do this by adding parameters to the API request.

Define in seconds
maxage (tells client to cache for a period in seconds)
smaxage (tells varnish to cache for a period in seconds)

Acceptance Criteria

Review all the uses of the API in Reading's extensions and determine if any would benefit from this
Create a Phabricator task to track doing suggested changes
Notify iOS and Android teams of any results as they should also benefit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Declined		None	T125920 [EPIC] Future exciting reading web performance endeavours
		Declined		None	T100262 [SPIKE] Which API requests should be cached and for how long?

Event Timeline

Jdlrobson created this task.May 25 2015, 8:29 AM

Jdlrobson raised the priority of this task from to Needs Triage.

Jdlrobson updated the task description. (Show Details)

Jdlrobson added projects: Epic, Performance Issue, Readers-Web-Backlog, Mobile-Apps.

Jdlrobson added subscribers: Mholloway, Ricordisamoa, He7d3r and 7 others.

Krinkle added a subscriber: Krinkle.May 25 2015, 9:49 AM

phuedx moved this task from Incoming to 2014-15 Q4 on the Readers-Web-Backlog board.Jun 1 2015, 10:11 AM

See also T97096.

jeremyb added a subscriber: Pharos.Aug 11 2015, 9:59 PM

jeremyb added a subscriber: jeremyb.

Is there anything concrete we want to do with this? I quite not understand the description (seems to state an existing feature, but I can't see work to be done).

Help @Jdlrobson?

Dbrant added a subscriber: Dbrant.Aug 14 2015, 1:32 PM

Jhernandez triaged this task as Medium priority.Aug 17 2015, 11:19 AM

Jhernandez edited projects, added MobileFrontend; removed Readers-Web-Backlog.Aug 17 2015, 11:25 AM

Jdlrobson removed a project: Epic.Dec 22 2015, 10:18 PM

Jdlrobson set Security to None.

bd808 added a project: Phlogiston-Category.Dec 22 2015, 10:19 PM

Jdlrobson renamed this task from API requests should be cached to Spike: API requests should be cached.Jan 11 2016, 9:41 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson removed a project: Phlogiston-Category.

Jdlrobson removed a parent task: T98986: [EPIC] Improve the status quo of mobile web performance.

Jdlrobson added a parent task: T113066: [GOAL] Make Wikipedia more accessible to 2G connections.Jan 11 2016, 9:47 PM

Jdlrobson merged a task: T122613: [SPIKE] Investigate further optimisations for RelatedArticles API query.

Jdlrobson added subscribers: StudiesWorld, • bearND, ori and 7 others.

See also T122867.

phuedx renamed this task from Spike: API requests should be cached to [SPIKE] Which API requests should be cached and for how long?.Jan 11 2016, 10:52 PM

phuedx updated the task description. (Show Details)

• Mattflaschen-WMF removed a subscriber: • Mattflaschen-WMF.Jan 12 2016, 3:47 AM

Jdlrobson added a parent task: T125920: [EPIC] Future exciting reading web performance endeavours.Mar 10 2016, 10:28 PM

Jdlrobson removed a parent task: T113066: [GOAL] Make Wikipedia more accessible to 2G connections.

MBinder_WMF added a project: Readers-Web-Backlog.Apr 27 2016, 4:19 PM

Jdlrobson moved this task from 2014-15 Q4 to Incoming on the Readers-Web-Backlog board.Apr 27 2016, 4:34 PM

Mholloway moved this task from Backlog to Tracking on the Mobile-Apps board.Jun 3 2016, 3:02 AM

Danny_B added a project: Spike.Jul 5 2016, 6:39 PM

Jhernandez raised the priority of this task from Medium to High.Jul 27 2016, 4:44 PM

Jhernandez moved this task from Incoming to Triaged but Future on the Readers-Web-Backlog board.

The apis we tend to use in MobileFrotend are logged in only or cannot be cached (eg. edits)
Maybe language and search could benefit.

ovasileva lowered the priority of this task from High to Medium.Feb 6 2017, 8:15 PM

The only extensions that we own that use API are...

MobileFrontend we use mediawiki api for the following:

Search
References
Editing
Nearby (NearbyGateway)
Watchlist
Categories
To list a user's uploads (using PhotoListGateway)

I don't think any of these would benefit given they are likely to be hit by the same user infrequently.
Many of the APIs benefit from getting freshest content (for example WatchlistGateway and NearbyGateway). A case could be made that both of these would benefit from using maxage, but I'm not seeing any pressing need to.

Related Articles

morelike api (already uses maxage)

Page previews (we're using REST)