refactor(GeoLocationReader, MarkRights*): add query cache (qiuwenbaike#1679)

WaitSpringQW · web-flow · commit 3639be480b48 · 2025-01-27T21:57:24.000+08:00
* refactor(GeoLocationReader, MarkRights*): add query cache
diff --git a/dist/GeoLocationReader/GeoLocationReader.js b/dist/GeoLocationReader/GeoLocationReader.js
diff --git a/dist/MarkRights-Userpage/MarkRights-Userpage.js b/dist/MarkRights-Userpage/MarkRights-Userpage.js
diff --git a/dist/MarkRights/MarkRights.js b/dist/MarkRights/MarkRights.js
diff --git a/dist/definition.txt b/dist/definition.txt
@@ -66,7 +66,7 @@
 * FilterAlteredClicks[ResourceLoader|hidden|requiresES6]|FilterAlteredClicks.js
 * Geo[ResourceLoader|dependencies=mediawiki.storage|hidden|requiresES6]|Geo.js
 * GeoLocation[ResourceLoader|dependencies=ext.gadget.Geo,ext.gadget.i18n,ext.gadget.Util,mediawiki.api|requiresES6]|GeoLocation.js
-* GeoLocationReader[ResourceLoader|default|dependencies=ext.gadget.i18n,ext.gadget.React,ext.gadget.Util,mediawiki.api,mediawiki.Title|namespaces=2|peers=GeoLocationReader-pagestyles|rights=edit|requiresES6]|GeoLocationReader.js
+* GeoLocationReader[ResourceLoader|default|dependencies=ext.gadget.i18n,ext.gadget.MarkRights,ext.gadget.React,ext.gadget.Util,mediawiki.api,mediawiki.Title|namespaces=2|peers=GeoLocationReader-pagestyles|rights=edit|requiresES6]|GeoLocationReader.js
 * GeoLocationReader-pagestyles[ResourceLoader|hidden|requiresES6]|GeoLocationReader-pagestyles.css
 * HistoryDisclaimer[ResourceLoader|default|dependencies=ext.gadget.React|hidden|requiresES6]|HistoryDisclaimer.js|HistoryDisclaimer.css
 * i18n[ResourceLoader|dependencies=ext.gadget.Util|hidden|requiresES6]|i18n.js
diff --git a/src/GeoLocationReader/definition.json b/src/GeoLocationReader/definition.json
@@ -4,7 +4,14 @@
 	"section": "compatibility",
 	"excludeSites": ["loginwiki"],
 	"default": true,
-	"dependencies": ["ext.gadget.i18n", "ext.gadget.React", "ext.gadget.Util", "mediawiki.api", "mediawiki.Title"],
+	"dependencies": [
+		"ext.gadget.i18n",
+		"ext.gadget.MarkRights",
+		"ext.gadget.React",
+		"ext.gadget.Util",
+		"mediawiki.api",
+		"mediawiki.Title"
+	],
 	"namespaces": [2],
 	"peers": ["GeoLocationReader-pagestyles"],
 	"rights": ["edit"]
diff --git a/src/GeoLocationReader/modules/addElement.ts b/src/GeoLocationReader/modules/addElement.ts
@@ -1,38 +1,16 @@
-import {api} from './api';
 import {appendGeoIcon} from './appendGeoIcon';
-
-const queryUserGroups = async (ususers: string) => {
-	const params: ApiQueryUsersParams = {
-		ususers,
-		action: 'query',
-		format: 'json',
-		formatversion: '2',
-		list: 'users',
-		usprop: 'groups',
-		smaxage: 600,
-		maxage: 600,
-	};
-	const response = await api.get(params);
-
-	return response;
-};
+import {getLocalUserGroups} from 'ext.gadget.MarkRights';
 
 const addElement = async (): Promise<void> => {
 	const {wgRelevantUserName} = mw.config.get();
+
+	if (!wgRelevantUserName) {
+		return;
+	}
+
 	try {
-		const {
-			query: {
-				users: [{groups}],
-			},
-		}: {
-			query: {
-				users: [
-					{
-						groups: string[];
-					},
-				];
-			};
-		} = (await queryUserGroups(`${wgRelevantUserName}`)) as never;
+		const groupsMap = await getLocalUserGroups([wgRelevantUserName]);
+		const groups = groupsMap[wgRelevantUserName] ?? [];
 
 		if (groups.includes('bot') || groups.includes('qiuwen')) {
 			/* empty */
diff --git a/src/MarkRights-Userpage/MarkRights-Userpage.ts b/src/MarkRights-Userpage/MarkRights-Userpage.ts
@@ -1,5 +1,5 @@
 import * as OPTIONS from './options.json';
-import {getPermissions} from './modules/core';
+import {getPermissions} from './modules/getPermissions';
 
 (function markRightsUserPage(): void {
 	const {wgAction, wgNamespaceNumber, wgPageName, wgRelevantUserName} = mw.config.get();
diff --git a/src/MarkRights-Userpage/modules/getPermissions.ts b/src/MarkRights-Userpage/modules/getPermissions.ts
@@ -1,38 +1,19 @@
 import {SYSTEM_SCRIPT_LIST, WEBMASTER_LIST} from './constant';
-import {queryGlobalUserGroups, queryUserGroups} from 'ext.gadget.MarkRights';
+import {getGlobalUserGroups, getLocalUserGroups} from 'ext.gadget.MarkRights';
 import type {UserRights} from '~/MarkRights/modules/types';
 import {appendIcon} from './appendIcon';
 import {getMessage} from './i18n';
 import {uniqueArray} from 'ext.gadget.Util';
 
 const getPermissions = async (wgRelevantUserName: string): Promise<void> => {
 	try {
-		const {
-			query: {
-				users: [{groups: localgroups}],
-			},
-		}: {
-			query: {
-				users: [
-					{
-						groups: string[];
-					},
-				];
-			};
-		} = (await queryUserGroups(wgRelevantUserName)) as never;
-		const {
-			query: {
-				globaluserinfo: {groups: globalgroups},
-			},
-		}: {
-			query: {
-				globaluserinfo: {
-					groups: string[];
-				};
-			};
-		} = (await queryGlobalUserGroups(wgRelevantUserName)) as never;
+		const localGroupsMap = await getLocalUserGroups([wgRelevantUserName]);
+		const localGroups = localGroupsMap[wgRelevantUserName] ?? [];
 
-		const groups = uniqueArray([...localgroups, ...globalgroups]).filter((element) => {
+		const globalGroupsMap = await getGlobalUserGroups([wgRelevantUserName]);
+		const globalGroups = globalGroupsMap[wgRelevantUserName] ?? [];
+
+		const groups = uniqueArray([...localGroups, ...globalGroups]).filter((element) => {
 			// Do not show implicit groups. Bots Already shown in GeoLocationViewer
 			return !['*', 'user', 'autoconfirmed', 'rnrsverify-confirmed', 'bot'].includes(element);
 		});
diff --git a/src/MarkRights/MarkRights.ts b/src/MarkRights/MarkRights.ts
@@ -9,4 +9,9 @@ mw.hook('wikipage.content').add(function markRights($content): void {
 	}
 });
 
-export {queryGlobalUserGroups, queryUserGroups} from './modules/util/query';
+export {
+	getLocalUserGroups,
+	getGlobalUserGroups,
+	queryUserGroups,
+	queryGlobalUserGroups,
+} from './modules/util/getUserGroups';
diff --git a/src/MarkRights/modules/core.ts b/src/MarkRights/modules/core.ts
@@ -1,4 +1,4 @@
-import {queryGlobalUserGroups, queryUserGroups} from './util/query';
+import {getGlobalUserGroups, getLocalUserGroups} from './util/getUserGroups';
 import {appendUserRightsMark} from './util/appendUserRightsMark';
 import {generateUserLinks} from './util/generateUserLinks';
 
@@ -24,35 +24,16 @@ const markUserRights = ($content: JQuery): void => {
 		const ususers = users.splice(0, 25).filter((element) => {
 			return !(mw.util.isIPv4Address(element) || mw.util.isIPv6Address(element));
 		});
+
 		if (!ususers.length) {
 			continue;
 		}
 
 		promises[promises.length] = async (): Promise<void> => {
-			const userGroups: Record<string, string[]> = {};
+			let userGroups: Record<string, string[]> = {};
 
 			try {
-				const response = await queryUserGroups(ususers);
-				const {users: queryUsers} = response['query'] as {
-					users: {groups: string[]; name: string}[];
-				};
-
-				for (const user of queryUsers) {
-					if (!user?.name || !user?.groups) {
-						continue;
-					}
-
-					const {name, groups} = user;
-
-					userGroups[name] ??= [];
-
-					userGroups[name] = [
-						...userGroups[name],
-						...groups.filter((element) => {
-							return element !== '*';
-						}),
-					];
-				}
+				userGroups = await getLocalUserGroups(ususers);
 			} catch (error: unknown) {
 				console.error('[MarkRights] Ajax error:', error);
 			}
@@ -61,27 +42,12 @@ const markUserRights = ($content: JQuery): void => {
 		};
 
 		promises[promises.length] = async (): Promise<void> => {
-			const userGroups: Record<string, string[]> = {};
-
-			for (const user of ususers) {
-				try {
-					const response = await queryGlobalUserGroups(user);
-					const {globaluserinfo} = response['query'] as {
-						globaluserinfo: {groups: string[]};
-					};
+			let userGroups: Record<string, string[]> = {};
 
-					if (!globaluserinfo?.groups) {
-						continue;
-					}
-
-					const {groups} = globaluserinfo;
-
-					userGroups[user] ??= [];
-
-					userGroups[user] = [...userGroups[user], ...groups];
-				} catch (error: unknown) {
-					console.error('[MarkRights] Ajax error:', error);
-				}
+			try {
+				userGroups = await getGlobalUserGroups(ususers);
+			} catch (error: unknown) {
+				console.error('[MarkRights] Ajax error:', error);
 			}
 
 			appendUserRightsMark($userLinks, userGroups);
diff --git a/src/MarkRights/modules/global.d.ts b/src/MarkRights/modules/global.d.ts
@@ -1,7 +1,11 @@
-type QueryUserGroups = typeof import('./util/query').queryUserGroups;
-type QueryGlobalUserGroups = typeof import('./util/query').queryGlobalUserGroups;
+type GetLocalUserGroups = typeof import('./util/getUserGroups').getLocalUserGroups;
+type GetGlobalUserGroups = typeof import('./util/getUserGroups').getGlobalUserGroups;
+type QueryUserGroups = typeof import('./util/getUserGroups').queryUserGroups;
+type QueryGlobalUserGroups = typeof import('./util/getUserGroups').queryGlobalUserGroups;
 
 declare module 'ext.gadget.MarkRights' {
+	export const getLocalUserGroups: GetLocalUserGroups;
+	export const getGlobalUserGroups: GetGlobalUserGroups;
 	export const queryUserGroups: QueryUserGroups;
 	export const queryGlobalUserGroups: QueryGlobalUserGroups;
 }
diff --git a/src/MarkRights/modules/util/getUserGroups.ts b/src/MarkRights/modules/util/getUserGroups.ts
@@ -0,0 +1,117 @@
+import * as OPTIONS from '../../options.json';
+import {api} from './api';
+
+const queryUserGroups = async (ususers: string | string[]) => {
+	const params: ApiQueryUsersParams = {
+		ususers,
+		action: 'query',
+		format: 'json',
+		formatversion: '2',
+		list: 'users',
+		usprop: 'groups',
+		smaxage: 600,
+		maxage: 600,
+	};
+	const response = await api.get(params);
+
+	return response;
+};
+
+const queryGlobalUserGroups = async (guiuser: string) => {
+	const params = {
+		action: 'query',
+		format: 'json',
+		formatversion: '2',
+		meta: 'globaluserinfo',
+		guiuser,
+		guiprop: 'groups',
+		smaxage: 600,
+		maxage: 600,
+	};
+	const response = await api.get(params);
+
+	return response;
+};
+
+const getLocalUserGroups = async (ususers: string[]): Promise<Record<string, string[]>> => {
+	const userGroups: Record<string, string[]> = {};
+
+	ususers = ususers.filter((username) => {
+		if (mw.storage.getObject(OPTIONS.storageKeyLocal + username)) {
+			userGroups[username] = mw.storage.getObject(OPTIONS.storageKeyLocal + username) as string[];
+		}
+
+		return !!userGroups?.[username]?.length;
+	});
+
+	try {
+		const response = await queryUserGroups(ususers);
+		const {users: queryUsers} = response['query'] as {
+			users: {groups: string[]; name: string}[];
+		};
+
+		for (const user of queryUsers) {
+			if (!user?.name || !user?.groups) {
+				continue;
+			}
+
+			const {name, groups} = user;
+
+			userGroups[name] ??= [];
+
+			userGroups[name] = [
+				...userGroups[name],
+				...groups.filter((element) => {
+					return element !== '*';
+				}),
+			];
+
+			// Cache for 10 minutes
+			mw.storage.setObject(OPTIONS.storageKeyLocal + name, userGroups[name], 10 * 60);
+		}
+	} catch (error: unknown) {
+		console.error('[MarkRights] Ajax error:', error);
+	}
+
+	return userGroups;
+};
+
+const getGlobalUserGroups = async (ususers: string[]): Promise<Record<string, string[]>> => {
+	const userGroups: Record<string, string[]> = {};
+
+	ususers = ususers.filter((username) => {
+		if (mw.storage.getObject(OPTIONS.storageKeyGlobal + username)) {
+			userGroups[username] = mw.storage.getObject(OPTIONS.storageKeyGlobal + username) as string[];
+		}
+
+		return !!userGroups?.[username]?.length;
+	});
+
+	for (const user of ususers) {
+		try {
+			const response = await queryGlobalUserGroups(user);
+			const {globaluserinfo} = response['query'] as {
+				globaluserinfo: {groups: string[]};
+			};
+
+			if (!globaluserinfo?.groups) {
+				continue;
+			}
+
+			const {groups} = globaluserinfo;
+
+			userGroups[user] ??= [];
+
+			userGroups[user] = [...userGroups[user], ...groups];
+
+			// Cache for 10 minutes
+			mw.storage.setObject(OPTIONS.storageKeyLocal + user, userGroups[user], 10 * 60);
+		} catch (error: unknown) {
+			console.error('[MarkRights] Ajax error:', error);
+		}
+	}
+
+	return userGroups;
+};
+
+export {getLocalUserGroups, getGlobalUserGroups, queryUserGroups, queryGlobalUserGroups};
diff --git a/src/MarkRights/modules/util/query.ts b/src/MarkRights/modules/util/query.ts
diff --git a/src/MarkRights/options.json b/src/MarkRights/options.json
@@ -1,3 +1,5 @@
 {
-	"version": 2.0
+	"version": 2.0,
+	"storageKeyLocal": "ext.gadget.WhoIsActive_MarkRights-local-",
+	"storageKeyGlobal": "ext.gadget.WhoIsActive_MarkRights-global-"
 }
