diff --git a/readme.md b/readme.md index deb98da..e8a8e7e 100644 --- a/readme.md +++ b/readme.md @@ -8,10 +8,6 @@ Modern Matrix-to-Discord appservice bridge, created by [@cadence:cadence.moe](ht ![](https://cadence.moe/i/f42a3f) -## AI policy - -Out Of Your Element is 100% organically cultivated ethical hand-fed code. Let's work together to conserve that! - ## Why a new bridge? * Modern: Supports new Discord features like replies, threads and stickers, and new Matrix features like edits, spaces and space membership. diff --git a/src/d2m/actions/register-pk-user.js b/src/d2m/actions/register-pk-user.js index bb8335b..e68d2cc 100644 --- a/src/d2m/actions/register-pk-user.js +++ b/src/d2m/actions/register-pk-user.js @@ -3,7 +3,6 @@ const assert = require("assert").strict const {reg} = require("../../matrix/read-registration") const Ty = require("../../types") -const {scheduler} = require("timers/promises") const passthrough = require("../../passthrough") const {sync, db, select, from} = passthrough @@ -15,21 +14,14 @@ const file = sync.require("../../matrix/file") const registerUser = sync.require("./register-user") /** @returns {Promise} */ -async function fetchMessage(messageID, attempt = 1) { +async function fetchMessage(messageID) { try { var res = await fetch(`https://api.pluralkit.me/v2/messages/${messageID}`) } catch (networkError) { // Network issue, raise a more readable message throw new Error(`Failed to connect to PK API: ${networkError.toString()}`) } - if (!res.ok) { - if (attempt < 2) { - await scheduler.wait(5000) - return fetchMessage(messageID, attempt + 1) - } else { - throw new Error(`PK API returned an error: ${await res.text()}`) - } - } + if (!res.ok) throw new Error(`PK API returned an error: ${await res.text()}`) /** @type {any} */ const root = await res.json() if (!root.member) throw new Error(`PK API didn't return member data: ${JSON.stringify(root)}`) diff --git a/src/d2m/actions/retrigger.js b/src/d2m/actions/retrigger.js index d7ac1a6..43f400d 100644 --- a/src/d2m/actions/retrigger.js +++ b/src/d2m/actions/retrigger.js @@ -41,7 +41,7 @@ const storage = new class { this.timers.set(id, setTimeout(() => this.resolve(id, false), 60 * 1000).unref()) // 1 minute } } - + /** @param {string} id */ isNotPaused(id) { return !storage.paused.has(id) @@ -98,7 +98,7 @@ function waitFor(id, resolve, existsInDatabase) { const GET_EVENT_PREPARED = from("event_message").select("event_id").and("WHERE event_id = ?").prepare().raw() /** * @param {string} eventID - * @returns {Promise} if false then the message did not arrive + * @returns {Promise} if true then the message did not arrive */ function waitForEvent(eventID) { const {promise, resolve} = Promise.withResolvers() @@ -109,7 +109,7 @@ function waitForEvent(eventID) { const GET_MESSAGE_PREPARED = from("event_message").select("message_id").and("WHERE message_id = ?").prepare().raw() /** * @param {string} messageID - * @returns {Promise} if false then the message did not arrive + * @returns {Promise} if true then the message did not arrive */ function waitForMessage(messageID) { const {promise, resolve} = Promise.withResolvers() @@ -120,7 +120,7 @@ function waitForMessage(messageID) { const GET_REACTION_EVENT_PREPARED = from("reaction").select("hashed_event_id").and("WHERE hashed_event_id = ?").prepare().raw() /** * @param {string} eventID - * @returns {Promise} if false then the message did not arrive + * @returns {Promise} if true then the message did not arrive */ function waitForReactionEvent(eventID) { const {promise, resolve} = Promise.withResolvers() @@ -156,4 +156,4 @@ module.exports.waitForMessage = waitForMessage module.exports.waitForEvent = waitForEvent module.exports.waitForReactionEvent = waitForReactionEvent module.exports.pauseChanges = pauseChanges -module.exports.finishedBridging = finishedBridging +module.exports.finishedBridging = finishedBridging \ No newline at end of file diff --git a/src/d2m/discord-client.js b/src/d2m/discord-client.js index 408c21c..b9b45e2 100644 --- a/src/d2m/discord-client.js +++ b/src/d2m/discord-client.js @@ -55,7 +55,9 @@ class DiscordClient { this.guildChannelMap = new Map() if (listen !== "no") { this.cloud.on("event", message => { - discordPackets.onPacket(this, message, listen) + process.nextTick(() => { + discordPackets.onPacket(this, message, listen) + }) }) } diff --git a/src/d2m/discord-packets.js b/src/d2m/discord-packets.js index 992689f..988f981 100644 --- a/src/d2m/discord-packets.js +++ b/src/d2m/discord-packets.js @@ -1,6 +1,6 @@ // @ts-check -const assert = require("assert").strict +const assert = require("assert") const {scheduler} = require("timers/promises") const passthrough = require("../passthrough") const {sync} = passthrough @@ -8,32 +8,7 @@ const {sync} = passthrough /** @type {import("../matrix/homeserver-status")} */ const homeserverStatus = sync.require("../matrix/homeserver-status") -const guildReadyStatus = new class { - /** @type {Set | null} */ - unavailableGuilds = null - _allReady = Promise.withResolvers() - - /** - * @param {string} guildID - * @returns {boolean} true if it was the last one - */ - makeReady(guildID) { - assert(this.unavailableGuilds) - if (this.unavailableGuilds.delete(guildID) && this.unavailableGuilds.size === 0) { - this._allReady.resolve(null) - return true - } - return false - } - - allReady() { - return this.unavailableGuilds && this.unavailableGuilds.size === 0 - } - - waitForAllReady() { - return this._allReady.promise - } -} +let checkedHomeserver = false /** * @param {import("./discord-client")} client @@ -53,27 +28,12 @@ async function onPacket(client, message, listen) { client.ready = true client.user = message.d.user client.application = message.d.application - guildReadyStatus.unavailableGuilds = new Set(message.d.guilds.filter(g => g.unavailable).map(g => g.id)) console.log(`Discord logged in as ${client.user.username}#${client.user.discriminator} (${client.user.id})`) - process.stdout.write("Waiting for guilds to warm up... ") interactions.registerInteractions() } else if (message.t === "GUILD_CREATE") { - message.d.members = message.d.members.filter(m => m.user.id === client.user.id) // only keep the bot account's member - it's needed for roles to determine private channels on web + message.d.members = message.d.members.filter(m => m.user.id === client.user.id) // only keep the bot's own member - it's needed to determine private channels on web client.guilds.set(message.d.id, message.d) - - /* - Info about guilds is populated one guild at a time. - For m->d bridging to work, the guild needs to be populated, so we need to have GUILD_CREATE for the guild. - If we ping the homeserver, it will send us any pending events, so we need to wait for all GUILD_CREATES before we ping. - We must attempt a ping because we don't want to try sending missed d->m messages to an offline homeserver. - The "all guilds ready" delay can be removed if ONE of the following is done: - 1. m->d can queue incoming events until their guild exists in memory - 2. d->m missed messages can have their errors handled and added to queue, rather than pinging first - */ - const firstReady = guildReadyStatus.allReady() - const lastGuildReady = guildReadyStatus.makeReady(message.d.id) - const arr = [] client.guildChannelMap.set(message.d.id, arr) for (const channel of message.d.channels || []) { @@ -91,14 +51,28 @@ async function onPacket(client, message, listen) { if (listen === "full") { try { - // Wait for guilds to be connected and homeserver to be online. If this is the last guild, a different code path is used to trigger the homeserver check. - if (lastGuildReady) { - process.stdout.write(`ok, ${client.guilds.size} available.\nConnecting to homeserver... `) - // await guildReadyStatus.waitForAllReady() - no need, we already checked this is the last guild + /* + Info about guilds is populated one guild at a time. + For m->d bridging to work, the guild needs to be populated, so we need to have GUILD_CREATE for the guild. + If we ping the homeserver, it will send us any pending events, so we need to wait for all GUILD_CREATES before we ping. + We must attempt a ping because we don't want to try sending missed d->m messages to an offline homeserver. + This delay can be removed if ONE of the following is done: + 1. m->d can queue incoming events until their guild exists in memory + 2. d->m missed messages can have their errors handled and added to queue, rather than pinging first + */ + let isMainCharacter = false + if (!checkedHomeserver) { + checkedHomeserver = true + isMainCharacter = true + console.log("Warming up guilds~") + } + await scheduler.wait(5000) + if (isMainCharacter) { + checkedHomeserver = true + process.stdout.write("Connecting to homeserver... ") await homeserverStatus.homeserverStatus.waitForOnline(true) console.log("ok.\nReplaying past events. Welcome to Out Of Your Element.") } else { - await guildReadyStatus.waitForAllReady() await homeserverStatus.homeserverStatus.waitForOnline(false) } @@ -107,9 +81,7 @@ async function onPacket(client, message, listen) { await eventDispatcher.checkMissedPins(client, message.d) await eventDispatcher.checkMissedLeaves(client, message.d) } catch (e) { - if (firstReady) { - console.error("Failed to sync missed events. To retry, please fix this error and restart OOYE:") - } + console.error("Failed to sync missed events. To retry, please fix this error and restart OOYE:") console.error(e) } } @@ -253,4 +225,3 @@ async function dispatchPacketToBridge(client, message) { module.exports.onPacket = onPacket module.exports.dispatchPacketToBridge = dispatchPacketToBridge -module.exports.guildReadyStatus = guildReadyStatus diff --git a/src/m2d/actions/send-event.js b/src/m2d/actions/send-event.js index 2e6bf5c..00557a1 100644 --- a/src/m2d/actions/send-event.js +++ b/src/m2d/actions/send-event.js @@ -153,7 +153,7 @@ async function sendEvent(event) { channel_id: messageResponse.channel_id, guild_id: guild.id, embeds: messageResponse.embeds - }, guild) + }, guild, null) ) } } diff --git a/src/m2d/converters/event-to-message.js b/src/m2d/converters/event-to-message.js index a017e99..ea53e0a 100644 --- a/src/m2d/converters/event-to-message.js +++ b/src/m2d/converters/event-to-message.js @@ -32,8 +32,6 @@ const setupEmojis = sync.require("../actions/setup-emojis") const userToMxid = sync.require("../../d2m/converters/user-to-mxid") /** @type {import("../../web/routes/letter-avatar")} */ const letterAvatar = sync.require("../../web/routes/letter-avatar") -/** @type {import("../../d2m/actions/retrigger")} */ -const retrigger = sync.require("../../d2m/actions/retrigger") /** @type {[RegExp, string][]} */ const markdownEscapes = [ @@ -698,7 +696,6 @@ async function eventToMessage(event, guild, channel, di) { // Check if we have a pointer to what was edited const originalEventId = relatesTo.event_id if (!originalEventId) return - if (!await retrigger.waitForEvent(originalEventId)) return messageIDsToEdit = select("event_message", "message_id", {event_id: originalEventId}, "ORDER BY part").pluck().all() if (!messageIDsToEdit.length) return @@ -757,7 +754,7 @@ async function eventToMessage(event, guild, channel, di) { .replace(/(?:\n|
)+/g, " ") // Should all be on one line .replace(/]*data-mx-spoiler\b[^>]*>.*?<\/span>/g, "[spoiler]") // Good enough method of removing spoiler content. (I don't want to break out the HTML parser unless I have to.) .replace(/<[^>]+>/g, "") // Completely strip all HTML tags and formatting. - ), 50) + ), 65) replyLine = "-# > " + contentPreviewChunks[0] if (contentPreviewChunks.length > 1) replyLine = replyLine.replace(/[,.']$/, "") + "..." replyLine += "\n" @@ -765,11 +762,6 @@ async function eventToMessage(event, guild, channel, di) { } replyLine = await getL1L2ReplyLine() - const row = from("event_message").join("message_room", "message_id").join("historical_channel_room", "historical_room_index") - .select("reference_channel_id", "message_id").where({event_id: repliedToEventId}).and("ORDER BY part").get() - if (row) { - replyLine += `https://discord.com/channels/${guild.id}/${row.reference_channel_id}/${row.message_id} ` - } // If the event has been edited, the homeserver will include the relation in `unsigned`. if (repliedToEvent.unsigned?.["m.relations"]?.["m.replace"]?.content?.["m.new_content"]) { repliedToEvent = repliedToEvent.unsigned["m.relations"]["m.replace"] // Note: this changes which event_id is in repliedToEvent. @@ -780,15 +772,15 @@ async function eventToMessage(event, guild, channel, di) { const fileReplyContentAlternative = attachmentEmojis.get(repliedToEvent.content.msgtype) let contentPreview if (fileReplyContentAlternative) { - contentPreview = " " + fileReplyContentAlternative + contentPreview = fileReplyContentAlternative } else if (repliedToEvent.unsigned?.redacted_because) { - contentPreview = " (in reply to a deleted message)" + contentPreview = "(in reply to a deleted message)" } else if (typeof originalRepliedToContent !== "string") { // in reply to a weird metadata event like m.room.name, m.room.member... // I'm not implementing text fallbacks for arbitrary room events. this should cover most cases // this has never ever happened in the wild anyway repliedToEvent.sender = "" - contentPreview = " (channel details edited)" + contentPreview = "(channel details edited)" } else { // Generate a reply preview for a standard message let repliedToContent = originalRepliedToContent @@ -805,7 +797,7 @@ async function eventToMessage(event, guild, channel, di) { repliedToContent = entities.decodeHTML5Strict(repliedToContent) // Remove entities like & " const contentPreviewChunks = chunk(repliedToContent, 50) if (contentPreviewChunks.length) { - contentPreview = ": " + contentPreviewChunks[0] + contentPreview = contentPreviewChunks[0] contentPreview = contentPreview.replace(/\bhttps?:\/\/[^ )]*/g, url => { const originalUrlIndex = originalRepliedToContent.indexOf(url) if (originalUrlIndex !== -1 && originalRepliedToContent[originalUrlIndex + url.length]?.match(/[^ )>"'`]/)) { // URL was truncated by chunking, replace it @@ -832,7 +824,12 @@ async function eventToMessage(event, guild, channel, di) { if (!senderName) senderName = sender.match(/@([^:]*)/)?.[1] if (senderName) replyLine += `**Ⓜ${senderName}**` } - replyLine = `-# > ${replyLine}${contentPreview}\n` + const row = from("event_message").join("message_room", "message_id").join("historical_channel_room", "historical_room_index") + .select("reference_channel_id", "message_id").where({event_id: repliedToEventId}).and("ORDER BY part").get() + if (row) { + contentPreview = `[${contentPreview}]()` + } + replyLine = `-# > ${replyLine} ${contentPreview}\n` })() if (shouldProcessTextEvent) {