support TLS connections; move readme to libera.chat

Author: c-cube

README.md

@@ -44,7 +44,7 @@ client.on("join", (msg) => {
   }
 });
 
-await client.connect("irc.freenode.net", 6667);
+await client.connect("irc.libera.chat", 7000, tls = true);
 ```
 
 Note that this code above requires the `--allow-net` option.

client_test.ts

@@ -70,7 +70,7 @@ describe("client", (test) => {
 
   test("have state initialized", () => {
     assertEquals(client.state, {
-      remoteAddr: { hostname: "", port: 0 },
+      remoteAddr: { hostname: "", port: 0, tls: false },
       nick: "me",
       username: "user",
       realname: "real name",
@@ -88,6 +88,7 @@ describe("client", (test) => {
     assertEquals(client.state.remoteAddr, {
       hostname: "host",
       port: 6667,
+      tls: false,
     });
   });
 

core/client.ts

@@ -31,6 +31,7 @@ const PORT = 6667;
 export interface RemoteAddr {
   hostname: string;
   port: number;
+  tls?: boolean;
 }
 
 export type PluginParams = {
@@ -52,14 +53,23 @@ export type Plugin<T extends PluginParams = Record<string, void>> = (
   options: Readonly<ExtendedOptions<T>>,
 ) => void;
 
+/** How to connect to a server */
+interface ConnectImpl {
+  noTls(opts: Deno.ConnectOptions): Promise<Deno.Conn>;
+  withTls(opts: Deno.ConnectTlsOptions): Promise<Deno.Conn>;
+}
+
 export class CoreClient<
   TEvents extends CoreParams["events"] = CoreParams["events"],
 > extends EventEmitter<
   CoreParams["events"] & TEvents
 > {
   readonly state: CoreParams["state"];
 
-  protected connectImpl = Deno.connect;
+  protected connectImpl: ConnectImpl = {
+    noTls: Deno.connect,
+    withTls: Deno.connectTls,
+  };
   protected conn: Deno.Conn | null = null;
   protected hooks = new Hooks(this);
 
@@ -76,7 +86,7 @@ export class CoreClient<
     super(options);
 
     this.buffer = new Uint8Array(options.bufferSize ?? BUFFER_SIZE);
-    this.state = { remoteAddr: { hostname: "", port: 0 } };
+    this.state = { remoteAddr: { hostname: "", port: 0, tls: false } };
 
     new Set(plugins).forEach((plugin) => plugin(this, options));
     this.resetErrorThrowingBehavior();
@@ -85,10 +95,15 @@ export class CoreClient<
   /** Connects to a server using a hostname and an optional port.
    *
    * Default port to `6667`.
+   * If `tls=true`, attempt to connect using a TLS connection.
    *
    * Resolves when connected. */
-  async connect(hostname: string, port = PORT): Promise<Deno.Conn | null> {
-    this.state.remoteAddr = { hostname, port };
+  async connect(
+    hostname: string,
+    port = PORT,
+    tls = false,
+  ): Promise<Deno.Conn | null> {
+    this.state.remoteAddr = { hostname, port, tls };
 
     if (this.conn !== null) {
       this.close();
@@ -98,7 +113,9 @@ export class CoreClient<
     this.emit("connecting", remoteAddr);
 
     try {
-      this.conn = await this.connectImpl({ hostname, port });
+      this.conn = await (tls
+        ? this.connectImpl.withTls({ hostname, port })
+        : this.connectImpl.noTls({ hostname, port }));
       this.emit("connected", remoteAddr);
     } catch (error) {
       this.emitError("connect", error);

core/client_test.ts

@@ -13,6 +13,7 @@ describe("core/client", (test) => {
     assertEquals(addr, {
       hostname: "host",
       port: 6668,
+      tls: false,
     });
   });
 
@@ -103,6 +104,7 @@ describe("core/client", (test) => {
     assertEquals(addr, {
       hostname: "host",
       port: 6667,
+      tls: false,
     });
   });
 
@@ -116,6 +118,7 @@ describe("core/client", (test) => {
     assertEquals(msg, {
       hostname: "host",
       port: 6667,
+      tls: false,
     });
   });
 

plugins/verbose_test.ts

@@ -58,10 +58,12 @@ describe("plugins/verbose", (test) => {
       ["emit", "connecting", {
         hostname: "host",
         port: 6667,
+        tls: false,
       }],
       ["emit", "connected", {
         hostname: "host",
         port: 6667,
+        tls: false,
       }],
       ["emit", "error", {
         name: "Error",

testing/client.ts

@@ -3,12 +3,18 @@ import { CoreClient } from "../core/client.ts";
 import { MockConn } from "./conn.ts";
 
 export class MockCoreClient extends CoreClient {
-  protected connectImpl = mockConnect;
+  protected connectImpl = {
+    withTls: mockConnect,
+    noTls: mockConnect,
+  };
   readonly conn: MockConn | null = null;
 }
 
 export class MockClient extends Client {
-  protected connectImpl = mockConnect;
+  protected connectImpl = {
+    withTls: mockConnect,
+    noTls: mockConnect,
+  };
 }
 
 function mockConnect<T extends Deno.ConnectOptions>(options: T) {