Page MenuHomePhabricator
Create Task
Maniphest T313495

Concise API call to figure out the reviewed status of a page
Closed, ResolvedPublicFeature
Actions

Description

Feature summary
For a wiki using PageTriage, it is complicated to figure out if a page is reviewed. The algorithm is basically to SQL query the pagetriage_page table, see if your page_id is in there, then read the ptrp_status field, which can have a value of 0, 1, 2, or 3. Your page not being in the table and getting no result at all is also a frequent occurrence. So 1, 2, 3, or missing is basically "reviewed", and 0 is "unreviewed".

This logic should be moved to an API call, so our developers don't need to implement this logic themselves.

Benefits (why should this be implemented?):

  • Less cognitive load on programmers
  • More concise code for programmers

Acceptance criteria

  • Should take title (namespace:title) or pageid, like the query API does
  • Should return isReviewed: true/false, or throw a "page does not exist" type error, or a "not a namespace pagetriage patrols" error

After code review, instead of making a new API, may be best to add this to query->prop.

Details

SubjectRepoBranchLines +/-
add ?action=query&prop=isreviewed to APImediawiki/extensions/PageTriagemaster+314 -3
Refactor ApiIsReviewed to use injectionmediawiki/extensions/PageTriagemaster+31 -14
Concise API call to figure out the reviewed status of a pagemediawiki/extensions/PageTriagemaster+153 -6
Customize query in gerrit

Event Timeline

Novem_Linguae created this task.Jul 21 2022, 12:23 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptJul 21 2022, 12:23 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Novem_Linguae moved this task from Backlog to Soon on the PageTriage board.Jul 21 2022, 12:23 PM
TheresNoTime awarded a token.Jul 21 2022, 12:23 PM
Novem_Linguae updated the task description. (Show Details)Jul 21 2022, 12:25 PM
TheresNoTime subscribed.EditedJul 21 2022, 1:08 PM

(only now noticed you wrote most of that @Novem_Linguae 😅)

I saw this and thought "great idea!", but a vague memory was telling me this already exists — and it does! 😄

Call api.php?action=pagetriagelist&format=json&page_id=70233586 for example and get:

{
    "pagetriagelist": {
        "result": "success",
        "pages_missing_metadata": [],
        "pages": [
            {
                "pageid": 70233586,
                "linkcount": "6",
                "creation_date": "20220305110659",
                "patrol_status": "0",
                "is_redirect": "0",
                "ptrp_last_reviewed_by": "0",
                "ptrp_reviewed_updated": "20220305110659",
                "reviewer": null,
                "title": "Moscow Automobile and Road Construction State Technical University",
                "category_count": "15",
                "csd_status": "0",
                "prod_status": "0",
                "blp_prod_status": "0",
                "afd_status": "0",
                "rev_count": "13",
                "page_len": "4945",
                "snippet": "Moscow Automobile and Road Construction State Technical University () is a public university located in Moscow, Russia. It was founded in 1930. History The Moscow State Automobile and Road Technical University (MADI) was established by a decree of the...",
                "user_name": "GronGronsky",
                "user_editcount": "506",
                "user_creation_date": "20210125150823",
                "user_autoconfirmed": "1",
                "user_bot": "0",
                "user_block_status": "0",
                "user_id": "41067402",
                "reference": "1",
                "user_experience": "experienced",
                "afc_state": "1",
                "copyvio": "",
                "recreated": "",
                "creation_date_utc": "20220305110659",
                "creator_user_page": "User:GronGronsky",
                "creator_user_page_url": "//en.wikipedia.org/wiki/User:GronGronsky",
                "creator_user_page_exist": true,
                "creator_user_talk_page": "User talk:GronGronsky",
                "creator_user_talk_page_url": "//en.wikipedia.org/wiki/User_talk:GronGronsky",
                "creator_user_talk_page_exist": true,
                "creator_contribution_page": "Special:Contributions/GronGronsky",
                "creator_contribution_page_url": "//en.wikipedia.org/wiki/Special:Contributions/GronGronsky",
                "talk_page_title": "Talk:Moscow Automobile and Road Construction State Technical University",
                "talkpage_feedback_count": 0,
                "talk_page_url": "https://en.wikipedia.org/wiki/Talk:Moscow_Automobile_and_Road_Construction_State_Technical_University",
                "ores_articlequality": "Start",
                "ores_draftquality": ""
            }
        ]
    }
}
Novem_Linguae added a comment.Jul 21 2022, 1:18 PM

I was thinking of implementing it as a new PageTriage API that just takes a page_id and outputs isReviewed true/false. Or maybe a hook into some other API that fetches pages, if that kind of API hooking capability exists. One problem with using pagetriagelist is that it will often return no rows, and then the end user is left confused about whether the page is reviewed or not (counter-intuitively, no rows = reviewed).

