update code reliability

Author: JoaoOtavioS

README.md

@@ -39,28 +39,62 @@ bun install @squarecloud/http-proxy
 
 Create proxy:
 
-```ts
-import { createServer } from "node:http";
-
-import { createProxyServer } from "@squarecloud/http-proxy";
+```js
+const { createServer } = require("node:http");
+const { createProxyServer } = require("@squarecloud/http-proxy");
 
 const proxy = createProxyServer({});
 const target = "http://example.com"; /* address of your proxy server here */
 
 const server = createServer(async (req, res) => {
-  try {
-    await proxy.web(req, res, { target });
-  } catch (error) {
-    console.error(error);
-    res.statusCode = 500;
-    res.end("Proxy error: " + error.toString());
-  }
+    try {
+        await proxy.web(req, res, { target });
+    } catch (error) {
+        console.error(error);
+        res.statusCode = 500;
+        res.end("Proxy error: " + error.toString());
+    }
 });
 
 server.listen(80, () => console.log("Proxy is listening on http://localhost"));
 ```
 
-Checkout [http-party/node-http-proxy](https://github.com/http-party/node-http-proxy) for more options and examples.
+Example with WebSocket:
+
+```js
+const { createServer } = require("node:http");
+const { createProxyServer } = require("@squarecloud/http-proxy");
+
+const proxy = createProxyServer({ ws: true });
+const target = "ws://example.com"; /* address of your proxy server here */
+
+const server = createServer(async (req, res) => { /* ... */ });
+
+server.on("upgrade", async (req, socket, head) => {
+    try {
+        // use proxy.ws() instead of proxy.web() for proxying WebSocket requests.
+        await proxy.ws(req, socket, head, { target });
+    } catch (error) {
+        console.error(error);
+        socket.end();
+    }
+});
+
+server.listen(80, () => console.log("Proxy is listening on http://localhost"));
+```
+
+Some options:
+
+```js
+// Options most used in the proxy configuration:
+// * ws     : <true/false, if you want to proxy websockets>
+// * xfwd   : <true/false, adds X-Forward headers>
+// * secure : <true/false, verify SSL certificate>
+// * prependPath: <true/false, Default: true - specify whether you want to prepend the target"s path to the proxy path>
+// * ignorePath: <true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request>
+```
+
+Checkout [http-party/node-http-proxy](https://github.com/http-party/node-http-proxy#options) for more options and examples.
 
 ## Development
 

lib/http-proxy.js

@@ -25,7 +25,7 @@ function createProxyServer(options) {
    *    agent  : <object to be passed to http(s).request>
    *    ssl    : <object to be passed to https.createServer()>
    *    ws     : <true/false, if you want to proxy websockets>
-   *    xfwd   : <true/false, adds x-forward headers>
+   *    xfwd   : <true/false, adds X-Forward headers>
    *    secure : <true/false, verify SSL certificate>
    *    toProxy: <true/false, explicitly specify if we are proxying to another proxy>
    *    prependPath: <true/false, Default: true - specify whether you want to prepend the target"s path to the proxy path>

lib/http-proxy/common.js

@@ -229,7 +229,6 @@ common.rewriteCookieProperty = function rewriteCookieProperty(header, config, pr
       // replace value
       return prefix + newValue;
     } else {
-      // remove value
       return "";
     }
   });

lib/http-proxy/index.js

@@ -8,10 +8,6 @@ const ws = require("./passes/ws-incoming");
  * Returns a function that creates the loader for
  * either `ws` or `web`"s  passes.
  *
- * Examples:
- *
- *    httpProxy.createRightProxy("ws")
- *    // => [Function]
  *
  * @param {String} Type Either "ws" or "web"
  *
@@ -87,13 +83,8 @@ class ProxyServer {
     this.ws = this.proxyWebsocketRequest = createRightProxy("ws")(options);
     this.options = options;
 
-    this.webPasses = Object.keys(web).map(function (pass) {
-      return web[pass];
-    });
-
-    this.wsPasses = Object.keys(ws).map(function (pass) {
-      return ws[pass];
-    });
+    this.webPasses = Object.keys(web).map((pass) => web[pass]);
+    this.wsPasses = Object.keys(ws).map((pass) => ws[pass]);
 
     this.on("error", this.onError, this);
   }

lib/http-proxy/passes/web-incoming.js

@@ -136,9 +136,7 @@ module.exports = {
     }
 
     // Ensure we abort proxy if request is aborted
-    req.on("aborted", function () {
-      proxyReq.destroy();
-    });
+    req.on("aborted", proxyReq.destroy);
 
     // handle errors in proxy and incoming request, just like for forward proxy
     const proxyError = createErrorHandler(proxyReq, options.target);
@@ -175,13 +173,12 @@ module.exports = {
 
       if (!res.finished) {
         // Allow us to listen when the proxy has completed
-        proxyRes.on("end", function () {
-          if (server) server.emit("end", req, res, proxyRes);
-        });
+        proxyRes.on("end", () => (server ? server.emit("end", req, res, proxyRes) : null));
+
         // We pipe to the response unless its expected to be handled by the user
         if (!options.selfHandleResponse) proxyRes.pipe(res);
-      } else {
-        if (server) server.emit("end", req, res, proxyRes);
+      } else if (server) {
+        server.emit("end", req, res, proxyRes);
       }
     });
   },

lib/http-proxy/passes/web-outgoing.js

@@ -10,8 +10,6 @@ const redirectRegex = /^201|30(1|2|7|8)$/;
  */
 
 module.exports = {
-  // <--
-
   /**
    * If is a HTTP 1.0 request, remove chunk headers
    *

lib/http-proxy/passes/ws-incoming.js

@@ -110,7 +110,7 @@ module.exports = {
     proxyReq.on("response", function (res) {
       // if upgrade event isn"t going to happen, close the socket
       if (!res.upgrade && socket.readyState !== "closed") {
-        socket.write(createHttpHeader("HTTP/" + res.httpVersion + " " + res.statusCode + " " + res.statusMessage, res.headers));
+        socket.write(createHttpHeader(`HTTP/${res.httpVersion} ${res.statusCode} ${res.statusMessage}`, res.headers));
         res.pipe(socket);
       }
     });
@@ -126,9 +126,7 @@ module.exports = {
       // The pipe below will end proxySocket if socket closes cleanly, but not
       // if it errors (eg, vanishes from the net and starts returning
       // EHOSTUNREACH). We need to do that explicitly.
-      socket.on("error", function () {
-        proxySocket.end();
-      });
+      socket.on("error", proxySocket.end);
 
       common.setupSocket(proxySocket);