Expose request remote IP (#7)

Author: zefir-git

package-lock.json

@@ -35,6 +35,7 @@
     "typescript": "^5.8.2"
   },
   "dependencies": {
+    "@cldn/ip": "^1.0.3",
     "multipart-ts": "^1.3.2"
   }
 }

package.json

@@ -1,3 +1,4 @@
+import {IPAddress, IPv4, IPv6} from "@cldn/ip";
 import {Multipart} from "multipart-ts";
 import http, {OutgoingHttpHeader} from "node:http";
 import stream from "node:stream";
@@ -26,28 +27,37 @@ export class Request {
      */
     public readonly bodyStream: stream.Readable;
 
+    /**
+     * IP address of request sender.
+     */
+    public readonly ip: IPv4 | IPv6;
+
     /**
      * Construct a new Request.
      * @param method See {@link Request#method}.
      * @param url See {@link Request#url}.
      * @param headers See {@link Request#headers}.
      * @param bodyStream See {@link Request#bodyStream}.
+     * @param ip See {@link Request#ip}.
      */
     protected constructor(
         method: Request["method"],
         url: Request["url"],
         headers: Request["headers"],
         bodyStream: Request["bodyStream"],
+        ip: Request["ip"],
     ) {
         this.method = method;
         this.url = url;
         this.headers = headers;
         this.bodyStream = bodyStream;
+        this.ip = ip;
     }
 
     /**
      * Create a new Request from a Node.js incoming HTTP request.
      * @throws {@link Request.BadUrlError} If the request URL is invalid.
+     * @throws {@link Request.SocketClosedError} If the request socket was closed before the request could be handled.
      */
     public static incomingMessage(incomingMessage: http.IncomingMessage) {
         const auth =
@@ -66,7 +76,11 @@ export class Request {
 
         const headers = Request.headersFromNodeDict(incomingMessage.headers);
 
-        return new Request(incomingMessage.method as Request.Method, new URL(url), headers, incomingMessage);
+        const remoteAddress = incomingMessage.socket.remoteAddress;
+        if (remoteAddress === undefined)
+            throw new Request.SocketClosedError();
+
+        return new Request(incomingMessage.method as Request.Method, new URL(url), headers, incomingMessage, IPAddress.fromString(remoteAddress));
     }
 
     /**
@@ -212,4 +226,13 @@ export namespace Request {
         UNLOCK = "UNLOCK",
         UNSUBSCRIBE = "UNSUBSCRIBE",
     }
+
+    /**
+     * Socket closed by peer.
+     */
+    export class SocketClosedError extends Error {
+        public constructor() {
+            super("The socker was closed by the peer.");
+        }
+    }
 }

src/Request.ts

@@ -47,6 +47,8 @@ class Server {
                 this.errors._get(ServerErrorRegistry.ErrorCodes.BAD_URL)._send(res, this);
                 return;
             }
+            if (e instanceof Request.SocketClosedError)
+                return;
             throw e;
         }
 

src/Server.ts

@@ -1,6 +1,6 @@
 /* Auto-generated by generateIndices.sh */
-export * from "./Request.js";
 export * from "./Server.js";
+export * from "./Request.js";
 export * from "./ServerErrorRegistry.js";
 export * from "./response/index.js";
 export * from "./routing/index.js";

src/index.ts

@@ -1,6 +1,6 @@
 /* Auto-generated by generateIndices.sh */
-export * from "./Response.js";
 export * from "./EmptyResponse.js";
 export * from "./BufferResponse.js";
-export * from "./JsonResponse.js";
 export * from "./TextResponse.js";
+export * from "./JsonResponse.js";
+export * from "./Response.js";