From ea3047890bf06dfe8b2de470f5b17ca9f40c1921 Mon Sep 17 00:00:00 2001 From: TomatoCake <60300461+DEVTomatoCake@users.noreply.github.com> Date: Sun, 11 Aug 2024 06:40:42 +0200 Subject: [PATCH] Fix issues with requesting presences --- src/gateway/events/Close.ts | 10 +++++----- src/gateway/opcodes/Identify.ts | 12 ++++++------ src/gateway/opcodes/LazyRequest.ts | 8 ++++---- src/gateway/opcodes/PresenceUpdate.ts | 15 ++++++++++----- src/gateway/opcodes/RequestGuildMembers.ts | 17 +++++++++++++---- src/util/entities/Session.ts | 12 +++++++----- src/util/interfaces/Status.ts | 9 +++++---- .../mariadb/1723347738541-client_status.ts | 17 +++++++++++++++++ .../mysql/1723347738541-client_status.ts | 17 +++++++++++++++++ .../postgres/1723347738541-client_status.ts | 17 +++++++++++++++++ 10 files changed, 101 insertions(+), 33 deletions(-) create mode 100644 src/util/migration/mariadb/1723347738541-client_status.ts create mode 100644 src/util/migration/mysql/1723347738541-client_status.ts create mode 100644 src/util/migration/postgres/1723347738541-client_status.ts diff --git a/src/gateway/events/Close.ts b/src/gateway/events/Close.ts index 16f6b188e..311ed32a0 100644 --- a/src/gateway/events/Close.ts +++ b/src/gateway/events/Close.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 . */ @@ -50,7 +50,7 @@ export async function Close(this: WebSocket, code: number, reason: Buffer) { } as SessionsReplace); const session = sessions.first() || { activities: [], - client_info: {}, + client_status: {}, status: "offline", }; @@ -68,7 +68,7 @@ export async function Close(this: WebSocket, code: number, reason: Buffer) { data: { user: userOrId, activities: session.activities, - client_status: session?.client_info, + client_status: session?.client_status, status: session.status, }, } as PresenceUpdateEvent); diff --git a/src/gateway/opcodes/Identify.ts b/src/gateway/opcodes/Identify.ts index 41f9f83db..e30a1ee0c 100644 --- a/src/gateway/opcodes/Identify.ts +++ b/src/gateway/opcodes/Identify.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 . */ @@ -122,8 +122,8 @@ export async function onIdentify(this: WebSocket, data: Payload) { session_id: this.session_id, status: identify.presence?.status || "online", client_info: { - client: identify.properties?.$device, - os: identify.properties?.os, + client: identify.properties?.device || identify.properties?.$device, + os: identify.properties?.os || identify.properties?.$os, version: 0, }, activities: identify.presence?.activities, // TODO: validation @@ -372,7 +372,7 @@ export async function onIdentify(this: WebSocket, data: Payload) { data: { user: user.toPublicUser(), activities: session.activities, - client_status: session.client_info, + client_status: session.client_status, status: session.status, }, } as PresenceUpdateEvent), diff --git a/src/gateway/opcodes/LazyRequest.ts b/src/gateway/opcodes/LazyRequest.ts index 3c21b708c..27e9b00af 100644 --- a/src/gateway/opcodes/LazyRequest.ts +++ b/src/gateway/opcodes/LazyRequest.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 . */ @@ -248,7 +248,7 @@ export async function onLazyRequest(this: WebSocket, { d }: Payload) { d: { user: user, activities: session?.activities || [], - client_status: session?.client_info, + client_status: session?.client_status, status: session?.status || "offline", } as Presence, }); diff --git a/src/gateway/opcodes/PresenceUpdate.ts b/src/gateway/opcodes/PresenceUpdate.ts index 03736263c..f84da1205 100644 --- a/src/gateway/opcodes/PresenceUpdate.ts +++ b/src/gateway/opcodes/PresenceUpdate.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 . */ @@ -35,14 +35,19 @@ export async function onPresenceUpdate(this: WebSocket, { d }: Payload) { { status: presence.status, activities: presence.activities }, ); + const session = await Session.findOneOrFail({ + select: ["client_status"], + where: { session_id: this.session_id }, + }); + await emitEvent({ event: "PRESENCE_UPDATE", user_id: this.user_id, data: { user: await User.getPublicUser(this.user_id), - activities: presence.activities, - client_status: {}, // TODO: status: presence.status, + activities: presence.activities, + client_status: session.client_status, }, } as PresenceUpdateEvent); } diff --git a/src/gateway/opcodes/RequestGuildMembers.ts b/src/gateway/opcodes/RequestGuildMembers.ts index 8934377d0..9a966752b 100644 --- a/src/gateway/opcodes/RequestGuildMembers.ts +++ b/src/gateway/opcodes/RequestGuildMembers.ts @@ -22,6 +22,7 @@ import { Member, Presence, RequestGuildMembersSchema, + Session, } from "@spacebar/util"; import { WebSocket, Payload, OPCODES, Send } from "@spacebar/gateway"; import { check } from "./instanceOf"; @@ -63,7 +64,7 @@ export async function onRequestGuildMembers(this: WebSocket, { d }: Payload) { ...whereQuery, guild_id, }, - relations: ["roles", ...(presences ? ["presence"] : [])], + relations: ["users", "roles"], }; if (limit) memberFind.take = Math.abs(Number(limit || 100)); const members = await Member.find(memberFind); @@ -83,13 +84,21 @@ export async function onRequestGuildMembers(this: WebSocket, { d }: Payload) { const chunks: GuildMembersChunkEvent["data"][] = []; while (members.length > 0) { - const chunk = members.splice(0, 1000); + const chunk: Member[] = members.splice(0, 1000); const presenceList: Presence[] = []; if (presences) { for await (const member of chunk) { - presenceList.push(member.presence); - delete member.presence; + const session = await Session.findOne({ + where: { user_id: member.id }, + }); + if (session) + presenceList.push({ + user: member.user.toPublicUser(), + status: session.status, + activities: session.activities, + client_status: session.client_status, + }); } } diff --git a/src/util/entities/Session.ts b/src/util/entities/Session.ts index 6c6f7caa6..15f8faa2f 100644 --- a/src/util/entities/Session.ts +++ b/src/util/entities/Session.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 . */ @@ -19,7 +19,7 @@ import { User } from "./User"; import { BaseClass } from "./BaseClass"; import { Column, Entity, JoinColumn, ManyToOne, RelationId } from "typeorm"; -import { Status } from "../interfaces/Status"; +import { ClientStatus, Status } from "../interfaces/Status"; import { Activity } from "../interfaces/Activity"; //TODO we need to remove all sessions on server start because if the server crashes without closing websockets it won't delete them @@ -43,7 +43,6 @@ export class Session extends BaseClass { @Column({ type: "simple-json", nullable: true }) activities: Activity[]; - // TODO client_status @Column({ type: "simple-json", select: false }) client_info: { client: string; @@ -51,6 +50,9 @@ export class Session extends BaseClass { version: number; }; + @Column({ type: "simple-json" }) + client_status: ClientStatus; + @Column({ nullable: false, type: "varchar" }) status: Status; //TODO enum } diff --git a/src/util/interfaces/Status.ts b/src/util/interfaces/Status.ts index 407a813ec..0f2f4e136 100644 --- a/src/util/interfaces/Status.ts +++ b/src/util/interfaces/Status.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 . */ @@ -21,5 +21,6 @@ export type Status = "idle" | "dnd" | "online" | "offline" | "invisible"; export interface ClientStatus { desktop?: string; // e.g. Windows/Linux/Mac mobile?: string; // e.g. iOS/Android - web?: string; // e.g. browser, bot account + web?: string; // e.g. browser, bot account, unknown + embedded?: string; // e.g. embedded } diff --git a/src/util/migration/mariadb/1723347738541-client_status.ts b/src/util/migration/mariadb/1723347738541-client_status.ts new file mode 100644 index 000000000..0e02c45e5 --- /dev/null +++ b/src/util/migration/mariadb/1723347738541-client_status.ts @@ -0,0 +1,17 @@ +import { MigrationInterface, QueryRunner } from "typeorm"; + +export class client_status1723347738541 implements MigrationInterface { + name = "client_status1723347738541"; + + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE `sessions` ADD `client_status` text NULL AFTER `client_info`", + ); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE `sessions` DROP COLUMN `client_status`", + ); + } +} diff --git a/src/util/migration/mysql/1723347738541-client_status.ts b/src/util/migration/mysql/1723347738541-client_status.ts new file mode 100644 index 000000000..0e02c45e5 --- /dev/null +++ b/src/util/migration/mysql/1723347738541-client_status.ts @@ -0,0 +1,17 @@ +import { MigrationInterface, QueryRunner } from "typeorm"; + +export class client_status1723347738541 implements MigrationInterface { + name = "client_status1723347738541"; + + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE `sessions` ADD `client_status` text NULL AFTER `client_info`", + ); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE `sessions` DROP COLUMN `client_status`", + ); + } +} diff --git a/src/util/migration/postgres/1723347738541-client_status.ts b/src/util/migration/postgres/1723347738541-client_status.ts new file mode 100644 index 000000000..35d9391ff --- /dev/null +++ b/src/util/migration/postgres/1723347738541-client_status.ts @@ -0,0 +1,17 @@ +import { MigrationInterface, QueryRunner } from "typeorm"; + +export class client_status1723347738541 implements MigrationInterface { + name = "client_status1723347738541"; + + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE sessions ADD client_status text NULL", + ); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + "ALTER TABLE sessions DROP COLUMN client_status", + ); + } +}