feat: add option for log level

Author: johanbook

README.md

@@ -50,12 +50,15 @@ The Docker images are available for multiple architectures, including armv7.
 
 The following can be configured as environment variables:
 
+- **ACCESS_LOGS** if access logs are showed (default `false`).
 - **DEFAULT_INDEX_FILE** name of file served on paths ending with a trailing
   slash (default `index.html`).
 - **FALLBACK_FILE** name of file served as a fallback if requested file is not
   found. Set to `index.html` to enable client-side routing or to e.g.
   `error.html` to display an error page (note that response still returns a 200
   status code). It is undefined by default and no fallback file will be served.
+- **LOG_LEVEL** used log level. Available values are `debug`, `info`, `warning`
+  and `error` (default `info`).
 - **PORT** the port the server should listen on (default 8080).
 - **ROOT_FILE_PATH** root directory of served file tree (default `build`).
 

src/index.js

@@ -4,6 +4,8 @@ const path = require("node:path");
 
 const mime = require("mime");
 
+const logger = require("./logger");
+
 const DEFAULT_INDEX_FILE = process.env.DEFAULT_INDEX_FILE || "index.html";
 const FALLBACK_FILE = process.env.FALLBACK_FILE || null;
 const PORT = process.env.PORT || 8080;
@@ -14,7 +16,7 @@ function getFile(filePath) {
     const file = fs.readFileSync(filePath);
     return file;
   } catch {
-    console.error(`Could not find file "${filePath}"`);
+    logger.error(`Could not find file "${filePath}"`);
     return;
   }
 }
@@ -44,20 +46,21 @@ function createFilePath(domain, filePath) {
 function handleRequest(req, res) {
   const domain = getDomainFromRequest(req);
   const filePath = getFilePathFromRequest(req);
-  console.debug("Requesting", domain, filePath);
+  logger.debug(`Requesting ${domain}${filePath}`);
 
   const actualFilePath = createFilePath(domain, filePath);
   let file = getFile(actualFilePath);
 
   if (!file && FALLBACK_FILE) {
     const fallbackFilePath = createFilePath(domain, FALLBACK_FILE);
-    console.debug("Serving fallback file:", fallbackFilePath);
+    logger.debug(`Serving fallback file: ${fallbackFilePath}`);
     file = getFile(fallbackFilePath);
   }
 
   if (!file) {
     res.writeHead(404);
     res.end();
+    logger.accessLog(req, res);
     return;
   }
 
@@ -66,9 +69,10 @@ function handleRequest(req, res) {
   res.setHeader("Content-Type", mimeType);
   res.writeHead(200);
   res.end(file);
+  logger.accessLog(req, res);
 }
 
 const server = http.createServer(handleRequest);
 server.listen(PORT);
 
-console.info(`Listening on port ${PORT}`);
+logger.info(`Listening on port ${PORT}`);

src/logger.js

@@ -0,0 +1,41 @@
+const ACCESS_LOGS = process.env.ACCESS_LOGS || false;
+const LOG_LEVEL = process.env.LOG_LEVEL || "info";
+
+const LOG_LEVELS = {
+  DEBUG: 1,
+  INFO: 2,
+  WARNING: 3,
+  ERROR: 4,
+};
+
+const LEVEL = LOG_LEVELS[LOG_LEVEL.toUpperCase()];
+
+exports.debug = function (message) {
+  if (LEVEL <= LOG_LEVELS.DEBUG) {
+    console.debug(`DEBUG: ${message}`);
+  }
+};
+
+exports.info = function (message) {
+  if (LEVEL <= LOG_LEVELS.INFO) {
+    console.info(`INFO: ${message}`);
+  }
+};
+
+exports.warn = function (message) {
+  if (LEVEL <= LOG_LEVELS.WARNING) {
+    console.warn(`WARNING: ${message}`);
+  }
+};
+
+exports.error = function (message) {
+  if (LEVEL <= LOG_LEVELS.ERROR) {
+    console.error(`ERROR: ${message}`);
+  }
+};
+
+exports.accessLog = function (req, res) {
+  if (ACCESS_LOGS) {
+    console.info(`${req.headers.host}${req.url} ${res.statusCode}`);
+  }
+};