Search for a 404 template

daquinoaldo · daquinoaldo · commit b50d108afde3 · 2019-03-21T12:25:03.000+01:00
When serving a static path, in case of 404 error instead of print
the error to the user, look for a 404.html template or index.html.
If none of them is founded the error is printed.

Also, remove tests for installation, to avoid waste on developers
devices. It is not necessari to be tested, since if npm install
fails on Travis, the entire test fails.
diff --git a/index.js b/index.js
@@ -55,10 +55,23 @@ app.redirect = function(
 }
 
 // serve static content, usage `app.serve([path])`
-app.serve = function(path = process.cwd(), port = process.env.PORT ||
+app.serve = function(staticPath = process.cwd(), port = process.env.PORT ||
 /* istanbul ignore next: cannot be tested on Travis */ 443) {
-  app.use(express.static(path))
-  console.info("Serving static path: " + path)
+  app.use(express.static(staticPath))
+  // redirect 404 to 404.html or to index.html
+  app.use((req, res) => {
+    if (!staticPath.startsWith("/"))
+      staticPath = process.cwd() + "/" + staticPath
+    const p404 = staticPath + "/404.html"
+    const index = staticPath + "/index.html"
+    // istanbul ignore else: not interesting
+    if (fs.existsSync(p404))
+      res.status(404).sendFile(p404)
+    else if (fs.existsSync(index))
+      res.status(404).sendFile(index)
+    else res.status(404).send(req.path + " not found.")
+  })
+  console.info("Serving static path: " + staticPath)
   app.listen(port)
 }
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "https-localhost",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "HTTPS server running on localhost",
   "main": "index.js",
   "scripts": {
@@ -36,14 +36,14 @@
   },
   "homepage": "https://daquinoaldo.github.io/https-localhost",
   "dependencies": {
-    "compression": "^1.7.3",
+    "compression": "^1.7.4",
     "express": "^4.16.4",
     "express-minify": "^1.0.0",
     "spdy": "^4.0.0"
   },
   "devDependencies": {
     "coveralls": "^3.0.3",
-    "eslint": "^5.14.1",
+    "eslint": "^5.15.3",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.16.0",
     "eslint-plugin-node": "^8.0.1",
diff --git a/test/404.html b/test/404.html
@@ -0,0 +1,8 @@
+<html>
+<head>
+  <title>404</title>
+</head>
+<body>
+  <p>File not found.</p>
+</body>
+</html>
diff --git a/test/test.js b/test/test.js
@@ -34,27 +34,6 @@ function makeRequest(path = "/", secure = true, port = HTTPS_PORT) {
   })
 }
 
-// TESTS INSTALL
-describe("Testing the installation script", function() {
-  // timeout 5 min
-  this.timeout(300000)
-
-  // remove a file, this will force the reinstallation
-  fs.unlinkSync("cert/localhost.crt")
-
-  it("installs correctly", async function() {
-    await require("../cert/generate.js")()
-    assert(fs.existsSync("cert/localhost.crt"))
-    assert(fs.existsSync("cert/localhost.key"))
-  })
-
-  it("skips installation if files exists", async function() {
-    await require("../cert/generate.js")()
-    assert(fs.existsSync("cert/localhost.crt"))
-    assert(fs.existsSync("cert/localhost.key"))
-  })
-})
-
 // TESTS MODULE
 describe("Testing https-localhost", () => {
   // close the server after each test
@@ -91,15 +70,15 @@ describe("Testing https-localhost", () => {
         res.data.toString() === fs.readFileSync("test/static.html").toString()))
   })
 
-  it("serves static files from default path and env port", async function() {
+  it("serves static files from default env port", async function() {
     // set the environment port
     process.env.PORT = HTTPS_PORT
     // start the server (serving the default folder)
-    app.serve()
+    app.serve("test")
     // make the request and check the output
-    await makeRequest("/test/static.html")
-      .then(res => assert(
-        res.data.toString() === fs.readFileSync("test/static.html").toString()))
+    await makeRequest("/static.html")
+      .then(res => assert(res.data.toString() ===
+          fs.readFileSync("test/static.html").toString()))
   })
 
   it("doesn't crash on 404", async function() {
@@ -110,6 +89,19 @@ describe("Testing https-localhost", () => {
       .then(res => assert(res.statusCode === 404))
   })
 
+  it("looks for a 404.html file", async function() {
+    // start the server (serving the default folder)
+    await app.serve("test", HTTPS_PORT)
+    // make the request and check the result
+    await makeRequest("/do-not-exist.html")
+      .then(res => {
+        console.log(res)
+        assert(res.statusCode === 404)
+        assert(res.data.toString() ===
+          fs.readFileSync("test/404.html").toString())
+      })
+  })
+
   it("doesn't crash if the static path doesn't exists", async function() {
     // start the server (serving a non existing folder)
     app.serve("do-not-exists")

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<html>
 +<head>
 +  <title>404</title>
 +</head>
 +<body>
 +  <p>File not found.</p>
 +</body>
 +</html>