feat(core): add "remoteAddr" key to core state

Author: jeromeludmann

client_test.ts

@@ -22,6 +22,7 @@ describe("client", (test) => {
     },
     resolveInvalidNames: true,
     verbose: true,
+    reconnect: true,
   };
 
   const { client, server } = mockAll(options);
@@ -68,6 +69,7 @@ describe("client", (test) => {
 
   test("have state initialized", () => {
     assertEquals(client.state, {
+      remoteAddr: { hostname: "", port: 0 },
       nick: "me",
       username: "user",
       realname: "real name",
@@ -79,9 +81,13 @@ describe("client", (test) => {
   });
 
   test("connect to server", async () => {
-    const conn = await client.connect("");
+    const conn = await client.connect("host");
 
     assertExists(conn);
+    assertEquals(client.state.remoteAddr, {
+      hostname: "host",
+      port: 6667,
+    });
   });
 
   test("register on connect", () => {

core/client.ts

@@ -17,11 +17,20 @@ export interface CoreParams {
     "raw": Raw;
     "error": FatalError;
   };
+
+  state: {
+    remoteAddr: RemoteAddr;
+  };
 }
 
 const BUFFER_SIZE = 4096;
 const PORT = 6667;
 
+export interface RemoteAddr {
+  hostname: string;
+  port: number;
+}
+
 export class FatalError extends Error {
   constructor(
     public type: "connect" | "read" | "write" | "close",
@@ -41,9 +50,10 @@ export type ExtendedClient<T extends PluginParams = {}> =
   & { readonly state: T["state"] }
   & T["commands"];
 
-export type ExtendedOptions<T extends PluginParams = {}> =
+export type ExtendedOptions<T extends PluginParams = {}> = Readonly<
   & CoreParams["options"]
-  & T["options"];
+  & T["options"]
+>;
 
 export type Plugin<T extends PluginParams = {}> = (
   client: ExtendedClient<T>,
@@ -61,15 +71,17 @@ export class CoreClient<
   private decoder = new TextDecoder();
   private encoder = new TextEncoder();
   private parser = new Parser();
-
-  readonly state: Readonly<{}> = {};
+  readonly state: CoreParams["state"];
 
   constructor(
     plugins: Plugin<any>[],
     options: Readonly<CoreParams["options"]>,
   ) {
     super(options);
+
     this.bufferSize = options.bufferSize ?? BUFFER_SIZE;
+    this.state = { remoteAddr: { hostname: "", port: 0 } };
+
     new Set(plugins).forEach((plugin) => plugin(this, options));
     this.resetErrorThrowingBehavior();
   }
@@ -80,20 +92,25 @@ export class CoreClient<
    *
    * Resolves when connected. */
   async connect(hostname: string, port = PORT): Promise<Deno.Conn | null> {
+    this.state.remoteAddr = { hostname, port };
+
     if (this.conn !== null) {
       this.close();
     }
 
+    const { remoteAddr } = this.state;
+    this.emit("connecting", remoteAddr);
+
     try {
-      this.emit("connecting", { hostname, port });
       this.conn = await this.connectImpl({ hostname, port });
-      this.emit("connected", getRemoteAddr(this.conn));
+      this.emit("connected", remoteAddr);
     } catch (error) {
       this.emit("error", new FatalError("connect", error.message));
       return null;
     }
 
     this.read(this.conn);
+
     return this.conn;
   }
 
@@ -130,7 +147,7 @@ export class CoreClient<
 
     try {
       this.conn.close();
-      this.emit("disconnected", getRemoteAddr(this.conn));
+      this.emit("disconnected", this.state.remoteAddr);
     } catch (error) {
       this.emit("error", new FatalError("close", error.message));
     } finally {
@@ -174,14 +191,3 @@ export class CoreClient<
     this.close();
   }
 }
-
-export interface RemoteAddr {
-  hostname: string;
-  port: number;
-}
-
-function getRemoteAddr(conn: Deno.Conn): RemoteAddr {
-  const addr = conn.remoteAddr as Deno.NetAddr;
-  const { hostname, port } = addr;
-  return { hostname, port };
-}

plugins/myinfo_test.ts

@@ -26,11 +26,16 @@ describe("plugins/myinfo", (test) => {
     server.send(":serverhost 004 me serverhost IRC-version iorsw ilmop");
     await client.once("myinfo");
 
-    assertEquals(client.state, {
-      serverHost: "serverhost",
-      serverVersion: "IRC-version",
-      availableUserModes: ["i", "o", "r", "s", "w"],
-      availableChannelModes: ["i", "l", "m", "o", "p"],
-    });
+    const {
+      serverHost,
+      serverVersion,
+      availableUserModes,
+      availableChannelModes,
+    } = client.state;
+
+    assertEquals(serverHost, "serverhost");
+    assertEquals(serverVersion, "IRC-version");
+    assertEquals(availableUserModes, ["i", "o", "r", "s", "w"]);
+    assertEquals(availableChannelModes, ["i", "l", "m", "o", "p"]);
   });
 });

plugins/register_on_connect_test.ts

@@ -54,11 +54,11 @@ describe("plugins/register_on_connect", (test) => {
   test("initialize user state", async () => {
     const { client } = await mock(plugins, options);
 
-    assertEquals(client.state, {
-      nick: "me",
-      username: "user",
-      realname: "real name",
-    });
+    const { nick, username, realname } = client.state;
+
+    assertEquals(nick, "me");
+    assertEquals(username, "user");
+    assertEquals(realname, "real name");
   });
 
   test("update nick on RPL_WELCOME", async () => {