refactor(PagePatroller): add query cache (qiuwenbaike#1688)

* refactor(PagePatroller): add query cache

Author: WaitSpringQW

dist/PagePatroller/PagePatroller.js

@@ -1,4 +1,4 @@
-import {pagePatroller} from './modules/core';
+import {pagePatroller} from './modules/pagePatroller';
 
 const {wgNamespaceNumber, wgArticleId, wgIsMainPage} = mw.config.get();
 

src/PagePatroller/PagePatroller.ts

@@ -1,7 +1,7 @@
 import * as OPTIONS from '../options.json';
-import {elementWrap, errorMessage, loading, notBeenPatrolledYet, patrolled, patrolledBy} from './elementWrap';
-import {api} from './api';
-import {replaceChild} from './replaceChild';
+import {elementWrap, errorMessage, loading, notBeenPatrolledYet, patrolled, patrolledBy} from './util/elementWrap';
+import {getPatroller} from './util/getPatroller';
+import {replaceChild} from './util/replaceChild';
 
 const pagePatroller = async (): Promise<void> => {
 	const element = elementWrap();
@@ -20,39 +20,10 @@ const pagePatroller = async (): Promise<void> => {
 	const {wgPageName} = mw.config.get();
 
 	try {
-		const params: ApiQueryRevisionsParams & ApiQueryLogEventsParams = {
-			action: 'query',
-			format: 'json',
-			formatversion: '2',
-			prop: 'revisions',
-			titles: wgPageName,
-			list: 'logevents',
-			letype: 'patrol',
-			letitle: wgPageName,
-			rvprop: 'timestamp',
-			rvlimit: 1,
-			rvdir: 'newer',
-			smaxage: 600,
-			maxage: 600,
-		};
-		const {query} = await api.get(params);
+		const log = await getPatroller(wgPageName);
+		const {action, user, timestamp} = log;
 
-		if (query?.logevents && query.logevents.length) {
-			const [log]: [
-				{
-					user: string;
-					timestamp: string;
-					action: string;
-				},
-			] = query.logevents as [
-				{
-					user: string;
-					timestamp: string;
-					action: string;
-				},
-			];
-			const {action, user} = log;
-			const {timestamp} = log;
+		if (action && user && timestamp) {
 			const date: Date = new Date(timestamp);
 
 			if (action === 'patrol') {

src/PagePatroller/modules/core.ts …c/PagePatroller/modules/pagePatroller.tssrc/PagePatroller/modules/core.ts renamed to src/PagePatroller/modules/pagePatroller.ts src/PagePatroller/modules/core.ts renamed to src/PagePatroller/modules/pagePatroller.ts

@@ -1,6 +1,6 @@
-import * as OPTIONS from '../options.json';
+import * as OPTIONS from '../../options.json';
 import React from 'ext.gadget.React';
-import {getMessage} from './i18n';
+import {getMessage} from '../i18n';
 
 const elementWrap = () => {
 	const {skin} = mw.config.get();

src/PagePatroller/modules/elementWrap.tsx …gePatroller/modules/util/elementWrap.tsxsrc/PagePatroller/modules/elementWrap.tsx renamed to src/PagePatroller/modules/util/elementWrap.tsx src/PagePatroller/modules/elementWrap.tsx renamed to src/PagePatroller/modules/util/elementWrap.tsx

@@ -0,0 +1,64 @@
+import * as OPTIONS from '../../options.json';
+import {api} from '../api';
+
+const getPatroller = async (wgPageName: string) => {
+	let action: string | undefined;
+	let user: string | undefined;
+	let timestamp: string | undefined;
+
+	if (mw.storage.getObject(OPTIONS.storageKey + wgPageName)) {
+		({action, user, timestamp} = mw.storage.getObject(OPTIONS.storageKey + wgPageName) as {
+			action: string;
+			user: string;
+			timestamp: string;
+		});
+	} else {
+		try {
+			const params: ApiQueryRevisionsParams & ApiQueryLogEventsParams = {
+				action: 'query',
+				format: 'json',
+				formatversion: '2',
+				prop: 'revisions',
+				titles: wgPageName,
+				list: 'logevents',
+				letype: 'patrol',
+				letitle: wgPageName,
+				rvprop: 'timestamp',
+				rvlimit: 1,
+				rvdir: 'newer',
+				smaxage: 600,
+				maxage: 600,
+			};
+			const {query} = await api.get(params);
+
+			if (query?.logevents && query.logevents.length) {
+				const [log]: [
+					{
+						user: string;
+						timestamp: string;
+						action: string;
+					},
+				] = query.logevents as [
+					{
+						user: string;
+						timestamp: string;
+						action: string;
+					},
+				];
+				({action} = log);
+
+				if (action === 'patrol') {
+					({user, timestamp} = log);
+
+					mw.storage.setObject(OPTIONS.storageKey + wgPageName, {action, user, timestamp}, 60 * 60 * 24 * 30);
+				}
+			}
+		} catch (error: unknown) {
+			console.error('[PagePatroller] Ajax error in `getPatroller` method:', error);
+		}
+	}
+
+	return {action, user, timestamp};
+};
+
+export {getPatroller};

src/PagePatroller/modules/util/getPatroller.ts

@@ -1,5 +1,6 @@
 {
 	"elementId": "footer-info-patroller",
 	"mountPointSelector": "#footer-info,.page-info",
+	"storageKey": "ext.gadget.PagePatroller_getPatroller-",
 	"version": "3.0"
 }