feat: make the Application Command Registries status listeners optional (#627)

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

Author: favna

src/lib/SapphireClient.ts

@@ -106,6 +106,14 @@ export interface SapphireClientOptions {
 	 */
 	enableLoaderTraceLoggings?: boolean;
 
+	/**
+	 * If Sapphire should load the pre-included application command registries status listeners that log the status of registering application commands to the {@link SapphireClient.logger} instance.
+	 * This includes the events {@link Events.ApplicationCommandRegistriesInitialising} and {@link Events.ApplicationCommandRegistriesRegistered}.
+	 * @since 4.4.0
+	 * @default true
+	 */
+	loadApplicationCommandRegistriesStatusListeners?: boolean;
+
 	/**
 	 * If Sapphire should load the pre-included error event listeners that log any encountered errors to the {@link SapphireClient.logger} instance
 	 * @since 1.0.0
@@ -299,6 +307,10 @@ export class SapphireClient<Ready extends boolean = boolean> extends Client<Read
 
 		const optionalListenersPath = join(__dirname, '..', 'optional-listeners');
 
+		if (options.loadApplicationCommandRegistriesStatusListeners !== false) {
+			this.stores.get('listeners').registerPath(join(optionalListenersPath, 'application-command-registries-listeners'));
+		}
+
 		if (options.loadDefaultErrorListeners !== false) {
 			this.stores.get('listeners').registerPath(join(optionalListenersPath, 'error-listeners'));
 		}

src/lib/types/Events.ts

@@ -205,6 +205,11 @@ export const Events = {
 	 */
 	CommandApplicationCommandRegistryError: 'commandApplicationCommandRegistryError' as const,
 
+	/**
+	 * Emitted when the application command registries are being initialized.
+	 */
+	ApplicationCommandRegistriesInitialising: 'applicationCommandRegistriesInitialising' as const,
+
 	/**
 	 * Emitted once the application command registries have been initialized.
 	 * @param {Map<string, ApplicationCommandRegistry>} registries The initialised registries
@@ -566,7 +571,8 @@ declare module 'discord.js' {
 
 		[SapphireEvents.ListenerError]: [error: unknown, payload: ListenerErrorPayload];
 		[SapphireEvents.CommandApplicationCommandRegistryError]: [error: unknown, command: Command];
-		[SapphireEvents.ApplicationCommandRegistriesRegistered]: [registries: Map<string, ApplicationCommandRegistry>];
+		[SapphireEvents.ApplicationCommandRegistriesInitialising]: [];
+		[SapphireEvents.ApplicationCommandRegistriesRegistered]: [registries: Map<string, ApplicationCommandRegistry>, timeTaken: number];
 		[SapphireEvents.ApplicationCommandRegistriesBulkOverwriteError]: [error: unknown, guildId: string | null];
 
 		[SapphireEvents.PreMessageParsed]: [message: Message];

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

@@ -47,6 +47,8 @@ export function getDefaultBehaviorWhenNotIdentical() {
 }
 
 export async function handleRegistryAPICalls() {
+	container.client.emit(Events.ApplicationCommandRegistriesInitialising);
+
 	const commandStore = container.stores.get('commands');
 
 	for (const command of commandStore.values()) {
@@ -70,6 +72,8 @@ export async function handleRegistryAPICalls() {
 }
 
 export async function handleBulkOverwrite(commandStore: CommandStore, applicationCommands: ApplicationCommandManager) {
+	const now = Date.now();
+
 	// Map registries by guild, global, etc
 	const foundGlobalCommands: BulkOverwriteData[] = [];
 	const foundGuildCommands: Record<string, BulkOverwriteData[]> = {};
@@ -164,13 +168,15 @@ export async function handleBulkOverwrite(commandStore: CommandStore, applicatio
 		}
 	}
 
-	container.client.emit(Events.ApplicationCommandRegistriesRegistered, registries);
+	container.client.emit(Events.ApplicationCommandRegistriesRegistered, registries, Date.now() - now);
 }
 
 async function handleAppendOrUpdate(
 	commandStore: CommandStore,
 	{ applicationCommands, globalCommands, guildCommands }: Awaited<ReturnType<typeof getNeededRegistryParameters>>
 ) {
+	const now = Date.now();
+
 	for (const registry of registries.values()) {
 		// eslint-disable-next-line @typescript-eslint/dot-notation
 		await registry['runAPICalls'](applicationCommands, globalCommands, guildCommands);
@@ -188,7 +194,7 @@ async function handleAppendOrUpdate(
 		}
 	}
 
-	container.client.emit(Events.ApplicationCommandRegistriesRegistered, registries);
+	container.client.emit(Events.ApplicationCommandRegistriesRegistered, registries, Date.now() - now);
 }
 
 interface BulkOverwriteData {

src/listeners/CoreReady.ts

@@ -10,12 +10,6 @@ export class CoreEvent extends Listener {
 	public async run() {
 		this.container.client.id ??= this.container.client.user?.id ?? null;
 
-		this.container.logger.info(`ApplicationCommandRegistries: Initializing...`);
-
-		const now = Date.now();
 		await handleRegistryAPICalls();
-		const diff = Date.now() - now;
-
-		this.container.logger.info(`ApplicationCommandRegistries: Took ${diff.toLocaleString()}ms to initialize.`);
 	}
 }

src/optional-listeners/application-command-registries-listeners/CoreApplicationCommandRegistriesInitialising.ts

@@ -0,0 +1,12 @@
+import { Listener } from '../../lib/structures/Listener';
+import { Events } from '../../lib/types/Events';
+
+export class CoreEvent extends Listener<typeof Events.ApplicationCommandRegistriesInitialising> {
+	public constructor(context: Listener.Context) {
+		super(context, { event: Events.ApplicationCommandRegistriesInitialising, once: true });
+	}
+
+	public run() {
+		this.container.logger.info('ApplicationCommandRegistries: Initializing...');
+	}
+}

src/optional-listeners/application-command-registries-listeners/CoreApplicationCommandRegistriesRegistered.ts

@@ -0,0 +1,13 @@
+import { Listener } from '../../lib/structures/Listener';
+import { Events } from '../../lib/types/Events';
+import type { ApplicationCommandRegistry } from '../../lib/utils/application-commands/ApplicationCommandRegistry';
+
+export class CoreEvent extends Listener<typeof Events.ApplicationCommandRegistriesRegistered> {
+	public constructor(context: Listener.Context) {
+		super(context, { event: Events.ApplicationCommandRegistriesRegistered, once: true });
+	}
+
+	public run(_registries: Map<string, ApplicationCommandRegistry>, timeTaken: number) {
+		this.container.logger.info(`ApplicationCommandRegistries: Took ${timeTaken.toLocaleString()}ms to initialize.`);
+	}
+}