fix(ApplicationCommandRegistries): emit event if user is listening for bulk overwrites errors (#622)

Author: vladfrangu

src/lib/structures/Command.ts

@@ -14,8 +14,8 @@ import { Args } from '../parsers/Args';
 import { BucketScope, RegisterBehavior } from '../types/Enums';
 import { acquire, getDefaultBehaviorWhenNotIdentical, handleBulkOverwrite } from '../utils/application-commands/ApplicationCommandRegistries';
 import type { ApplicationCommandRegistry } from '../utils/application-commands/ApplicationCommandRegistry';
-import { emitRegistryError } from '../utils/application-commands/emitRegistryError';
 import { getNeededRegistryParameters } from '../utils/application-commands/getNeededParameters';
+import { emitPerRegistryError } from '../utils/application-commands/registriesErrors';
 import { PreconditionContainerArray, type PreconditionEntryResolvable } from '../utils/preconditions/PreconditionContainerArray';
 import { FlagUnorderedStrategy, type FlagStrategyOptions } from '../utils/strategies/FlagUnorderedStrategy';
 import type { CommandStore } from './CommandStore';
@@ -293,7 +293,7 @@ export class Command<PreParseReturn = Args, O extends Command.Options = Command.
 			try {
 				await updatedPiece.registerApplicationCommands(updatedRegistry);
 			} catch (err) {
-				emitRegistryError(err, updatedPiece);
+				emitPerRegistryError(err, updatedPiece);
 				// No point on continuing
 				return;
 			}

src/lib/structures/CommandStore.ts

@@ -6,8 +6,8 @@ import {
 	handleBulkOverwrite,
 	registries
 } from '../utils/application-commands/ApplicationCommandRegistries';
-import { emitRegistryError } from '../utils/application-commands/emitRegistryError';
 import { getNeededRegistryParameters } from '../utils/application-commands/getNeededParameters';
+import { emitPerRegistryError } from '../utils/application-commands/registriesErrors';
 import { Command } from './Command';
 
 /**
@@ -65,7 +65,7 @@ export class CommandStore extends AliasStore<Command> {
 				try {
 					await command.registerApplicationCommands(command.applicationCommandRegistry);
 				} catch (error) {
-					emitRegistryError(error, command);
+					emitPerRegistryError(error, command);
 				}
 			}
 		}

src/lib/types/Events.ts

@@ -211,6 +211,13 @@ export const Events = {
 	 */
 	ApplicationCommandRegistriesRegistered: 'applicationCommandRegistriesRegistered' as const,
 
+	/**
+	 * Emitted when an error is encountered when handling the command registries in bulk overwrite mode.
+	 * @param {*} error The error that was thrown
+	 * @param {string|null} guildId The guild id where the error was thrown
+	 */
+	ApplicationCommandRegistriesBulkOverwriteError: 'applicationCommandRegistriesBulkOverwriteError' as const,
+
 	// Piece store?
 	/**
 	 * Emitted after a piece is loaded.
@@ -560,6 +567,7 @@ declare module 'discord.js' {
 		[SapphireEvents.ListenerError]: [error: unknown, payload: ListenerErrorPayload];
 		[SapphireEvents.CommandApplicationCommandRegistryError]: [error: unknown, command: Command];
 		[SapphireEvents.ApplicationCommandRegistriesRegistered]: [registries: Map<string, ApplicationCommandRegistry>];
+		[SapphireEvents.ApplicationCommandRegistriesBulkOverwriteError]: [error: unknown, guildId: string | null];
 
 		[SapphireEvents.PreMessageParsed]: [message: Message];
 		[SapphireEvents.MentionPrefixOnly]: [message: Message];

src/lib/utils/application-commands/ApplicationCommandRegistries.ts

@@ -6,9 +6,9 @@ import type { CommandStore } from '../../structures/CommandStore';
 import { RegisterBehavior } from '../../types/Enums';
 import { Events } from '../../types/Events';
 import { ApplicationCommandRegistry } from './ApplicationCommandRegistry';
-import { emitRegistryError } from './emitRegistryError';
 import { getNeededRegistryParameters } from './getNeededParameters';
-import { bulkOverwriteDebug, bulkOverwriteError, bulkOverwriteInfo, bulkOverwriteWarn } from './registriesLog';
+import { emitBulkOverwriteError, emitPerRegistryError } from './registriesErrors';
+import { bulkOverwriteDebug, bulkOverwriteInfo, bulkOverwriteWarn } from './registriesLog';
 
 export let defaultBehaviorWhenNotIdentical = RegisterBehavior.Overwrite;
 
@@ -54,7 +54,7 @@ export async function handleRegistryAPICalls() {
 			try {
 				await command.registerApplicationCommands(command.applicationCommandRegistry);
 			} catch (error) {
-				emitRegistryError(error, command);
+				emitPerRegistryError(error, command);
 			}
 		}
 	}
@@ -121,7 +121,7 @@ export async function handleBulkOverwrite(commandStore: CommandStore, applicatio
 
 		bulkOverwriteInfo(`Successfully overwrote global application commands. The application now has ${result.size} global commands`);
 	} catch (error) {
-		bulkOverwriteError(`Failed to overwrite global application commands`, error);
+		emitBulkOverwriteError(error, null);
 	}
 
 	// Handle guild commands
@@ -160,9 +160,11 @@ export async function handleBulkOverwrite(commandStore: CommandStore, applicatio
 				`Successfully overwrote guild application commands for guild ${guildId}. The application now has ${result.size} guild commands for guild ${guildId}`
 			);
 		} catch (error) {
-			bulkOverwriteError(`Failed to overwrite guild application commands for guild ${guildId}`, error);
+			emitBulkOverwriteError(error, guildId);
 		}
 	}
+
+	container.client.emit(Events.ApplicationCommandRegistriesRegistered, registries);
 }
 
 async function handleAppendOrUpdate(

src/lib/utils/application-commands/emitRegistryError.ts

@@ -0,0 +1,40 @@
+import { container } from '@sapphire/pieces';
+import type { Command } from '../../structures/Command';
+import { Events } from '../../types/Events';
+import { bulkOverwriteError } from './registriesLog';
+
+/**
+ * Opinionatedly logs the encountered registry error.
+ * @param error The emitted error
+ * @param command The command which had the error
+ */
+export function emitPerRegistryError(error: unknown, command: Command<any, any>) {
+	const { name, location } = command;
+	const { client, logger } = container;
+
+	if (client.listenerCount(Events.CommandApplicationCommandRegistryError)) {
+		client.emit(Events.CommandApplicationCommandRegistryError, error, command);
+	} else {
+		logger.error(
+			`Encountered error while handling the command application command registry for command "${name}" at path "${location.full}"`,
+			error
+		);
+	}
+}
+
+/**
+ * Opinionatedly logs any bulk overwrite registries error.
+ * @param error The emitted error
+ * @param guildId The guild id in which the error was caused
+ */
+export function emitBulkOverwriteError(error: unknown, guildId: string | null) {
+	const { client } = container;
+
+	if (client.listenerCount(Events.ApplicationCommandRegistriesBulkOverwriteError)) {
+		client.emit(Events.ApplicationCommandRegistriesBulkOverwriteError, error, guildId);
+	} else if (guildId) {
+		bulkOverwriteError(`Failed to overwrite guild application commands for guild ${guildId}`, error);
+	} else {
+		bulkOverwriteError(`Failed to overwrite global application commands`, error);
+	}
+}