As a Watchlist Expiry user, I want expiry parameters enabled when adding items to the watchlist via the API, so the feature can be accessed via the API.
Background: This ticket is for back-end work only.
Acceptance Criteria:
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Add release notes for recently-merged watchlist expiry work | mediawiki/core | master | +14 -0 | |
| ApiWatch: Add support for expiries | mediawiki/core | master | +208 -18 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | MusikAnimal | T245078 Watchlist expiry API: Add a expiry parameter when adding an item to the watchlist [medium] | |||
| Resolved | MusikAnimal | T245213 Update core watchlist code to support expiries |
Change 572107 had a related patch set uploaded (by MusikAnimal; owner: MusikAnimal):
[mediawiki/core@master] [WIP] Introduce an expiry to WatchlistItem
I'm going to stop here and ask for feedback on my approach.
The biggest problem I see is that we're doing a multi-insert into the watchlist table, but we need the generated wl_ids in order to update watchlist_expiry. So, I guess we have to either switch to single inserts (and I think get the wl_id with Database::insertId()) or manually fetch the IDs before updating watchlist_expiry, maybe in a deferred update?
Other to-dos:
This is a good question. My first instinct would be to do single inserts inside a database transaction.
I'll take a look at the code and see if something else jumps out.
Change 580522 had a related patch set uploaded (by MusikAnimal; owner: MusikAnimal):
[mediawiki/core@master] [WIP] Add expiry support to Watch API
Change 580522 merged by jenkins-bot:
[mediawiki/core@master] ApiWatch: Add support for expiries
Change 583513 had a related patch set uploaded (by Samwilson; owner: Samwilson):
[mediawiki/core@master] Add release notes for recently-merged watchlist expiry work
When using the Watch API:
The API response looks something like, showing the expiry time for the watched item:
{'batchcomplete': '', 'watch': [{'title': 'Foobar', 'ns': 0, 'expiry': '2020-03-30T14:44:32Z', 'watched': ''}]}
You can watch an item with a different expiry time, modifying the expiry time in the DB. If the expiry time is "infinite", the expiry is removed from the database.
Unwatching an item also removes the expiry from the DB, before and after it has expired.
You can also use generators to, for example, set the expiry time of all(?) the user's watched items to 1 minute, e.g. https://en.wikipedia.beta.wmflabs.org/wiki/Special:ApiSandbox#action=watch&format=json&expiry=1%20minute&generator=watchlistraw
Change 583513 merged by jenkins-bot:
[mediawiki/core@master] Add release notes for recently-merged watchlist expiry work
The work has been deployed. There is nothing directly user-facing to test here, and the changes have been tested by Dom. For this reason, I'm marking it as Done.