fix: cleaup stream and handle errors (#1769)

webpack · Mar 19, 2024 · 1258fdd · 1258fdd
1 parent 22ec9ad
commit 1258fdd
Show file tree

Hide file tree

Showing 8 changed files with 401 additions and 6 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -17,7 +17,8 @@
     "myhtml",
     "configurated",
     "mycustom",
-    "commitlint"
+    "commitlint",
+    "nosniff"
   ],
   "ignorePaths": [
     "CHANGELOG.md",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -56,6 +56,7 @@
     "colorette": "^2.0.10",
     "memfs": "^4.6.0",
     "mime-types": "^2.1.31",
+    "on-finished": "^2.4.1",
     "range-parser": "^1.2.1",
     "schema-utils": "^4.0.0"
   },
@@ -69,6 +70,7 @@
     "@types/express": "^4.17.13",
     "@types/mime-types": "^2.1.1",
     "@types/node": "^20.11.16",
+    "@types/on-finished": "^2.3.4",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-jest": "^29.3.1",
     "chokidar": "^3.5.1",

diff --git a/src/utils/compatibleAPI.js b/src/utils/compatibleAPI.js
@@ -1,3 +1,7 @@
+const onFinishedStream = require("on-finished");
+
+const escapeHtml = require("./escapeHtml");
+
 /** @typedef {import("../index.js").IncomingMessage} IncomingMessage */
 /** @typedef {import("../index.js").ServerResponse} ServerResponse */
 
@@ -88,6 +92,18 @@ function setHeaderForResponse(res, name, value) {
   res.setHeader(name, value);
 }
 
+/**
+ * @template {ServerResponse} Response
+ * @param {Response} res
+ */
+function clearHeadersForResponse(res) {
+  const headers = getHeaderNames(res);
+
+  for (let i = 0; i < headers.length; i++) {
+    res.removeHeader(headers[i]);
+  }
+}
+
 /**
  * @template {ServerResponse} Response
  * @param {Response} res
@@ -108,6 +124,76 @@ function setStatusCode(res, code) {
   res.statusCode = code;
 }
 
+/**
+ * @param {import("fs").ReadStream} stream stream
+ * @param {boolean} suppress do need suppress?
+ * @returns {void}
+ */
+function destroyStream(stream, suppress) {
+  if (typeof stream.destroy === "function") {
+    stream.destroy();
+  }
+
+  if (typeof stream.close === "function") {
+    // Node.js core bug workaround
+    stream.on(
+      "open",
+      /**
+       * @this {import("fs").ReadStream}
+       */
+      function onOpenClose() {
+        // @ts-ignore
+        if (typeof this.fd === "number") {
+          // actually close down the fd
+          this.close();
+        }
+      },
+    );
+  }
+
+  if (typeof stream.addListener === "function" && suppress) {
+    stream.removeAllListeners("error");
+    stream.addListener("error", () => {});
+  }
+}
+
+/** @type {Record<number, string>} */
+const statuses = {
+  404: "Not Found",
+  500: "Internal Server Error",
+};
+
+/**
+ * @template {ServerResponse} Response
+ * @param {Response} res response
+ * @param {number} status status
+ * @returns {void}
+ */
+function sendError(res, status) {
+  const msg = statuses[status] || String(status);
+  const doc = `<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<title>Error</title>
+</head>
+<body>
+<pre>${escapeHtml(msg)}</pre>
+</body>
+</html>`;
+
+  // Clear existing headers
+  clearHeadersForResponse(res);
+  // Send basic response
+  setStatusCode(res, status);
+  setHeaderForResponse(res, "Content-Type", "text/html; charset=UTF-8");
+  setHeaderForResponse(res, "Content-Length", Buffer.byteLength(doc));
+  setHeaderForResponse(res, "Content-Security-Policy", "default-src 'none'");
+  setHeaderForResponse(res, "X-Content-Type-Options", "nosniff");
+
+  res.end(doc);
+}
+
 /**
  * @template {IncomingMessage} Request
  * @template {ServerResponse} Response
@@ -125,13 +211,42 @@ function send(req, res, bufferOtStream, byteLength) {
 
     if (req.method === "HEAD") {
       res.end();
-
       return;
     }
 
     /** @type {import("fs").ReadStream} */
     (bufferOtStream).pipe(res);
 
+    // Cleanup
+    const cleanup = () => {
+      destroyStream(
+        /** @type {import("fs").ReadStream} */ (bufferOtStream),
+        true,
+      );
+    };
+
+    // Response finished, cleanup
+    onFinishedStream(res, cleanup);
+
+    // error handling
+    /** @type {import("fs").ReadStream} */
+    (bufferOtStream).on("error", (error) => {
+      // clean up stream early
+      cleanup();
+
+      // Handle Error
+      switch (/** @type {NodeJS.ErrnoException} */ (error).code) {
+        case "ENAMETOOLONG":
+        case "ENOENT":
+        case "ENOTDIR":
+          sendError(res, 404);
+          break;
+        default:
+          sendError(res, 500);
+          break;
+      }
+    });
+
     return;
   }
 
@@ -141,7 +256,6 @@ function send(req, res, bufferOtStream, byteLength) {
   ) {
     /** @type {Response & ExpectedResponse} */
     (res).send(bufferOtStream);
-
     return;
   }
 

diff --git a/src/utils/escapeHtml.js b/src/utils/escapeHtml.js
@@ -0,0 +1,58 @@
+const matchHtmlRegExp = /["'&<>]/;
+
+/**
+ * @param {string} string raw HTML
+ * @returns {string} escaped HTML
+ */
+function escapeHtml(string) {
+  const str = `${string}`;
+  const match = matchHtmlRegExp.exec(str);
+
+  if (!match) {
+    return str;
+  }
+
+  let escape;
+  let html = "";
+  let index = 0;
+  let lastIndex = 0;
+
+  for ({ index } = match; index < str.length; index++) {
+    switch (str.charCodeAt(index)) {
+      // "
+      case 34:
+        escape = "&quot;";
+        break;
+      // &
+      case 38:
+        escape = "&amp;";
+        break;
+      // '
+      case 39:
+        escape = "&#39;";
+        break;
+      // <
+      case 60:
+        escape = "&lt;";
+        break;
+      // >
+      case 62:
+        escape = "&gt;";
+        break;
+      default:
+        // eslint-disable-next-line no-continue
+        continue;
+    }
+
+    if (lastIndex !== index) {
+      html += str.substring(lastIndex, index);
+    }
+
+    lastIndex = index + 1;
+    html += escape;
+  }
+
+  return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
+}
+
+module.exports = escapeHtml;