Here is how I currently do it in JavaScript. Having help on the API side would let us get rid of all the conditional logic at the bottom there.

	async function isReviewed(pageID) {
		let api = new mw.Api();
		let response = await api.get( {
			action: 'pagetriagelist',
			format: 'json',
			page_id: pageID,
		} );

		// no result
		if ( response.pagetriagelist.result !== 'success' || response.pagetriagelist.pages.length === 0 ) {
			return true;
		// 1, 2, or 3
		} else if ( parseInt(response.pagetriagelist.pages[0].patrol_status) > 0 ) {
			return true;
		// 0
		} else {
			return false;
		}
	}
TheresNoTime added a comment.Jul 21 2022, 1:40 PM

For what it's worth, you can trim that down to

// no result
if ( response.pagetriagelist.result !== 'success' || response.pagetriagelist.pages.length === 0 ) {
    return true;
} else {
    // Convert the patrol_status to a boolean — 0 is falsy and >0 truthy
    return Boolean( parseInt( response.pagetriagelist.pages[0].patrol_status ) );
}
Tgr moved this task from Inbox to Triaged on the Growth-Team board.Jul 27 2022, 3:28 AM
Novem_Linguae moved this task from Soon to Priority small features on the PageTriage board.Nov 10 2022, 2:28 AM
Novem_Linguae updated the task description. (Show Details)Nov 15 2022, 2:35 PM
Novem_Linguae updated the task description. (Show Details)Nov 15 2022, 3:16 PM
Novem_Linguae updated the task description. (Show Details)Nov 26 2022, 9:14 PM
Novem_Linguae updated the task description. (Show Details)Nov 26 2022, 9:22 PM
gerritbot added a comment.Nov 27 2022, 5:15 PM

Change 860984 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/PageTriage@master] Concise API call to figure out the reviewed status of a page

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

gerritbot added a project: Patch-For-Review.Nov 27 2022, 5:15 PM
MPGuy2824 moved this task from Priority small features to Code Review on the PageTriage board.Nov 29 2022, 10:15 AM
gerritbot added a comment.Apr 20 2023, 9:20 AM

Change 860984 abandoned by Novem Linguae:

[mediawiki/extensions/PageTriage@master] Concise API call to figure out the reviewed status of a page

Reason:

Sounds like this should be in API:Query+prop instead of its own API. See code review comment.

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

Novem_Linguae updated the task description. (Show Details)Apr 20 2023, 9:22 AM
Maintenance_bot removed a project: Patch-For-Review.Apr 20 2023, 9:29 AM
MPGuy2824 moved this task from Code Review to Priority small features on the PageTriage board.Apr 28 2023, 10:52 AM
gerritbot added a comment.Jul 27 2023, 10:38 AM

Change 942386 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/PageTriage@master] [WIP] add ?action=query&prop=isreviewed to API

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

gerritbot added a project: Patch-For-Review.Jul 27 2023, 10:38 AM
jsn.sherman awarded a token.Jul 29 2023, 1:44 PM
jsn.sherman subscribed.
PatchDemoBot added a comment.Jul 31 2023, 12:18 PM

Test wiki created on Patch demo by TheresNoTime using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/c6a18892b9/w

PatchDemoBot added a comment.Jul 31 2023, 12:21 PM

Test wiki on Patch demo by TheresNoTime using patch(es) linked to this task was deleted:

https://patchdemo.wmflabs.org/wikis/c6a18892b9/w/

gerritbot added a comment.Jul 31 2023, 12:38 PM

Change 942386 merged by jenkins-bot:

[mediawiki/extensions/PageTriage@master] add ?action=query&prop=isreviewed to API

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.20; 2023-08-01).Jul 31 2023, 1:00 PM
Maintenance_bot removed a project: Patch-For-Review.Jul 31 2023, 1:11 PM
Novem_Linguae moved this task from Priority small features to Waiting for enwiki deploy on the PageTriage board.Jul 31 2023, 1:11 PM
gerritbot added a comment.Jul 31 2023, 4:30 PM

Change 943613 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/PageTriage@master] refactor ApiIsReviewed to use injection

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

gerritbot added a project: Patch-For-Review.Jul 31 2023, 4:30 PM
Novem_Linguae claimed this task.Aug 1 2023, 1:52 AM
gerritbot added a comment.Aug 1 2023, 5:47 AM

Change 943613 merged by jenkins-bot:

[mediawiki/extensions/PageTriage@master] Refactor ApiIsReviewed to use injection

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

ReleaseTaggerBot edited projects, added MW-1.41-notes (1.41.0-wmf.22; 2023-08-15); removed MW-1.41-notes (1.41.0-wmf.20; 2023-08-01).Aug 1 2023, 6:00 AM
Maintenance_bot removed a project: Patch-For-Review.Aug 1 2023, 6:10 AM
Novem_Linguae closed this task as Resolved.Aug 29 2023, 2:44 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits