Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: M -> D native discord edits #819

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

feat: M -> D native discord edits #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c32233
Change misleading variable name
Vyquos Oct 12, 2022
f8e9449
Bridge edits to discord webhooks
Vyquos Oct 12, 2022
8098baf
Add changelog
Vyquos Oct 12, 2022
b1f0eed
Fix changelog typo
Vyquos Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/819.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Bridge edits on Matrix to native Discord edits, instead of deleting and resending messages.
118 changes: 70 additions & 48 deletions src/bot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,12 +516,12 @@ export class DiscordBot {
opts: Discord.MessageOptions,
roomLookup: ChannelLookupResult,
event: IMatrixEvent,
editEventId: string,
editedEventId: string,
): Promise<void> {
const chan = roomLookup.channel;
const botUser = roomLookup.botUser;
const embed = embedSet.messageEmbed;
const oldMsg = await chan.messages.fetch(editEventId);
const oldMsg = await chan.messages.fetch(editedEventId);
if (!oldMsg) {
// old message not found, just sending this normally
await this.send(embedSet, opts, roomLookup, event);
Expand All @@ -539,41 +539,78 @@ export class DiscordBot {
} catch (err) {
log.warning("Failed to edit discord message, falling back to delete and resend...", err);
}
} else {
let hook = await this.getWebhook(chan);
try {
if (hook) {
// do we need to delete the event off of the store?
// the edit may bridge over back to matrix otherwise
const embeds = this.prepareEmbedSetWebhook(embedSet);
hook.editMessage(oldMsg, embed.description, {
avatarURL: embed!.author!.iconURL,
embeds,
files: opts.files,
username: embed!.author!.name,
})
this.channelLock.release(chan.id);
} else {
// fallback: use the old method for editing messages of
// simply (re)sending them.
if (editedEventId === this.lastEventIds[chan.id]) {
log.info("Immediate edit, deleting and re-sending");
this.channelLock.set(chan.id);
// we need to delete the event off of the store
// else the delete bridges over back to matrix
const dbEvent = await this.store.Get(DbEvent, { discord_id: editedEventId });
log.verbose("Event to delete", dbEvent);
if (dbEvent && dbEvent.Next()) {
await this.store.Delete(dbEvent);
}
await oldMsg.delete();
this.channelLock.release(chan.id);
const msg = await this.send(embedSet, opts, roomLookup, event, true);
// we re-insert the old matrix event with the new discord id
// to allow consecutive edits, as matrix edits are typically
// done on the original event
const dummyEvent = {
event_id: event.content!["m.relates_to"].event_id,
room_id: event.room_id,
} as IMatrixEvent;
this.StoreMessagesSent(msg, chan, dummyEvent).catch(() => {
log.warn("Failed to store edit sent message for ", event.event_id);
});
return;
}
const link = `https://discord.com/channels/${chan.guild.id}/${chan.id}/${editedEventId}`;
embedSet.messageEmbed.description = `[Edit](${link}): ${embedSet.messageEmbed.description}`;
await this.send(embedSet, opts, roomLookup, event);
}
} catch (err) {
// throw wrapError(err, Unstable.ForeignNetworkError, "Couldn't edit message");
log.warn(`Failed to edit message ${event.event_id}`);
log.verbose(err);
}
}
}

public async getWebhook(channel: Discord.TextChannel): Promise<Discord.Webhook | undefined> {
const webhooks = await channel.fetchWebhooks();
let hook: Discord.Webhook | undefined = webhooks.filter((h) => h.name === "_matrix").first();
// Create a new webhook if none already exists
try {
if (editEventId === this.lastEventIds[chan.id]) {
log.info("Immediate edit, deleting and re-sending");
this.channelLock.set(chan.id);
// we need to delete the event off of the store
// else the delete bridges over back to matrix
const dbEvent = await this.store.Get(DbEvent, { discord_id: editEventId });
log.verbose("Event to delete", dbEvent);
if (dbEvent && dbEvent.Next()) {
await this.store.Delete(dbEvent);
}
await oldMsg.delete();
this.channelLock.release(chan.id);
const msg = await this.send(embedSet, opts, roomLookup, event, true);
// we re-insert the old matrix event with the new discord id
// to allow consecutive edits, as matrix edits are typically
// done on the original event
const dummyEvent = {
event_id: event.content!["m.relates_to"].event_id,
room_id: event.room_id,
} as IMatrixEvent;
this.StoreMessagesSent(msg, chan, dummyEvent).catch(() => {
log.warn("Failed to store edit sent message for ", event.event_id);
});
return;
if (!hook) {
hook = await channel.createWebhook(
"_matrix",
{
avatar: MATRIX_ICON_URL,
reason: "Matrix Bridge: Allow rich user messages",
});
}
const link = `https://discord.com/channels/${chan.guild.id}/${chan.id}/${editEventId}`;
embedSet.messageEmbed.description = `[Edit](${link}): ${embedSet.messageEmbed.description}`;
await this.send(embedSet, opts, roomLookup, event);
} catch (err) {
// throw wrapError(err, Unstable.ForeignNetworkError, "Couldn't edit message");
log.warn(`Failed to edit message ${event.event_id}`);
log.verbose(err);
// throw wrapError(err, Unstable.ForeignNetworkError, "Unable to create \"_matrix\" webhook");
log.warn("Unable to create _matrix webook:", err);
}
return hook
}

/**
Expand All @@ -594,22 +631,7 @@ export class DiscordBot {
let msg: Discord.Message | null | (Discord.Message | null)[] = null;
let hook: Discord.Webhook | undefined;
if (botUser) {
const webhooks = await chan.fetchWebhooks();
hook = webhooks.filter((h) => h.name === "_matrix").first();
// Create a new webhook if none already exists
try {
if (!hook) {
hook = await chan.createWebhook(
"_matrix",
{
avatar: MATRIX_ICON_URL,
reason: "Matrix Bridge: Allow rich user messages",
});
}
} catch (err) {
// throw wrapError(err, Unstable.ForeignNetworkError, "Unable to create \"_matrix\" webhook");
log.warn("Unable to create _matrix webook:", err);
}
hook = await this.getWebhook(chan);
}
try {
this.channelLock.set(chan.id);
Expand Down