Remove sims when the Discord user leaves

src/d2m/actions/register-user.js

@@ -206,14 +206,16 @@ function _hashProfileContent(content, powerLevel) {
  * 3. Calculate the power level the user should get based on their Discord permissions
  * 4. Compare against the previously known state content, which is helpfully stored in the database
  * 5. If the state content or power level have changed, send them to Matrix and update them in the database for next time
+ * 6. If the sim is for a user-installed app, check which user it was added by
  * @param {DiscordTypes.APIUser} user
  * @param {Omit<DiscordTypes.APIGuildMember, "user"> | undefined} member
  * @param {DiscordTypes.APIGuildChannel} channel
  * @param {DiscordTypes.APIGuild} guild
  * @param {string} roomID
+ * @param {DiscordTypes.APIMessageInteractionMetadata} [interactionMetadata]
  * @returns {Promise<string>} mxid of the updated sim
  */
-async function syncUser(user, member, channel, guild, roomID) {
+async function syncUser(user, member, channel, guild, roomID, interactionMetadata) {
 	const mxid = await ensureSimJoined(user, roomID)
 	const content = await memberToStateContent(user, member, guild.id)
 	const powerLevel = memberToPowerLevel(user, member, guild, channel)
@@ -222,6 +224,12 @@ async function syncUser(user, member, channel, guild, roomID) {
 		allowOverwrite: !!member,
 		globalProfile: await userToGlobalProfile(user)
 	})
+
+	const appInstalledByUser = user.bot && interactionMetadata?.authorizing_integration_owners?.[DiscordTypes.ApplicationIntegrationType.UserInstall]
+	if (appInstalledByUser) {
+		db.prepare("INSERT OR IGNORE INTO app_user_install (app_bot_id, user_id, guild_id) VALUES (?, ?, ?)").run(user.id, appInstalledByUser, guild.id)
+	}
+
 	return mxid
 }
 

src/d2m/actions/remove-member.js

@@ -0,0 +1,26 @@
+// @ts-check
+
+const passthrough = require("../../passthrough")
+const {sync, db, select, from} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../converters/remove-member-mxids")} */
+const removeMemberMxids = sync.require("../converters/remove-member-mxids")
+
+/**
+ * @param {string} userID discord user ID that left
+ * @param {string} guildID discord guild ID that they left
+ */
+async function removeMember(userID, guildID) {
+	const {userAppDeletions, membership} = removeMemberMxids.removeMemberMxids(userID, guildID)
+	db.transaction(() => {
+		for (const d of userAppDeletions) {
+			db.prepare("DELETE FROM app_user_install WHERE guild_id = ? and user_id = ?").run(guildID, d)
+		}
+	})()
+	for (const m of membership) {
+		await api.leaveRoom(m.room_id, m.mxid)
+	}
+}
+
+module.exports.removeMember = removeMember

src/d2m/actions/send-message.js

@@ -51,7 +51,7 @@ async function sendMessage(message, channel, guild, row) {
 		if (message.author.id === discord.application.id) {
 			// no need to sync the bot's own user
 		} else {
-			senderMxid = await registerUser.syncUser(message.author, message.member, channel, guild, roomID)
+			senderMxid = await registerUser.syncUser(message.author, message.member, channel, guild, roomID, message.interaction_metadata)
 		}
 	}
 

src/d2m/converters/message-to-event.test.components.js

@@ -65,7 +65,7 @@ test("message2event components: pk question mark output", async t => {
 			+ "<hr>"
 			+ "<blockquote><p><strong>System:</strong> INX (<code>xffgnx</code>)"
 			+ "<br><strong>Member:</strong> Lillith (<code>pphhoh</code>)"
-			+ "<br><strong>Sent by:</strong> infinidoge1337 (@unknown-user:)"
+			+ "<br><strong>Sent by:</strong> infinidoge1337 (<a href=\"https://matrix.to/#/@_ooye_infinidoge1337:cadence.moe\">@unknown-user</a>)"
 			+ "<br><br><strong>Account Roles (7)</strong>"
 			+ "<br>§b, !, ‼, Ears Port Ping, Ears Update Ping, Yttr Ping, unsup Ping</p>"
 			+ `🖼️ <a href="https://files.inx.moe/p/cdn/lillith.webp">https://files.inx.moe/p/cdn/lillith.webp</a>`

src/d2m/converters/remove-member-mxids.js

@@ -0,0 +1,38 @@
+// @ts-check
+
+const passthrough = require("../../passthrough")
+const {db, select, from} = passthrough
+
+/**
+ * @param {string} userID discord user ID that left
+ * @param {string} guildID discord guild ID that they left
+ */
+function removeMemberMxids(userID, guildID) {
+	// Get sims for user and remove
+	let membership = from("sim").join("sim_member", "mxid").join("channel_room", "room_id")
+		.select("room_id", "mxid").where({user_id: userID, guild_id: guildID}).and("ORDER BY room_id, mxid").all()
+	membership = membership.concat(from("sim_proxy").join("sim", "user_id").join("sim_member", "mxid").join("channel_room", "room_id")
+		.select("room_id", "mxid").where({proxy_owner_id: userID, guild_id: guildID}).and("ORDER BY room_id, mxid").all())
+
+	// Get user installed apps and remove
+	/** @type {string[]} */
+	let userAppDeletions = []
+	// 1. Select apps that have 1 user remaining
+	/** @type {Set<string>} */
+	const appsWithOneUser = new Set(db.prepare("SELECT app_bot_id FROM app_user_install WHERE guild_id = ? GROUP BY app_bot_id HAVING count(*) = 1").pluck().all(guildID))
+	// 2. Select apps installed by this user
+	const appsFromThisUser = new Set(select("app_user_install", "app_bot_id", {guild_id: guildID, user_id: userID}).pluck().all())
+	if (appsFromThisUser.size) userAppDeletions.push(userID)
+	// Then remove user installed apps if this was the last user with them
+	const appsToRemove = appsWithOneUser.intersection(appsFromThisUser)
+	for (const botID of appsToRemove) {
+		// Remove sims for user installed app
+		const appRemoval = removeMemberMxids(botID, guildID)
+		membership = membership.concat(appRemoval.membership)
+		userAppDeletions = userAppDeletions.concat(appRemoval.userAppDeletions)
+	}
+
+	return {membership, userAppDeletions}
+}
+
+module.exports.removeMemberMxids = removeMemberMxids

src/d2m/converters/remove-member-mxids.test.js

@@ -0,0 +1,43 @@
+// @ts-check
+
+const {test} = require("supertape")
+const {removeMemberMxids} = require("./remove-member-mxids")
+
+test("remove member mxids: would remove mxid for all rooms in this server", t => {
+	t.deepEqual(removeMemberMxids("772659086046658620", "112760669178241024"), {
+		userAppDeletions: [],
+		membership: [{
+			mxid: "@_ooye_cadence:cadence.moe",
+			room_id: "!fGgIymcYWOqjbSRUdV:cadence.moe"
+		}, {
+			mxid: "@_ooye_cadence:cadence.moe",
+			room_id: "!kLRqKKUQXcibIMtOpl:cadence.moe"
+		}]
+	})
+})
+
+test("remove member mxids: removes sims too", t => {
+	t.deepEqual(removeMemberMxids("196188877885538304", "112760669178241024"), {
+		userAppDeletions: [],
+		membership: [{
+			mxid: '@_ooye_ampflower:cadence.moe',
+			room_id: '!qzDBLKlildpzrrOnFZ:cadence.moe'
+		}, {
+			mxid: '@_ooye__pk_zoego:cadence.moe',
+			room_id: '!qzDBLKlildpzrrOnFZ:cadence.moe'
+		}]
+	})
+})
+
+test("remove member mxids: removes apps too", t => {
+	t.deepEqual(removeMemberMxids("197126718400626689", "66192955777486848"), {
+		userAppDeletions: ["197126718400626689"],
+		membership: [{
+			mxid: '@_ooye_infinidoge1337:cadence.moe',
+			room_id: '!BnKuBPCvyfOkhcUjEu:cadence.moe'
+		}, {
+			mxid: '@_ooye_evil_lillith_sheher:cadence.moe',
+			room_id: '!BnKuBPCvyfOkhcUjEu:cadence.moe'
+		}]
+	})
+})

src/d2m/discord-packets.js

@@ -49,8 +49,9 @@ const utils = {
 			if (listen === "full") {
 				try {
 					await eventDispatcher.checkMissedExpressions(message.d)
-					await eventDispatcher.checkMissedPins(client, message.d)
 					await eventDispatcher.checkMissedMessages(client, message.d)
+					await eventDispatcher.checkMissedPins(client, message.d)
+					await eventDispatcher.checkMissedLeaves(client, message.d)
 				} catch (e) {
 					console.error("Failed to sync missed events. To retry, please fix this error and restart OOYE:")
 					console.error(e)

src/d2m/event-dispatcher.js

@@ -32,6 +32,8 @@ const speedbump = sync.require("./actions/speedbump")
 const retrigger = sync.require("./actions/retrigger")
 /** @type {import("./actions/set-presence")} */
 const setPresence = sync.require("./actions/set-presence")
+/** @type {import("./actions/remove-member")} */
+const removeMember = sync.require("./actions/remove-member")
 /** @type {import("./actions/poll-vote")} */
 const vote = sync.require("./actions/poll-vote")
 /** @type {import("../m2d/event-dispatcher")} */
@@ -172,6 +174,31 @@ module.exports = {
 		await createSpace.syncSpaceExpressions(data, true)
 	},
 
+	/**
+	 * When logging back in, check if any members left while we were gone.
+	 * Do this by getting the member list from Discord and seeing who we still have locally that isn't there in the response.
+	 * @param {import("./discord-client")} client
+	 * @param {DiscordTypes.GatewayGuildCreateDispatchData} guild
+	 */
+	async checkMissedLeaves(client, guild) {
+		const maxLimit = 1000
+		if (guild.member_count >= maxLimit) return // too large to want to scan
+		const discordMembers = await client.snow.guild.getGuildMembers(guild.id, {limit: maxLimit})
+		if (discordMembers.length >= maxLimit) return // response was maxed out, there are guild members that weren't listed, can't act safely
+		const discordMembersSet = new Set(discordMembers.map(m => m.user.id))
+		// no indexes on this one but I'll cope
+		const membersAddedOnMatrix = new Set(from("sim").join("sim_member", "mxid").join("channel_room", "room_id")
+			.pluck("user_id").selectUnsafe("DISTINCT user_id").where({guild_id: guild.id}).and("AND user_id not like '%-%' and user_id not like '%\\_%' escape '\\'").all())
+		const userInstalledAppIDs = new Set(from("app_user_install").pluck("app_bot_id").selectUnsafe("DISTINCT app_bot_id").where({guild_id: guild.id}).all())
+		// loop over members added on matrix and if the member does not exist on discord-side then they should be removed
+		for (const userID of membersAddedOnMatrix) {
+			if (userInstalledAppIDs.has(userID)) continue // skip user installed apps here since they're never true members - they'll be removed by removeMember when the associated user is removed
+			if (!discordMembersSet.has(userID)) {
+				await removeMember.removeMember(userID, guild.id)
+			}
+		}
+	},
+
 	/**
 	 * Announces to the parent room that the thread room has been created.
 	 * See notes.md, "Ignore MESSAGE_UPDATE and bridge THREAD_CREATE as the announcement"
@@ -211,6 +238,14 @@ module.exports = {
 		}
 	},
 
+	/**
+	 * @param {import("./discord-client")} client
+	 * @param {DiscordTypes.GatewayGuildMemberRemoveDispatchData} data
+	 */
+	async GUILD_MEMBER_REMOVE(client, data) {
+		await removeMember.removeMember(data.user.id, data.guild_id)
+	},
+
 	/**
 	 * @param {import("./discord-client")} client
 	 * @param {DiscordTypes.GatewayChannelUpdateDispatchData} channelOrThread

src/db/migrations/0036-app-user-install.sql

@@ -0,0 +1,10 @@
+BEGIN TRANSACTION;
+
+CREATE TABLE "app_user_install" (
+	"guild_id"	TEXT NOT NULL,
+	"app_bot_id"	TEXT NOT NULL,
+	"user_id"	TEXT NOT NULL,
+	PRIMARY KEY ("guild_id", "app_bot_id", "user_id")
+) WITHOUT ROWID;
+
+COMMIT;

src/db/orm-defs.d.ts

@@ -1,4 +1,10 @@
 export type Models = {
+	app_user_install: {
+		guild_id: string
+		app_bot_id: string
+		user_id: string
+	}
+
 	auto_emoji: {
 		name: string
 		emoji_id: string