From e0b6dd05814453d54103d64d1631519019405a8b Mon Sep 17 00:00:00 2001 From: TomatoCake <60300461+DEVTomatoCake@users.noreply.github.com> Date: Sun, 18 Aug 2024 06:45:11 +0200 Subject: [PATCH] Fix bug & handle 75k/large_threshold in opcode 8 Also fixes a bug that only allowed "guild_id" and "user_ids" to be an Array instead of also a String Co-Authored-By: Puyodead1 --- assets/openapi.json | Bin 617024 -> 617567 bytes assets/schemas.json | Bin 21209522 -> 23504303 bytes src/gateway/opcodes/Identify.ts | 1 + src/gateway/opcodes/RequestGuildMembers.ts | 109 ++++++++++++++---- src/gateway/util/WebSocket.ts | 7 +- src/util/schemas/RequestGuildMembersSchema.ts | 2 +- 6 files changed, 92 insertions(+), 27 deletions(-) diff --git a/assets/openapi.json b/assets/openapi.json index 2af0a2c700b59b034ce0c5ad1fdb65d6592a5404..68adb4556eac99d06647d081f6de81280f125da2 100644 GIT binary patch delta 153 zcmX?bMfLs-)rJK=LWzP($Y_-p`|G!@!e4aVy%*;7w z&gcD}@9#bD@ArH0^>typ-gzXvHCkmXs1d82F0Zeq+jhWRs9)97-sPDA1) zO)@oxQ)*~YnCgYOT{{^_C{BQ zBl-F;I$x|as%ATu`p7;l!sO4>=L@C5L%X)~_LitP?adCc!r}4y?GaX5^=-P1S`SPN z9d81iOFUtv);PW4SBD?yymye0rS`gAPA_$o3dVr#e2x%BmzOqAq_Y*_I*R!;ERKqr z?zWQqL%l&+=Bl8sJRy!+Q;u0Fe{N+0wcI|<5+#<^IcE7h4spR)(OEy9R&7%a4Q^hb zmOoKnOfzp)#$Wpyz3B0X^?z7YSxMq6*XM5fDkVo*R_CIHC1z9b*BcmIqpEay7SOhX z6UPRZg!$C*rY8RCRywgwYreXqD6b=Nt#Ea7It}+LN*b>0#o>{EMq8hM$@1RHezQ(K z(%)NG>~&Q9dVP7F%Ne{jeZJF{96aCx(I;M6Pmh)r>#kl?OY(fL%XwwnFCR>H)yiw= z~?0b*vsgnQYtIr>I<>n?$l}!jh=9>5w6($l(c|v)AUUcG$db zM|n+UjibUQmiua4PMf^R<`B!PZH_v}0*BLQt8v;y`A@zoBy5e{KwT4tCsWg!`=W>X z7I~cBD;w)=f5&Dsb+m<9sobKmPxq@l^_cGM31oEZgf9Y} zKWl~U)HuNsFLg#X`)1G!Zw+2bjb(Z3_Uvf6Y|>WA!7KKvGbHeeTtWinn=m90639UU zX`U3RrE&KU(eJja7AmN*A0@&F1dR@i03RcuxoK(8gHYyeyE6UH>C$LL`@ud(_UnzcX!D}Y%d*XzV%iDz!9Gj&`(@}ilP@$L)uU>#zpkk3NynD3_UYt0q@EztPl2uo;7UXfm~Qqk-3-fV+EFe)*4`u@Yl0y?`cK`zj|Qp8BsbNZy8C_Yh3$du z;bwbe`6t*OaLzh~v|WxaoF^^k+`IpCff_Y1$fZWkWh zf_rY1t_Yr~pbH@r(Xse*J^zElSZ^lqNwLWf+q$cTzArN)vSYb33 zy?n$#yZS4FeTaXz+wa-g>A~qg}&)HqNk>}%!$;r^XNdzcU27SoqImNd`+Jb zAZXq9$^m^QagQ=SqowxM!oWW3tfI!&XZm>eU6txhDrExgN;#H9`Ex510!8amgz1v} zavwT?A@Vpzo)q~`^*tC{4)8OBUy?o70N5>X&y4%tw#K_pEqED@2k^6me?zSMo=B8X zpoD@~357Ipy(a~Z2cpkR^rcxp`#k6x0PeYQ-&MQhC`>-M=f?e>WA$fHA`R|Yao=N- zT4yfLfWHU#thkqFNBa8Jm0yB;aL=3wd@dZQg<|x!|4~_qTkp1^ylrk`goSNiN*fN`IWa6;%y@ zpBMb!Bp{86G$yAsrZR3%=Jx)`=D^*vayiO4Y2af|t_p+PL+*LWJxwjhh?HLM|IAMi zeTY6c(SNUD2L`o8tCm-*RyI37e)Sx<2lwo_A9&lYi|{${Ioy2Cu>CLW0{7sa8~0~3 zUrGY^;GP@z)~$Q)MluuJGvl6Q?lqER{OeTIWdeRy@XG^DMXvhW?cg5VGvl6Q?sd|# zv#&m`!{b{#zUB1z_OhuL{>-xWCoq&Ul%JXMOCNW>)_|TU;GP@zb@}_Nq4(gP8~5Ei z-yDQ=KDcMbJ$<%&v^?LmJoJwLu(5!g$5Sk!k#~BQHczCai<-F5(up7A283ShtkPTh zOfwx>txxE?Sh!M0tu{qWaLgXRA^KK2v`%HB={0&&z+J8vj1*b8(nKHG6-JtFeOpAE z8f|J`ZE9)nz3+aC5#Df{;dYyO_UA*-K<**;%;dhbs_Q|tDj@gVV5;k@;~j`7rssOg=q4{CEYh2ll+Mm(*K6%0x#1*c@gyhmxK@ zqN6E>?uVfH(0pE+ziID96`fsnss-o+eO~C(BcFe=9oPeVX4tpn)~clGvp!!2s}HNs z%j3&dpBMUcYxwymfjzKihP`&l zg)P7y*fYa^=c(@=1NOk48TKWGKLUFsGnpkbgy%C-AvaAv8noA@{uGKJb7`B_M?fy=SKPZ6l6rgeWxxAA-+I@I$>&+HRey z7d|nAe$da0{=me}aDl)*xM#-w=^G*iq;+8Pnc4in#-|NJ0D2F-=cV_(ea%hAi1@&a z+bx3LUleHww9BcUVU*vlR0sZIGz#Mp76=PoVbOMBWvs9SvsAzbaq~fo&%_BR&#G@09{ zwYkc#6LJs&2mx*(Fsds%A#nKcP@xcwUNm}nHG12I+>jw0gz7`}nW=u;rKht555Ncb z+`wNJlP$C&#{=-Wfj|20(Lx+j`v9LC_;;Mk5oW;Z0DNxXzdU!WU7lbTSM delta 20655 zcmd6v`BPI@6vyX6LIObupaI!5ZfHdot-B7O2n7WZabXz@xPz_WiVK*6fYo797*43l ziwiB{0@@C@TBk1#h#L;nI$E_=JBYPaMB9!IR};WAIaRm90G6recsHRCplvV=AtFX`lZ8WB=8T#q59QQyx0qlTnJv zV+OySzjCL@!3!5&$d`ODL1W~`vV$moGpqbCibI0qg=>YDpXGI z0M0>@s2q689{&~W|8kbb-uS66~#q}|vB{D3u%rRIz?=?Jk{wxDr#Ph1Q$je~fNj2bui0B5q zB=0QF`2@~ElBgWH!=$<4c!ISz%nQNGq-7%#3SF?$L!X8gCOHoh8aBo;cQTDlbffzx z7mkF3lnhl+>CnVj9vPI7$S5nWPELkV33F+Qj3!fgXr2pY{mncp;_SzelTM}Jxqbyz=SDITOvor5>?-x+i}@Miuy=cViMs9qK=55Ze5pJuD};c3;9laY-_)zq_QIi7FsWd_I2>~1^XwPa3bKr_pE81_`T}60{ddX04OfLnKI-DuE!L{TR z-um7$53cPgD{?}+KJgpQ`-Z_e$~PBPuEVRwG8o-~3ohQWwYnRx?zv^F4B)!A`)%QZ zi<-JzMw2lnbRyL}J2J?;&mnZAjb;&4c2=(t)OQ!Lv1DYe3n`!>bs*_C)WpKg+PS|Q zhvNw=Q7QR5-H|LfH2(Z{?M^rCV5UJFNIM}0AzV7w&qWC&cr#$%cr`r#Gd zl2%IIIpvHao{d?jzc%1eeKwNUz}d*_jAswvEd(xlp2u6D^W?qX>EYta+L4f^yzmUp zMl0G6`OU7Ns%7?G{L}%h`m(4-_uAD?T)*XVFQ|0yUt9&;cCj=L2`jIoqJ`XVe*4 zI(^2o5#-#fa=qk!&Wc2d)upIS`m7et&d`a$G5$dDnftsg>;l{<|OS-$@mh|+E z{fj!dy0hoiUvl!A9zB2>NAk(kSX?=aV%wa3grL0vQqP$>-o=vy*1CxLw%fRqPp*xc zylT&mLK_E{#^D7Qh-6lmmw)`a2M(>Nt2e_P%|+_?wNFMp*>81dWLzQ(hAa1~x_Xtu z?v;#HqUj|FKijgSa8xbx?bs1CD$C7z@!1t6+Xfe5)+bJdKciGE6HPY@TMi_ZO6VM~ zX3OE&t{it|wQy8D+5v1o9F@x8&JMy+jdJn?q>9|>&Fay#lCF+2anl=LmZLyJ6V`6l z0@_&8J(N|$Y4zpO5qRn0zfx5$w%r-Y?BF_!%(bDIoG_X_8VKj8sdEe?II15Lg8=8` ztM;)>K-0>y@bHZo&km!JiDBm_vdwTCfWqYQQvfTkCC8_+VmJ#|YC~8y*bNNnQB0}h zR!O$kZ_W`@u8U;-&NjY#kofxjTzkBj&uMnh(7O zSni#PA@ND98IMwWS%zHPbv1=W!x?LSIfb2=7`B9Yz_E#c@HEyR534v}89M=n^;%=& Gkoym>8_Wv; diff --git a/src/gateway/opcodes/Identify.ts b/src/gateway/opcodes/Identify.ts index c535cd45..94320eee 100644 --- a/src/gateway/opcodes/Identify.ts +++ b/src/gateway/opcodes/Identify.ts @@ -82,6 +82,7 @@ export async function onIdentify(this: WebSocket, data: Payload) { const identify: IdentifySchema = data.d; this.capabilities = new Capabilities(identify.capabilities || 0); + this.large_threshold = identify.large_threshold || 250; const user = await tryGetUserFromToken(identify.token, { relations: ["relationships", "relationships.to", "settings"], diff --git a/src/gateway/opcodes/RequestGuildMembers.ts b/src/gateway/opcodes/RequestGuildMembers.ts index c84bf893..3381caed 100644 --- a/src/gateway/opcodes/RequestGuildMembers.ts +++ b/src/gateway/opcodes/RequestGuildMembers.ts @@ -17,6 +17,7 @@ */ import { + getDatabase, getPermission, GuildMembersChunkEvent, Member, @@ -29,51 +30,103 @@ import { check } from "./instanceOf"; import { FindManyOptions, In, Like } from "typeorm"; export async function onRequestGuildMembers(this: WebSocket, { d }: Payload) { - // TODO: check data + // Schema validation can only accept either string or array, so transforming it here to support both + if (!d.guild_id) throw new Error('"guild_id" is required'); + d.guild_id = Array.isArray(d.guild_id) ? d.guild_id[0] : d.guild_id; + + if (d.user_ids && !Array.isArray(d.user_ids)) d.user_ids = [d.user_ids]; + check.call(this, RequestGuildMembersSchema, d); - const { guild_id, query, presences, nonce } = - d as RequestGuildMembersSchema; - let { limit, user_ids } = d as RequestGuildMembersSchema; + const { query, presences, nonce } = d as RequestGuildMembersSchema; + let { limit, user_ids, guild_id } = d as RequestGuildMembersSchema; + + guild_id = guild_id as string; + user_ids = user_ids as string[] | undefined; if ("query" in d && (!limit || Number.isNaN(limit))) throw new Error('"query" requires "limit" to be set'); if ("query" in d && user_ids) throw new Error('"query" and "user_ids" are mutually exclusive'); - if (user_ids && !Array.isArray(user_ids)) user_ids = [user_ids]; - user_ids = user_ids as string[] | undefined; // TODO: Configurable limit? if ((query || (user_ids && user_ids.length > 0)) && (!limit || limit > 100)) limit = 100; - const permissions = await getPermission( - this.user_id, - Array.isArray(guild_id) ? guild_id[0] : guild_id, - ); + const permissions = await getPermission(this.user_id, guild_id); permissions.hasThrow("VIEW_CHANNEL"); - const whereQuery: FindManyOptions["where"] = {}; - if (query) { - whereQuery.user = { - username: Like(query + "%"), - }; - } else if (user_ids && user_ids.length > 0) { - whereQuery.id = In(user_ids); - } + const memberCount = await Member.count({ + where: { + guild_id, + }, + }); const memberFind: FindManyOptions = { where: { - ...whereQuery, - guild_id: Array.isArray(guild_id) ? guild_id[0] : guild_id, + guild_id, }, relations: ["user", "roles"], }; if (limit) memberFind.take = Math.abs(Number(limit || 100)); - const members = await Member.find(memberFind); + + let members: Member[] = []; + + if (memberCount > 75000) { + // since we dont have voice channels yet, just return the connecting users member object + members = await Member.find({ + ...memberFind, + where: { + ...memberFind.where, + user: { + id: this.user_id, + }, + }, + }); + } else if (memberCount > this.large_threshold) { + // find all members who are online, have a role, have a nickname, or are in a voice channel, as well as respecting the query and user_ids + const db = getDatabase(); + if (!db) throw new Error("Database not initialized"); + const repo = db.getRepository(Member); + const q = repo + .createQueryBuilder("member") + .where("member.guild_id = :guild_id", { guild_id }) + .leftJoinAndSelect("member.roles", "role") + .leftJoinAndSelect("member.user", "user") + .leftJoinAndSelect("user.sessions", "session") + .andWhere( + "',' || member.roles || ',' NOT LIKE :everyoneRoleIdList", + { everyoneRoleIdList: "%," + guild_id + ",%" }, + ) + .andWhere("session.status != 'offline'") + .addOrderBy("user.username", "ASC") + .limit(memberFind.take); + + if (query && query != "") { + q.andWhere(`user.username ILIKE :query`, { + query: `${query}%`, + }); + } else if (user_ids) { + q.andWhere(`user.id IN (:...user_ids)`, { user_ids }); + } + + members = await q.getMany(); + } else { + if (query) { + // @ts-expect-error memberFind.where is very much defined + memberFind.where.user = { + username: Like(query + "%"), + }; + } else if (user_ids && user_ids.length > 0) { + // @ts-expect-error memberFind.where is still very much defined + memberFind.where.id = In(user_ids); + } + + members = await Member.find(memberFind); + } const baseData = { - guild_id: Array.isArray(guild_id) ? guild_id[0] : guild_id, + guild_id, nonce, }; @@ -114,7 +167,17 @@ export async function onRequestGuildMembers(this: WebSocket, { d }: Payload) { }); } - if (notFound.length > 0) chunks[0].not_found = notFound; + if (notFound.length > 0) { + if (chunks.length == 0) + chunks.push({ + ...baseData, + members: [], + presences: presences ? [] : undefined, + chunk_index: 0, + chunk_count: 1, + }); + chunks[0].not_found = notFound; + } chunks.forEach((chunk) => { Send(this, { diff --git a/src/gateway/util/WebSocket.ts b/src/gateway/util/WebSocket.ts index 833756ff..8cfc5e08 100644 --- a/src/gateway/util/WebSocket.ts +++ b/src/gateway/util/WebSocket.ts @@ -1,17 +1,17 @@ /* Spacebar: A FOSS re-implementation and extension of the Discord.com backend. Copyright (C) 2023 Spacebar and Spacebar Contributors - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. - + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ @@ -43,4 +43,5 @@ export interface WebSocket extends WS { listen_options: ListenEventOpts; capabilities?: Capabilities; // client?: Client; + large_threshold: number; } diff --git a/src/util/schemas/RequestGuildMembersSchema.ts b/src/util/schemas/RequestGuildMembersSchema.ts index 6909ba85..9e60d26e 100644 --- a/src/util/schemas/RequestGuildMembersSchema.ts +++ b/src/util/schemas/RequestGuildMembersSchema.ts @@ -26,7 +26,7 @@ export interface RequestGuildMembersSchema { } export const RequestGuildMembersSchema = { - guild_id: [] as string | string[], + guild_id: "" as string | string[], $query: String, $limit: Number, $presences: Boolean,