StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-03-16 14:11:50 +00:00
Code Releases Activity

Optimize !search and !bansearch performance for non-regex searches

Browse source
This commit is contained in:
Dragory 2021-04-28 21:44:15 +03:00
parent c7c1b1f96f
commit ee615c1f0e
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
1 changed files with 40 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
backend/src/plugins/Utility/search.ts
View file

@ -10,7 +10,7 @@ import { banSearchSignature } from "./commands/BanSearchCmd";
import { UtilityPluginType } from "./types"; import { UtilityPluginType } from "./types";
import { refreshMembersIfNeeded } from "./refreshMembers"; import { refreshMembersIfNeeded } from "./refreshMembers";
import { getUserInfoEmbed } from "./functions/getUserInfoEmbed"; import { getUserInfoEmbed } from "./functions/getUserInfoEmbed";
import { allowTimeout } from "../../RegExpRunner"; import { allowTimeout, RegExpRunner } from "../../RegExpRunner";
import { inputPatternToRegExp, InvalidRegexError } from "../../validatorUtils"; import { inputPatternToRegExp, InvalidRegexError } from "../../validatorUtils";
import { asyncFilter } from "../../utils/async"; import { asyncFilter } from "../../utils/async";
import Timeout = NodeJS.Timeout; import Timeout = NodeJS.Timeout;
@ -29,6 +29,29 @@ class SearchError extends Error {}
type MemberSearchParams = ArgsFromSignatureOrArray<typeof searchCmdSignature>; type MemberSearchParams = ArgsFromSignatureOrArray<typeof searchCmdSignature>;
type BanSearchParams = ArgsFromSignatureOrArray<typeof banSearchSignature>; type BanSearchParams = ArgsFromSignatureOrArray<typeof banSearchSignature>;
type RegexRunner = InstanceType<typeof RegExpRunner>["exec"];
function getOptimizedRegExpRunner(pluginData: GuildPluginData<UtilityPluginType>, isSafeRegex: boolean): RegexRunner {
if (isSafeRegex) {
return async (regex: RegExp, str: string) => {
if (!regex.global) {
const singleMatch = regex.exec(str);
return singleMatch ? [singleMatch] : null;
}
const matches: RegExpExecArray[] = [];
let match: RegExpExecArray | null;
// tslint:disable-next-line:no-conditional-assignment
while ((match = regex.exec(str)) != null) {
matches.push(match);
}
return matches.length ? matches : null;
};
}
return pluginData.state.regexRunner.exec.bind(pluginData.state.regexRunner);
}
export async function displaySearch( export async function displaySearch(
pluginData: GuildPluginData<UtilityPluginType>, pluginData: GuildPluginData<UtilityPluginType>,
args: MemberSearchParams, args: MemberSearchParams,
@ -270,59 +293,51 @@ async function performMemberSearch(
} }
if (args.query) { if (args.query) {
let isSafeRegex = true;
let queryRegex: RegExp; let queryRegex: RegExp;
if (args.regex) { if (args.regex) {
const flags = args["case-sensitive"] ? "" : "i"; const flags = args["case-sensitive"] ? "" : "i";
queryRegex = inputPatternToRegExp(args.query.trimStart()); queryRegex = inputPatternToRegExp(args.query.trimStart());
queryRegex = new RegExp(queryRegex.source, flags); queryRegex = new RegExp(queryRegex.source, flags);
isSafeRegex = false;
} else { } else {
queryRegex = new RegExp(escapeStringRegexp(args.query.trimStart()), args["case-sensitive"] ? "" : "i"); queryRegex = new RegExp(escapeStringRegexp(args.query.trimStart()), args["case-sensitive"] ? "" : "i");
} }
const execRegExp = getOptimizedRegExpRunner(pluginData, isSafeRegex);
if (args["status-search"]) { if (args["status-search"]) {
matchingMembers = await asyncFilter(matchingMembers, async member => { matchingMembers = await asyncFilter(matchingMembers, async member => {
if (member.game) { if (member.game) {
if ( if (member.game.name && (await execRegExp(queryRegex, member.game.name).catch(allowTimeout))) {
member.game.name &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.name).catch(allowTimeout))
) {
return true; return true;
} }
if ( if (member.game.state && (await execRegExp(queryRegex, member.game.state).catch(allowTimeout))) {
member.game.state &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.state).catch(allowTimeout))
) {
return true; return true;
} }
if ( if (member.game.details && (await execRegExp(queryRegex, member.game.details).catch(allowTimeout))) {
member.game.details &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.details).catch(allowTimeout))
) {
return true; return true;
} }
if (member.game.assets) { if (member.game.assets) {
if ( if (
member.game.assets.small_text && member.game.assets.small_text &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.assets.small_text).catch(allowTimeout)) (await execRegExp(queryRegex, member.game.assets.small_text).catch(allowTimeout))
) { ) {
return true; return true;
} }
if ( if (
member.game.assets.large_text && member.game.assets.large_text &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.assets.large_text).catch(allowTimeout)) (await execRegExp(queryRegex, member.game.assets.large_text).catch(allowTimeout))
) { ) {
return true; return true;
} }
} }
if ( if (member.game.emoji && (await execRegExp(queryRegex, member.game.emoji.name).catch(allowTimeout))) {
member.game.emoji &&
(await pluginData.state.regexRunner.exec(queryRegex, member.game.emoji.name).catch(allowTimeout))
) {
return true; return true;
} }
} }
@ -330,12 +345,12 @@ async function performMemberSearch(
}); });
} else { } else {
matchingMembers = await asyncFilter(matchingMembers, async member => { matchingMembers = await asyncFilter(matchingMembers, async member => {
if (member.nick && (await pluginData.state.regexRunner.exec(queryRegex, member.nick).catch(allowTimeout))) { if (member.nick && (await execRegExp(queryRegex, member.nick).catch(allowTimeout))) {
return true; return true;
} }
const fullUsername = `${member.user.username}#${member.user.discriminator}`; const fullUsername = `${member.user.username}#${member.user.discriminator}`;
if (await pluginData.state.regexRunner.exec(queryRegex, fullUsername).catch(allowTimeout)) return true; if (await execRegExp(queryRegex, fullUsername).catch(allowTimeout)) return true;
return false; return false;
}); });
@ -383,18 +398,21 @@ async function performBanSearch(
let matchingBans = (await pluginData.guild.getBans()).map(x => x.user); let matchingBans = (await pluginData.guild.getBans()).map(x => x.user);
if (args.query) { if (args.query) {
let isSafeRegex = true;
let queryRegex: RegExp; let queryRegex: RegExp;
if (args.regex) { if (args.regex) {
const flags = args["case-sensitive"] ? "" : "i"; const flags = args["case-sensitive"] ? "" : "i";
queryRegex = inputPatternToRegExp(args.query.trimStart()); queryRegex = inputPatternToRegExp(args.query.trimStart());
queryRegex = new RegExp(queryRegex.source, flags); queryRegex = new RegExp(queryRegex.source, flags);
isSafeRegex = false;
} else { } else {
queryRegex = new RegExp(escapeStringRegexp(args.query.trimStart()), args["case-sensitive"] ? "" : "i"); queryRegex = new RegExp(escapeStringRegexp(args.query.trimStart()), args["case-sensitive"] ? "" : "i");
} }
const execRegExp = getOptimizedRegExpRunner(pluginData, isSafeRegex);
matchingBans = await asyncFilter(matchingBans, async user => { matchingBans = await asyncFilter(matchingBans, async user => {
const fullUsername = `${user.username}#${user.discriminator}`; const fullUsername = `${user.username}#${user.discriminator}`;
if (await pluginData.state.regexRunner.exec(queryRegex, fullUsername).catch(allowTimeout)) return true; if (await execRegExp(queryRegex, fullUsername).catch(allowTimeout)) return true;
return false; return false;
}); });
} }