companion_channels: handle errors gracefully

backend/src/plugins/CompanionChannels/CompanionChannelsPlugin.ts

@@ -4,6 +4,8 @@ import { VoiceChannelJoinEvt } from "./events/VoiceChannelJoinEvt";
 import { VoiceChannelSwitchEvt } from "./events/VoiceChannelSwitchEvt";
 import { VoiceChannelLeaveEvt } from "./events/VoiceChannelLeaveEvt";
 import { trimPluginDescription } from "../../utils";
+import { LogsPlugin } from "../Logs/LogsPlugin";
+import { CooldownManager } from "knub";
 
 const defaultOptions = {
   config: {
@@ -22,8 +24,13 @@ export const CompanionChannelsPlugin = zeppelinPlugin<CompanionChannelsPluginTyp
     `),
   },
 
+  dependencies: [LogsPlugin],
   configSchema: ConfigSchema,
   defaultOptions,
 
   events: [VoiceChannelJoinEvt, VoiceChannelSwitchEvt, VoiceChannelLeaveEvt],
+
+  onLoad(pluginData) {
+    pluginData.state.errorCooldownManager = new CooldownManager();
+  },
 });

backend/src/plugins/CompanionChannels/functions/handleCompanionPermissions.ts

@@ -2,25 +2,35 @@ import { CompanionChannelsPluginType, TCompanionChannelOpts } from "../types";
 import { getCompanionChannelOptsForVoiceChannelId } from "./getCompanionChannelOptsForVoiceChannelId";
 import { PluginData } from "knub";
 import { TextChannel } from "eris";
+import { isDiscordRESTError, MINUTES } from "../../../utils";
+import { LogsPlugin } from "../../Logs/LogsPlugin";
+import { LogType } from "../../../data/LogType";
 
-export function handleCompanionPermissions(
+const ERROR_COOLDOWN_KEY = "errorCooldown";
+const ERROR_COOLDOWN = 5 * MINUTES;
+
+export async function handleCompanionPermissions(
   pluginData: PluginData<CompanionChannelsPluginType>,
   userId: string,
   voiceChannelId: string,
   oldChannelId?: string,
 );
-export function handleCompanionPermissions(
+export async function handleCompanionPermissions(
   pluginData: PluginData<CompanionChannelsPluginType>,
   userId: string,
   voiceChannelId: null,
   oldChannelId: string,
 );
-export function handleCompanionPermissions(
+export async function handleCompanionPermissions(
   pluginData: PluginData<CompanionChannelsPluginType>,
   userId: string,
   voiceChannelId?: string,
   oldChannelId?: string,
 ) {
+  if (pluginData.state.errorCooldownManager.isOnCooldown(ERROR_COOLDOWN_KEY)) {
+    return;
+  }
+
   const permsToDelete: Set<string> = new Set(); // channelId[]
   const oldPerms: Map<string, number> = new Map(); // channelId => permissions
   const permsToSet: Map<string, number> = new Map(); // channelId => permissions
@@ -51,15 +61,34 @@ export function handleCompanionPermissions(
     }
   }
 
-  for (const channelId of permsToDelete) {
+  try {
-    const channel = pluginData.guild.channels.get(channelId);
+    for (const channelId of permsToDelete) {
-    if (!channel || !(channel instanceof TextChannel)) continue;
+      const channel = pluginData.guild.channels.get(channelId);
-    channel.deletePermission(userId, `Companion Channel for ${oldChannelId} | User Left`);
+      if (!channel || !(channel instanceof TextChannel)) continue;
-  }
+      await channel.deletePermission(userId, `Companion Channel for ${oldChannelId} | User Left`);
+    }
 
-  for (const [channelId, permissions] of permsToSet) {
+    for (const [channelId, permissions] of permsToSet) {
-    const channel = pluginData.guild.channels.get(channelId);
+      const channel = pluginData.guild.channels.get(channelId);
-    if (!channel || !(channel instanceof TextChannel)) continue;
+      if (!channel || !(channel instanceof TextChannel)) continue;
-    channel.editPermission(userId, permissions, 0, "member", `Companion Channel for ${voiceChannelId} | User Joined`);
+      await channel.editPermission(
+        userId,
+        permissions,
+        0,
+        "member",
+        `Companion Channel for ${voiceChannelId} | User Joined`,
+      );
+    }
+  } catch (e) {
+    if (isDiscordRESTError(e) && e.code === 50001) {
+      const logs = pluginData.getPlugin(LogsPlugin);
+      logs.log(LogType.BOT_ALERT, {
+        body: `Missing permissions to handle companion channels. Pausing companion channels for 5 minutes or until the bot is reloaded on this server.`,
+      });
+      pluginData.state.errorCooldownManager.setCooldown(ERROR_COOLDOWN_KEY, ERROR_COOLDOWN);
+      return;
+    }
+
+    throw e;
   }
 }

backend/src/plugins/CompanionChannels/types.ts

@@ -1,6 +1,6 @@
 import * as t from "io-ts";
 import { tNullable } from "../../utils";
-import { BasePluginType } from "knub";
+import { BasePluginType, CooldownManager } from "knub";
 import { GuildLogs } from "../../data/GuildLogs";
 import { GuildSavedMessages } from "../../data/GuildSavedMessages";
 
@@ -24,5 +24,7 @@ export interface ICompanionChannelMap {
 
 export interface CompanionChannelsPluginType extends BasePluginType {
   config: TConfigSchema;
-  state: {};
+  state: {
+    errorCooldownManager: CooldownManager;
+  };
 }