feat(plugins/registration): request capabilities on connect

Author: jeromeludmann

core/protocol.ts

@@ -1,5 +1,6 @@
 export type AnyCommand =
   | "ADMIN"
+  | "CAP"
   | "CONNECT"
   | "ERROR"
   | "INFO"

plugins/registration.ts

@@ -24,16 +24,41 @@ export interface RegistrationParams {
     password?: string;
   };
   state: {
+    capabilities: string[];
     user: User;
   };
 }
 
+type AnyCapabilityCommand =
+  | "LS"
+  | "LIST"
+  | "REQ"
+  | "ACK"
+  | "NAK"
+  | "NEW"
+  | "DEL"
+  | "END";
+
 export const registrationPlugin: Plugin<
   & NickParams
   & RegisterParams
   & RegistrationParams
 > = (client, options) => {
+  const requestCapability = (
+    command: AnyCapabilityCommand,
+    ...params: string[]
+  ) => client.send("CAP", command, ...params);
+
   const register = () => {
+    const { capabilities } = client.state;
+
+    if (capabilities.length > 0) {
+      for (const capability of capabilities) {
+        requestCapability("REQ", capability);
+      }
+      requestCapability("END");
+    }
+
     if (password !== undefined) {
       client.pass(password);
     }
@@ -61,6 +86,7 @@ export const registrationPlugin: Plugin<
   };
 
   const { nick, username = nick, realname = nick, password } = options;
+  client.state.capabilities ??= []; // TODO depends of plugins loading order
   client.state.user = { nick, username, realname };
 
   client.on("connected", register);

plugins/registration_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "../deps.ts";
+import { assertArrayIncludes, assertEquals } from "../deps.ts";
 import { describe } from "../testing/helpers.ts";
 import { mock } from "../testing/mock.ts";
 import { nickPlugin } from "./nick.ts";
@@ -51,6 +51,29 @@ describe("plugins/registration", (test) => {
     ]);
   });
 
+  test("request capabilities on connect", async () => {
+    const { client, server } = await mock(
+      plugins,
+      options,
+      { withConnection: false },
+    );
+    const { capabilities } = client.state;
+
+    capabilities.push("cap1");
+    capabilities.push("cap2");
+    capabilities.push("cap3");
+
+    await client.connect("");
+    const raw = server.receive();
+
+    assertArrayIncludes(raw, [
+      "CAP REQ cap1",
+      "CAP REQ cap2",
+      "CAP REQ cap3",
+      "CAP END",
+    ]);
+  });
+
   test("initialize user state", async () => {
     const { client } = await mock(plugins, options);
     const { user } = client.state;