refactor: use interfaces for AsyncEventEmitter event maps (#10044)

* refactor: use interfaces for AsyncEventEmitter event maps * refactor: apply suggestions from code review and add tests * refactor: better errors on missing dispatch types
discordjs · Dec 14, 2023 · adfd9cd · adfd9cd
1 parent f2138bb
commit adfd9cd
Show file tree

Hide file tree

Showing 11 changed files with 102 additions and 66 deletions.
diff --git a/packages/brokers/package.json b/packages/brokers/package.json
@@ -67,7 +67,7 @@
 	"homepage": "https://discord.js.org",
 	"dependencies": {
 		"@msgpack/msgpack": "^3.0.0-beta2",
-		"@vladfrangu/async_event_emitter": "^2.2.2",
+		"@vladfrangu/async_event_emitter": "^2.2.4",
 		"ioredis": "^5.3.2"
 	},
 	"devDependencies": {

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -68,7 +68,7 @@
 		"@discordjs/util": "workspace:^",
 		"@discordjs/ws": "workspace:^",
 		"@sapphire/snowflake": "^3.5.1",
-		"@vladfrangu/async_event_emitter": "^2.2.2",
+		"@vladfrangu/async_event_emitter": "^2.2.4",
 		"discord-api-types": "0.37.61"
 	},
 	"devDependencies": {

diff --git a/packages/core/src/client.ts b/packages/core/src/client.ts
@@ -163,9 +163,7 @@ export interface MappedEvents {
 	[GatewayDispatchEvents.WebhooksUpdate]: [WithIntrinsicProps<GatewayWebhooksUpdateDispatchData>];
 }
 
-export type ManagerShardEventsMap = {
-	[K in keyof MappedEvents]: MappedEvents[K];
-};
+export interface ManagerShardEventsMap extends MappedEvents {}
 
 export interface ClientOptions {
 	gateway: Gateway;
@@ -179,7 +177,7 @@ export interface RequestGuildMembersResult {
 	presences: NonNullable<GatewayGuildMembersChunkDispatchData['presences']>;
 }
 
-export class Client extends AsyncEventEmitter<ManagerShardEventsMap> {
+export class Client extends AsyncEventEmitter<MappedEvents> {
 	public readonly rest: REST;
 
 	public readonly gateway: Gateway;
@@ -193,8 +191,12 @@ export class Client extends AsyncEventEmitter<ManagerShardEventsMap> {
 		this.api = new API(rest);
 
 		this.gateway.on(WebSocketShardEvents.Dispatch, ({ data: dispatch, shardId }) => {
-			// @ts-expect-error event props can't be resolved properly, but they are correct
-			this.emit(dispatch.t, this.wrapIntrinsicProps(dispatch.d, shardId));
+			this.emit(
+				// TODO: move this expect-error down to the next line once entitlements get merged, so missing dispatch types result in errors
+				// @ts-expect-error event props can't be resolved properly, but they are correct
+				dispatch.t,
+				this.wrapIntrinsicProps(dispatch.d, shardId),
+			);
 		});
 	}
 

diff --git a/packages/rest/package.json b/packages/rest/package.json
@@ -86,7 +86,7 @@
 		"@discordjs/util": "workspace:^",
 		"@sapphire/async-queue": "^1.5.0",
 		"@sapphire/snowflake": "^3.5.1",
-		"@vladfrangu/async_event_emitter": "^2.2.2",
+		"@vladfrangu/async_event_emitter": "^2.2.4",
 		"discord-api-types": "0.37.61",
 		"magic-bytes.js": "^1.5.0",
 		"tslib": "^2.6.2",

diff --git a/packages/rest/src/lib/REST.ts b/packages/rest/src/lib/REST.ts
@@ -18,7 +18,7 @@ import { RequestMethod } from './utils/types.js';
 import type {
 	RESTOptions,
 	ResponseLike,
-	RestEventsMap,
+	RestEvents,
 	HashData,
 	InternalRequest,
 	RouteLike,
@@ -31,7 +31,7 @@ import { isBufferLike, parseResponse } from './utils/utils.js';
 /**
  * Represents the class that manages handlers for endpoints
  */
-export class REST extends AsyncEventEmitter<RestEventsMap> {
+export class REST extends AsyncEventEmitter<RestEvents> {
 	/**
 	 * The {@link https://undici.nodejs.org/#/docs/api/Agent | Agent} for all requests
 	 * performed by this manager.

diff --git a/packages/rest/src/lib/utils/types.ts b/packages/rest/src/lib/utils/types.ts
@@ -14,9 +14,7 @@ export interface RestEvents {
 	restDebug: [info: string];
 }
 
-export type RestEventsMap = {
-	[K in keyof RestEvents]: RestEvents[K];
-};
+export interface RestEventsMap extends RestEvents {}
 
 /**
  * Options to be passed when creating the REST instance

diff --git a/packages/ws/__tests__/types/WebSocketManager.test-d.ts b/packages/ws/__tests__/types/WebSocketManager.test-d.ts
@@ -0,0 +1,15 @@
+import type { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
+import { expectType, expectAssignable } from 'tsd';
+import type { ManagerShardEventsMap, WebSocketShardEventsMap, WebSocketManager } from '../../src/index.js';
+
+declare const manager: WebSocketManager;
+declare const eventMap: ManagerShardEventsMap;
+
+type AugmentedShardEventsMap = {
+	[K in keyof WebSocketShardEventsMap]: [
+		WebSocketShardEventsMap[K] extends [] ? { shardId: number } : WebSocketShardEventsMap[K][0] & { shardId: number },
+	];
+};
+
+expectType<AugmentedShardEventsMap>(eventMap);
+expectAssignable<AsyncEventEmitter<AugmentedShardEventsMap>>(manager);
diff --git a/packages/ws/package.json b/packages/ws/package.json
@@ -77,7 +77,7 @@
 		"@discordjs/util": "workspace:^",
 		"@sapphire/async-queue": "^1.5.0",
 		"@types/ws": "^8.5.9",
-		"@vladfrangu/async_event_emitter": "^2.2.2",
+		"@vladfrangu/async_event_emitter": "^2.2.4",
 		"discord-api-types": "0.37.61",
 		"tslib": "^2.6.2",
 		"ws": "^8.14.2"
@@ -94,6 +94,7 @@
 		"eslint-formatter-pretty": "^5.0.0",
 		"mock-socket": "^9.3.1",
 		"prettier": "^3.1.0",
+		"tsd": "^0.29.0",
 		"tsup": "^7.2.0",
 		"turbo": "^1.10.17-canary.0",
 		"typescript": "^5.2.2",

diff --git a/packages/ws/src/ws/WebSocketManager.ts b/packages/ws/src/ws/WebSocketManager.ts
@@ -9,11 +9,13 @@ import {
 	type RESTGetAPIGatewayBotResult,
 	type GatewayIntentBits,
 	type GatewaySendPayload,
+	type GatewayDispatchPayload,
+	type GatewayReadyDispatchData,
 } from 'discord-api-types/v10';
 import type { IShardingStrategy } from '../strategies/sharding/IShardingStrategy.js';
 import type { IIdentifyThrottler } from '../throttling/IIdentifyThrottler.js';
 import { DefaultWebSocketManagerOptions, type CompressionMethod, type Encoding } from '../utils/constants.js';
-import type { WebSocketShardDestroyOptions, WebSocketShardEventsMap } from './WebSocketShard.js';
+import type { WebSocketShardDestroyOptions, WebSocketShardEvents } from './WebSocketShard.js';
 
 /**
  * Represents a range of shard ids
@@ -178,13 +180,24 @@ export interface OptionalWebSocketManagerOptions {
 	version: string;
 }
 
-export type WebSocketManagerOptions = OptionalWebSocketManagerOptions & RequiredWebSocketManagerOptions;
+export interface WebSocketManagerOptions extends OptionalWebSocketManagerOptions, RequiredWebSocketManagerOptions {}
 
-export type ManagerShardEventsMap = {
-	[K in keyof WebSocketShardEventsMap]: [
-		WebSocketShardEventsMap[K] extends [] ? { shardId: number } : WebSocketShardEventsMap[K][0] & { shardId: number },
+export interface CreateWebSocketManagerOptions
+	extends Partial<OptionalWebSocketManagerOptions>,
+		RequiredWebSocketManagerOptions {}
+
+export interface ManagerShardEventsMap {
+	[WebSocketShardEvents.Closed]: [{ code: number; shardId: number }];
+	[WebSocketShardEvents.Debug]: [payload: { message: string; shardId: number }];
+	[WebSocketShardEvents.Dispatch]: [payload: { data: GatewayDispatchPayload; shardId: number }];
+	[WebSocketShardEvents.Error]: [payload: { error: Error; shardId: number }];
+	[WebSocketShardEvents.Hello]: [{ shardId: number }];
+	[WebSocketShardEvents.Ready]: [payload: { data: GatewayReadyDispatchData; shardId: number }];
+	[WebSocketShardEvents.Resumed]: [{ shardId: number }];
+	[WebSocketShardEvents.HeartbeatComplete]: [
+		payload: { ackAt: number; heartbeatAt: number; latency: number; shardId: number },
 	];
-};
+}
 
 export class WebSocketManager extends AsyncEventEmitter<ManagerShardEventsMap> {
 	/**
@@ -212,7 +225,7 @@ export class WebSocketManager extends AsyncEventEmitter<ManagerShardEventsMap> {
 	 */
 	private readonly strategy: IShardingStrategy;
 
-	public constructor(options: Partial<OptionalWebSocketManagerOptions> & RequiredWebSocketManagerOptions) {
+	public constructor(options: CreateWebSocketManagerOptions) {
 		super();
 		this.options = { ...DefaultWebSocketManagerOptions, ...options };
 		this.strategy = this.options.buildStrategy(this);

diff --git a/packages/ws/src/ws/WebSocketShard.ts b/packages/ws/src/ws/WebSocketShard.ts
@@ -52,8 +52,7 @@ export enum WebSocketShardDestroyRecovery {
 	Resume,
 }
 
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type WebSocketShardEventsMap = {
+export interface WebSocketShardEventsMap {
 	[WebSocketShardEvents.Closed]: [{ code: number }];
 	[WebSocketShardEvents.Debug]: [payload: { message: string }];
 	[WebSocketShardEvents.Dispatch]: [payload: { data: GatewayDispatchPayload }];
@@ -62,7 +61,7 @@ export type WebSocketShardEventsMap = {
 	[WebSocketShardEvents.Ready]: [payload: { data: GatewayReadyDispatchData }];
 	[WebSocketShardEvents.Resumed]: [];
 	[WebSocketShardEvents.HeartbeatComplete]: [payload: { ackAt: number; heartbeatAt: number; latency: number }];
-};
+}
 
 export interface WebSocketShardDestroyOptions {
 	code?: number;