refactor: use config.wwwroot instead of current working directory as a webroot in internal code

README.md

@@ -8,10 +8,10 @@
   It's free as in freedom, scalable, secure, and configurable.
 </p>
 <p align="center">
-  <a href="https://svrjs.org/docs/tentative" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Documentation-green"></a>
+  <a href="https://svrjs.org/docs" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Documentation-green"></a>
   <a href="https://svrjs.org" target="_blank"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fsvrjs.org"></a>
   <a href="https://hub.docker.com/r/svrjs/svrjs" target="_blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/svrjs/svrjs"></a>
-  <a href="https://github.com/svr-js/svrjs/tree/next" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/svr-js/svrjs"></a>
+  <a href="https://github.com/svr-js/svrjs" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/svr-js/svrjs"></a>
   <a href="https://x.com/SVR_JS" target="_blank"><img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/SVR_JS"></a>
   <a href="https://mastodon.social/@svrjs" target="_blank"><img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/111643338718098121"></a>
 </p>
@@ -87,7 +87,7 @@ After running the command, you will get bundled SVR.JS script, around with built
 
 To install SVR.JS you just built from the source code, you can install it via SVR.JS installer for GNU/Linux or manually.
 
-If you want to install SVR.JS manually, you can read the [server documentation](https://svrjs.org/docs/tentative).
+If you want to install SVR.JS manually, you can read the [server documentation](https://svrjs.org/docs).
 
 If you want to install via SVR.JS installer for GNU/Linux, run this command:
 ```bash
@@ -102,7 +102,7 @@ After installation, SVR.JS should be listening at http://localhost.
 
 ## SVR.JS documentation
 
-You can read the [SVR.JS documentation](https://svrjs.org/docs/tentative) to get information on how to use SVR.JS.
+You can read the [SVR.JS documentation](https://svrjs.org/docs) to get information on how to use SVR.JS.
 
 ## npm scripts
 

assets/config.json

@@ -59,5 +59,6 @@
   "disableTrailingSlashRedirects": false,
   "environmentVariables": {},
   "allowDoubleSlashes": false,
-  "optOutOfStatisticsServer": false
+  "optOutOfStatisticsServer": false,
+  "disableConfigurationSaving": false
 }

esbuild.config.js

@@ -4,248 +4,362 @@ const fs = require("fs");
 const zlib = require("zlib");
 const ejs = require("ejs");
 const archiver = require("archiver");
-const dependencies =
-  JSON.parse(fs.readFileSync(__dirname + "/package.json")).dependencies || {};
-const requiredDependencyList = Object.keys(dependencies);
-let dependencyList = Object.keys(dependencies);
+const chokidar = require("chokidar");
 const svrjsInfo = JSON.parse(fs.readFileSync(__dirname + "/svrjs.json"));
-const { name, version, documentationURL, changes } = svrjsInfo;
+const { version } = svrjsInfo;
+const isDev = process.env.NODE_ENV == "development";
 
-// Function to find and add all dependencies into the dependencyList array.
-function findAllDependencies(curList) {
-  // If no curList parameter is specified, use dependencyList.
-  if (!curList) curList = dependencyList;
-  curList.forEach((dependency) => {
-    const newDeplist = Object.keys(
-      JSON.parse(
-        fs
-          .readFileSync(
-            __dirname +
-              "/node_modules/" +
-              dependency.replace(/\/\.\./g, "") +
-              "/package.json"
-          )
-          .toString()
-      ).dependencies || {}
-    );
-    let noDupNewDepList = [];
-    newDeplist.forEach((dep) => {
-      // Ignore duplicates
-      if (dependencyList.indexOf(dep) == -1) {
-        noDupNewDepList.push(dep);
-        dependencyList.push(dep);
-      }
-    });
-    // Call findAllDependencies for the dependency list.
-    findAllDependencies(noDupNewDepList);
-  });
-}
+// Create the dist directory if it doesn't exist
+if (!fs.existsSync(__dirname + "/dist")) fs.mkdirSync(__dirname + "/dist");
+if (!fs.existsSync(__dirname + "/dist/log"))
+  fs.mkdirSync(__dirname + "/dist/log");
+if (!fs.existsSync(__dirname + "/dist/mods"))
+  fs.mkdirSync(__dirname + "/dist/mods");
+if (!fs.existsSync(__dirname + "/dist/temp"))
+  fs.mkdirSync(__dirname + "/dist/temp");
 
-// Get list of all dependencies
-findAllDependencies();
-dependencyList = dependencyList.sort();
+// Create the out directory if it doesn't exist and if not building for development
+if (!isDev && !fs.existsSync(__dirname + "/out")) fs.mkdirSync(__dirname + "/out");
 
-// Create and populate an object, where whenever the dependencies are required are listed.
-let dependenciesAreRequired = {};
-dependencyList.forEach((dependency) => {
-  dependenciesAreRequired[dependency] = false;
-});
-requiredDependencyList.forEach((dependency) => {
-  dependenciesAreRequired[dependency] = true;
-});
+function generateAssets() {
+  // Variables from "svrjs.json" file
+  const svrjsInfo = JSON.parse(fs.readFileSync(__dirname + "/svrjs.json"));
+  const { name, version, documentationURL, changes } = svrjsInfo;
 
-// Create the template functions using EJS
-const layoutTemplate = ejs.compile(
-  fs.readFileSync(__dirname + "/templates/layout.ejs").toString()
-);
-const testsTemplate = ejs.compile(
-  fs.readFileSync(__dirname + "/templates/tests.ejs").toString()
-);
-const indexTemplate = ejs.compile(
-  fs.readFileSync(__dirname + "/templates/index.ejs").toString()
-);
-const licensesTemplate = ejs.compile(
-  fs.readFileSync(__dirname + "/templates/licenses.ejs").toString()
-);
-const licenseElementTemplate = ejs.compile(
-  fs.readFileSync(__dirname + "/templates/licenseElement.ejs").toString()
-);
+  // Dependency-related variables
+  const dependencies =
+    JSON.parse(fs.readFileSync(__dirname + "/package.json")).dependencies || {};
+  const requiredDependencyList = Object.keys(dependencies);
+  let dependencyList = Object.keys(dependencies);
 
-let licenseElements = "";
-
-// Generate the licenses list in HTML
-dependencyList.forEach((dependency) => {
-  const packageJSON = JSON.parse(
-    fs
-      .readFileSync(
-        __dirname +
-          "/node_modules/" +
-          dependency.replace(/\/\.\./g, "") +
-          "/package.json"
-      )
-      .toString()
-  );
-  licenseElements += licenseElementTemplate({
-    moduleName: packageJSON.name,
-    name: name,
-    license: packageJSON.license,
-    description: packageJSON.description || "No description",
-    author: packageJSON.author ? packageJSON.author.name : packageJSON.author,
-    required: dependenciesAreRequired[dependency]
-  });
-});
-
-// Generate pages
-const licensesPage = layoutTemplate({
-  title: name + " " + version + " Licenses",
-  content: licensesTemplate({
-    name: name,
-    version: version,
-    licenses: licenseElements
-  })
-});
-
-const testsPage = layoutTemplate({
-  title: name + " " + version + " Tests",
-  content: testsTemplate({
-    name: name,
-    version: version
-  })
-});
-
-const indexPage = layoutTemplate({
-  title: name + " " + version,
-  content: indexTemplate({
-    name: name,
-    version: version,
-    documentationURL: documentationURL,
-    changes: changes
-  })
-});
-
-// Remove the generated assets directory if exists, and create a new one.
-if (fs.existsSync(__dirname + "/generatedAssets")) {
-  if (fs.rmSync) fs.rmSync(__dirname + "/generatedAssets", { recursive: true });
-  else fs.rmdirSync(__dirname + "/generatedAssets", { recursive: true });
-}
-fs.mkdirSync(__dirname + "/generatedAssets");
-
-// Remove the dist directory if exists, and create a new one.
-if (fs.existsSync(__dirname + "/dist")) {
-  if (fs.rmSync) fs.rmSync(__dirname + "/dist", { recursive: true });
-  else fs.rmdirSync(__dirname + "/dist", { recursive: true });
-}
-fs.mkdirSync(__dirname + "/dist");
-fs.mkdirSync(__dirname + "/dist/log");
-fs.mkdirSync(__dirname + "/dist/mods");
-fs.mkdirSync(__dirname + "/dist/temp");
-
-// Remove the out directory if exists, and create a new one.
-if (fs.existsSync(__dirname + "/out")) {
-  if (fs.rmSync) fs.rmSync(__dirname + "/out", { recursive: true });
-  else fs.rmdirSync(__dirname + "/out", { recursive: true });
-}
-fs.mkdirSync(__dirname + "/out");
-
-// Create a licenses directory
-fs.mkdirSync(__dirname + "/generatedAssets/licenses");
-
-// Write to HTML files
-fs.writeFileSync(__dirname + "/generatedAssets/index.html", indexPage);
-fs.writeFileSync(__dirname + "/generatedAssets/tests.html", testsPage);
-fs.writeFileSync(
-  __dirname + "/generatedAssets/licenses/index.html",
-  licensesPage
-);
-
-// Bundle the source and copy the assets using esbuild and esbuild-plugin-copy
-esbuild
-  .build({
-    entryPoints: ["src/index.js"],
-    bundle: true,
-    outfile: "dist/svr.js",
-    platform: "node",
-    target: "es2017",
-    plugins: [
-      esbuildCopyPlugin.copy({
-        resolveFrom: __dirname,
-        assets: {
-          from: ["./assets/**/*"],
-          to: ["./dist"]
-        },
-        globbyOptions: {
-          dot: true
+  // Function to find and add all dependencies into the dependencyList array.
+  const findAllDependencies = (curList) => {
+    // If no curList parameter is specified, use dependencyList.
+    if (!curList) curList = dependencyList;
+    curList.forEach((dependency) => {
+      const newDeplist = Object.keys(
+        JSON.parse(
+          fs
+            .readFileSync(
+              __dirname +
+                "/node_modules/" +
+                dependency.replace(/\/\.\./g, "") +
+                "/package.json"
+            )
+            .toString()
+        ).dependencies || {}
+      );
+      let noDupNewDepList = [];
+      newDeplist.forEach((dep) => {
+        // Ignore duplicates
+        if (dependencyList.indexOf(dep) == -1) {
+          noDupNewDepList.push(dep);
+          dependencyList.push(dep);
         }
-      }),
-      esbuildCopyPlugin.copy({
-        resolveFrom: __dirname,
-        assets: {
-          from: ["./generatedAssets/**/*"],
-          to: ["./dist"]
-        }
-      })
-    ]
-  })
-  .then(() => {
-    const utilFilesAndDirectories = fs.existsSync(
-      __dirname + "/src/extraScripts"
-    )
-      ? fs.readdirSync(__dirname + "/src/extraScripts")
-      : [];
-    const utilFiles = [];
-    utilFilesAndDirectories.forEach((entry) => {
-      if (fs.statSync(__dirname + "/src/extraScripts/" + entry).isFile())
-        utilFiles.push(entry);
-    });
-
-    // Transpile utilities using esbuild
-    esbuild
-      .build({
-        entryPoints: utilFiles.map(
-          (filename) => "src/extraScripts/" + filename
-        ),
-        bundle: true,
-        outdir: "dist",
-        platform: "node",
-        target: "es2017"
-      })
-      .then(() => {
-        const archiveName =
-          "svr.js." +
-          version.toLowerCase().replace(/[^0-9a-z]+/g, ".") +
-          ".zip";
-        const output = fs.createWriteStream(__dirname + "/out/" + archiveName);
-        const archive = archiver("zip", {
-          zlib: { level: 9 }
-        });
-        archive.pipe(output);
-
-        // Add everything in the "dist" directory except for "svr.js" and "svr.compressed"
-        archive.glob("**/*", {
-          cwd: __dirname + "/dist",
-          ignore: ["svr.js", "svr.compressed"],
-          dot: true
-        });
-
-        // Create a stream for the "svr.compressed" file
-        const compressedSVRJSFileStream = fs
-          .createReadStream(__dirname + "/dist/svr.js")
-          .pipe(
-            zlib.createGzip({
-              level: 9
-            })
-          );
-        archive.append(compressedSVRJSFileStream, { name: "svr.compressed" });
-        archive.append(
-          'const zlib = require("zlib");\nconst fs = require("fs");\nconsole.log("Deleting SVR.JS stub...");\nfs.unlinkSync("svr.js");\nconsole.log("Decompressing SVR.JS...");\nconst script = zlib.gunzipSync(fs.readFileSync("svr.compressed"));\nfs.unlinkSync("svr.compressed");\nfs.writeFileSync("svr.js",script);\nconsole.log("Restart SVR.JS to get server interface.");',
-          { name: "svr.js" }
-        );
-        archive.finalize();
-      })
-      .catch((err) => {
-        throw err;
       });
-  })
-  .catch((err) => {
-    throw err;
+      // Call findAllDependencies for the dependency list.
+      findAllDependencies(noDupNewDepList);
+    });
+  };
+
+  // Get list of all dependencies
+  findAllDependencies();
+  dependencyList = dependencyList.sort();
+
+  // Create and populate an object, where whenever the dependencies are required are listed.
+  let dependenciesAreRequired = {};
+  dependencyList.forEach((dependency) => {
+    dependenciesAreRequired[dependency] = false;
   });
+  requiredDependencyList.forEach((dependency) => {
+    dependenciesAreRequired[dependency] = true;
+  });
+
+  // Create the template functions using EJS
+  const layoutTemplate = ejs.compile(
+    fs.readFileSync(__dirname + "/templates/layout.ejs").toString()
+  );
+  const testsTemplate = ejs.compile(
+    fs.readFileSync(__dirname + "/templates/tests.ejs").toString()
+  );
+  const indexTemplate = ejs.compile(
+    fs.readFileSync(__dirname + "/templates/index.ejs").toString()
+  );
+  const licensesTemplate = ejs.compile(
+    fs.readFileSync(__dirname + "/templates/licenses.ejs").toString()
+  );
+  const licenseElementTemplate = ejs.compile(
+    fs.readFileSync(__dirname + "/templates/licenseElement.ejs").toString()
+  );
+
+  let licenseElements = "";
+
+  // Generate the licenses list in HTML
+  dependencyList.forEach((dependency) => {
+    const packageJSON = JSON.parse(
+      fs
+        .readFileSync(
+          __dirname +
+            "/node_modules/" +
+            dependency.replace(/\/\.\./g, "") +
+            "/package.json"
+        )
+        .toString()
+    );
+    licenseElements += licenseElementTemplate({
+      moduleName: packageJSON.name,
+      name: name,
+      license: packageJSON.license,
+      description: packageJSON.description || "No description",
+      author: packageJSON.author ? packageJSON.author.name : packageJSON.author,
+      required: dependenciesAreRequired[dependency]
+    });
+  });
+
+  // Generate pages
+  const licensesPage = layoutTemplate({
+    title: name + " " + version + " Licenses",
+    content: licensesTemplate({
+      name: name,
+      version: version,
+      licenses: licenseElements
+    })
+  });
+
+  const testsPage = layoutTemplate({
+    title: name + " " + version + " Tests",
+    content: testsTemplate({
+      name: name,
+      version: version
+    })
+  });
+
+  const indexPage = layoutTemplate({
+    title: name + " " + version,
+    content: indexTemplate({
+      name: name,
+      version: version,
+      documentationURL: documentationURL,
+      changes: changes
+    })
+  });
+
+  // Create the generated assets directory if it doesn't exist
+  if (!fs.existsSync(__dirname + "/generatedAssets"))
+    fs.mkdirSync(__dirname + "/generatedAssets");
+
+  // Create a licenses directory
+  if (!fs.existsSync(__dirname + "/generatedAssets/licenses"))
+    fs.mkdirSync(__dirname + "/generatedAssets/licenses");
+
+  // Write to HTML files
+  fs.writeFileSync(__dirname + "/generatedAssets/index.html", indexPage);
+  fs.writeFileSync(__dirname + "/generatedAssets/tests.html", testsPage);
+  fs.writeFileSync(
+    __dirname + "/generatedAssets/licenses/index.html",
+    licensesPage
+  );
+}
+
+if (!isDev) {
+  // Generate assets
+  generateAssets();
+} else {
+  // Generate assets with watching
+  const watcher = chokidar.watch([
+    __dirname + "/templates",
+    __dirname + "/package.json",
+    __dirname + "/svrjs.json"
+  ]);
+  watcher.on("change", () => {
+    try {
+      generateAssets();
+    } catch (err) {
+      console.error("There is a problem when regenerating assets!");
+      console.error("Stack:");
+      console.error(err.stack);
+    }
+  }).on("ready", () => {
+    try {
+      generateAssets();
+    } catch (err) {
+      console.error("There is a problem when regenerating assets!");
+      console.error("Stack:");
+      console.error(err.stack);
+    }
+  });
+}
+
+if (!isDev) {
+  // Bundle the source and copy the assets using esbuild and esbuild-plugin-copy
+  esbuild
+    .build({
+      entryPoints: ["src/index.js"],
+      bundle: true,
+      outfile: "dist/svr.js",
+      platform: "node",
+      target: "es2017",
+      plugins: [
+        esbuildCopyPlugin.copy({
+          resolveFrom: __dirname,
+          assets: {
+            from: ["./assets/**/*"],
+            to: ["./dist"]
+          },
+          globbyOptions: {
+            dot: true
+          }
+        }),
+        esbuildCopyPlugin.copy({
+          resolveFrom: __dirname,
+          assets: {
+            from: ["./generatedAssets/**/*"],
+            to: ["./dist"]
+          }
+        })
+      ]
+    })
+    .then(() => {
+      const utilFilesAndDirectories = fs.existsSync(
+        __dirname + "/src/extraScripts"
+      )
+        ? fs.readdirSync(__dirname + "/src/extraScripts")
+        : [];
+      const utilFiles = [];
+      utilFilesAndDirectories.forEach((entry) => {
+        if (fs.statSync(__dirname + "/src/extraScripts/" + entry).isFile())
+          utilFiles.push(entry);
+      });
+
+      // Transpile utilities using esbuild
+      esbuild
+        .build({
+          entryPoints: utilFiles.map(
+            (filename) => "src/extraScripts/" + filename
+          ),
+          bundle: true,
+          outdir: "dist",
+          platform: "node",
+          target: "es2017"
+        })
+        .then(() => {
+          const archiveName =
+            "svr.js." +
+            version.toLowerCase().replace(/[^0-9a-z]+/g, ".") +
+            ".zip";
+          const output = fs.createWriteStream(
+            __dirname + "/out/" + archiveName
+          );
+          const archive = archiver("zip", {
+            zlib: { level: 9 }
+          });
+          archive.pipe(output);
+
+          // Add everything in the "dist" directory except for "svr.js" and "svr.compressed"
+          archive.glob("**/*", {
+            cwd: __dirname + "/dist",
+            ignore: ["svr.js", "svr.compressed"],
+            dot: true
+          });
+
+          // Create a stream for the "svr.compressed" file
+          const compressedSVRJSFileStream = fs
+            .createReadStream(__dirname + "/dist/svr.js")
+            .pipe(
+              zlib.createGzip({
+                level: 9
+              })
+            );
+          archive.append(compressedSVRJSFileStream, { name: "svr.compressed" });
+          archive.append(
+            'const zlib = require("zlib");\nconst fs = require("fs");\nconsole.log("Deleting SVR.JS stub...");\nfs.unlinkSync("svr.js");\nconsole.log("Decompressing SVR.JS...");\nconst script = zlib.gunzipSync(fs.readFileSync("svr.compressed"));\nfs.unlinkSync("svr.compressed");\nfs.writeFileSync("svr.js",script);\nconsole.log("Restart SVR.JS to get server interface.");',
+            { name: "svr.js" }
+          );
+          archive.finalize();
+        })
+        .catch((err) => {
+          throw err;
+        });
+    })
+    .catch((err) => {
+      throw err;
+    });
+} else {
+  // Bundle the source and copy the assets using esbuild and esbuild-plugin-copy with watching
+  esbuild
+    .context({
+      entryPoints: ["src/index.js"],
+      bundle: true,
+      outfile: "dist/svr.js",
+      platform: "node",
+      target: "es2017",
+      plugins: [
+        esbuildCopyPlugin.copy({
+          resolveFrom: __dirname,
+          assets: {
+            from: ["./assets/**/*"],
+            to: ["./dist"]
+          },
+          globbyOptions: {
+            dot: true
+          },
+          watch: {}
+        }),
+        esbuildCopyPlugin.copy({
+          resolveFrom: __dirname,
+          assets: {
+            from: ["./generatedAssets/**/*"],
+            to: ["./dist"]
+          },
+          watch: {}
+        })
+      ]
+    })
+    .then((ctx) => {
+      ctx
+        .watch()
+        .then(() => {
+          const utilFilesAndDirectories = fs.existsSync(
+            __dirname + "/src/extraScripts"
+          )
+            ? fs.readdirSync(__dirname + "/src/extraScripts")
+            : [];
+          const utilFiles = [];
+          utilFilesAndDirectories.forEach((entry) => {
+            if (fs.statSync(__dirname + "/src/extraScripts/" + entry).isFile())
+              utilFiles.push(entry);
+          });
+
+          // Transpile utilities using esbuild
+          esbuild
+            .context({
+              entryPoints: utilFiles.map(
+                (filename) => "src/extraScripts/" + filename
+              ),
+              bundle: true,
+              outdir: "dist",
+              platform: "node",
+              target: "es2017"
+            })
+            .then((ctx) => {
+              ctx
+                .watch()
+                .then(() => {
+                  console.log("Watching for changes in SVR.JS source code...");
+                })
+                .catch((err) => {
+                  throw err;
+                });
+            })
+            .catch((err) => {
+              throw err;
+            });
+        })
+        .catch((err) => {
+          throw err;
+        });
+    })
+    .catch((err) => {
+      throw err;
+    });
+}

nodemon.json

@@ -0,0 +1,6 @@
+{
+    "watch": [
+      "dist/svr.js",
+      "dist/config.json"
+    ]
+}

package.json

@@ -3,9 +3,10 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "node esbuild.config.js",
+    "build": "npm run clean && NODE_ENV=production node esbuild.config.js",
     "cz": "cz",
-    "dev": "npm run build && npm run start",
+    "clean": "rimraf dist && rimraf out && rimraf generatedAssets",
+    "dev": "npm run clean && concurrently \"NODE_ENV=development node esbuild.config.js\" \"wait-on dist/svr.js && nodemon dist/svr.js --stdout-notty --no-save-config\"",
     "lint": "eslint --no-error-on-unmatched-pattern src/**/*.js src/*.js tests/**/*.test.js tests/**/*.js tests/*.test.js tests/*.js",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "husky",
@@ -20,7 +21,9 @@
     "@commitlint/config-conventional": "^19.4.1",
     "@eslint/js": "^9.9.0",
     "archiver": "^7.0.1",
+    "chokidar": "^4.0.1",
     "commitizen": "^4.3.0",
+    "concurrently": "^9.1.0",
     "cz-conventional-changelog": "^3.3.0",
     "ejs": "^3.1.10",
     "esbuild": "^0.23.1",
@@ -34,7 +37,10 @@
     "jest": "^29.7.0",
     "lint-staged": "^15.2.10",
     "node-mocks-http": "^1.15.1",
-    "prettier": "^3.3.3"
+    "nodemon": "^3.1.7",
+    "prettier": "^3.3.3",
+    "rimraf": "^5.0.10",
+    "wait-on": "^8.0.1"
   },
   "dependencies": {
     "formidable": "^2.1.2",

src/handlers/clientErrorHandler.js

@@ -12,6 +12,9 @@ let serverconsole = {};
 function clientErrorHandler(err, socket) {
   const config = deepClone(process.serverConfig);
 
+  // Determine the webroot from the current working directory if it is not configured
+  if (config.wwwroot === undefined) config.wwwroot = process.cwd();
+
   config.generateServerString = () =>
     generateServerString(config.exposeServerVersion);
 
@@ -182,14 +185,14 @@ function clientErrorHandler(err, socket) {
             fs.access(config.page404, fs.constants.F_OK, (err) => {
               if (err) {
                 fs.access(
-                  "." + errorCode.toString(),
+                  config.wwwroot + "/." + errorCode.toString(),
                   fs.constants.F_OK,
                   (err) => {
                     try {
                       if (err) {
                         callback(errorCode.toString() + ".html");
                       } else {
-                        callback("." + errorCode.toString());
+                        callback(config.wwwroot + "/." + errorCode.toString());
                       }
                     } catch (err2) {
                       callServerError(500, err2);
@@ -205,17 +208,21 @@ function clientErrorHandler(err, socket) {
               }
             });
           } else {
-            fs.access("." + errorCode.toString(), fs.constants.F_OK, (err) => {
-              try {
-                if (err) {
-                  callback(errorCode.toString() + ".html");
-                } else {
-                  callback("." + errorCode.toString());
+            fs.access(
+              config.wwwroot + "/." + errorCode.toString(),
+              fs.constants.F_OK,
+              (err) => {
+                try {
+                  if (err) {
+                    callback(errorCode.toString() + ".html");
+                  } else {
+                    callback(config.wwwroot + "/." + errorCode.toString());
+                  }
+                } catch (err2) {
+                  callServerError(500, err2);
                 }
-              } catch (err2) {
-                callServerError(500, err2);
               }
-            });
+            );
           }
         }
       };
@@ -457,15 +464,15 @@ function clientErrorHandler(err, socket) {
     } sent invalid request.`
   );
   try {
-    head = fs.existsSync("./.head")
-      ? fs.readFileSync("./.head").toString()
-      : fs.existsSync("./head.html")
-        ? fs.readFileSync("./head.html").toString()
+    head = fs.existsSync(`${config.wwwroot}/.head`)
+      ? fs.readFileSync(`${config.wwwroot}/.head`).toString()
+      : fs.existsSync(`${config.wwwroot}/head.html`)
+        ? fs.readFileSync(`${config.wwwroot}/head.html`).toString()
         : ""; // header
-    foot = fs.existsSync("./.foot")
-      ? fs.readFileSync("./.foot").toString()
-      : fs.existsSync("./foot.html")
-        ? fs.readFileSync("./foot.html").toString()
+    foot = fs.existsSync(`${config.wwwroot}/.foot`)
+      ? fs.readFileSync(`${config.wwwroot}/.foot`).toString()
+      : fs.existsSync(`${config.wwwroot}/foot.html`)
+        ? fs.readFileSync(`${config.wwwroot}/foot.html`).toString()
         : ""; // footer
 
     if (

src/handlers/proxyHandler.js

@@ -32,6 +32,9 @@ function proxyHandler(req, socket, head) {
   // SVR.JS configuration object (modified)
   const config = deepClone(process.serverConfig);
 
+  // Determine the webroot from the current working directory if it is not configured
+  if (config.wwwroot === undefined) config.wwwroot = process.cwd();
+
   config.generateServerString = () =>
     generateServerString(config.exposeServerVersion);
 

src/handlers/requestHandler.js

@@ -37,6 +37,9 @@ function requestHandler(req, res) {
   config.generateServerString = () =>
     generateServerString(config.exposeServerVersion);
 
+  // Determine the webroot from the current working directory if it is not configured
+  if (config.wwwroot === undefined) config.wwwroot = process.cwd();
+
   // getCustomHeaders() in SVR.JS 3.x
   config.getCustomHeaders = () => {
     let ph = Object.assign({}, config.customHeaders);
@@ -345,14 +348,14 @@ function requestHandler(req, res) {
             fs.access(config.page404, fs.constants.F_OK, (err) => {
               if (err) {
                 fs.access(
-                  "." + errorCode.toString(),
+                  config.wwwroot + "/." + errorCode.toString(),
                   fs.constants.F_OK,
                   (err) => {
                     try {
                       if (err) {
                         callback(errorCode.toString() + ".html");
                       } else {
-                        callback("." + errorCode.toString());
+                        callback(config.wwwroot + "/." + errorCode.toString());
                       }
                     } catch (err2) {
                       res.error(500, err2);
@@ -368,17 +371,21 @@ function requestHandler(req, res) {
               }
             });
           } else {
-            fs.access("." + errorCode.toString(), fs.constants.F_OK, (err) => {
-              try {
-                if (err) {
-                  callback(errorCode.toString() + ".html");
-                } else {
-                  callback("." + errorCode.toString());
+            fs.access(
+              config.wwwroot + "/." + errorCode.toString(),
+              fs.constants.F_OK,
+              (err) => {
+                try {
+                  if (err) {
+                    callback(errorCode.toString() + ".html");
+                  } else {
+                    callback(config.wwwroot + "/." + errorCode.toString());
+                  }
+                } catch (err2) {
+                  res.error(500, err2);
                 }
-              } catch (err2) {
-                res.error(500, err2);
               }
-            });
+            );
           }
         }
       };
@@ -633,15 +640,15 @@ function requestHandler(req, res) {
   };
 
   try {
-    res.head = fs.existsSync("./.head")
-      ? fs.readFileSync("./.head").toString()
-      : fs.existsSync("./head.html")
-        ? fs.readFileSync("./head.html").toString()
+    res.head = fs.existsSync(`${config.wwwroot}/.head`)
+      ? fs.readFileSync(`${config.wwwroot}/.head`).toString()
+      : fs.existsSync(`${config.wwwroot}/head.html`)
+        ? fs.readFileSync(`${config.wwwroot}/head.html`).toString()
         : ""; // header
-    res.foot = fs.existsSync("./.foot")
-      ? fs.readFileSync("./.foot").toString()
-      : fs.existsSync("./foot.html")
-        ? fs.readFileSync("./foot.html").toString()
+    res.foot = fs.existsSync(`${config.wwwroot}/.foot`)
+      ? fs.readFileSync(`${config.wwwroot}/.foot`).toString()
+      : fs.existsSync(`${config.wwwroot}/foot.html`)
+        ? fs.readFileSync(`${config.wwwroot}/foot.html`).toString()
         : ""; // footer
   } catch (err) {
     res.error(500, err);

src/index.js

@@ -117,7 +117,7 @@ if (process.versions) process.versions.svrjs = version; // Inject SVR.JS into pr
 function printUsage() {
   console.log(`${name} usage:`);
   console.log(
-    "node svr.js [-h] [--help] [-?] [/h] [/?] [--secure] [--reset] [--clean] [--disable-mods] [--single-threaded] [-v] [--version]"
+    "node svr.js [-h] [--help] [-?] [/h] [/?] [--secure] [--reset] [--clean] [--disable-mods] [--single-threaded] [--stdout-notty] [--no-save-config] [-v] [--version]"
   );
   console.log("-h -? /h /? --help    -- Displays help");
   console.log("--clean               -- Cleans up files created by " + name);
@@ -127,12 +127,18 @@ function printUsage() {
   console.log("--secure              -- Runs HTTPS server");
   console.log("--disable-mods        -- Disables mods (safe mode)");
   console.log("--single-threaded     -- Run single-threaded");
+  console.log(
+    "--stdout-notty        -- Enable stdout even when stdout is not a TTY. May decrease the performace"
+  );
+  console.log("--no-save-config      -- Don't save configuration file");
   console.log("-v --version          -- Display server version");
 }
 
 let exiting = false;
 let forceSecure = false;
 let disableMods = false;
+let stdoutNoTTY = false;
+let noSaveConfig = false;
 
 // Handle command line arguments
 const args = process.argv;
@@ -184,6 +190,10 @@ for (
     disableMods = true;
   } else if (args[i] == "--single-threaded") {
     process.singleThreaded = true;
+  } else if (args[i] == "--stdout-notty") {
+    stdoutNoTTY = true;
+  } else if (args[i] == "--no-save-config") {
+    noSaveConfig = true;
   } else {
     console.log(`Unrecognized argument: ${args[i]}`);
     printUsage();
@@ -329,6 +339,11 @@ if (process.serverConfig.allowPostfixDoubleSlashes === undefined)
   process.serverConfig.allowPostfixDoubleSlashes = false;
 if (process.serverConfig.optOutOfStatisticsServer === undefined)
   process.serverConfig.optOutOfStatisticsServer = false;
+if (process.serverConfig.disableConfigurationSaving === undefined)
+  process.serverConfig.disableConfigurationSaving = false;
+
+// Don't save configuration if disableConfigurationSaving option is set to true
+if (process.serverConfig.disableConfigurationSaving) noSaveConfig = true;
 
 // Compatiblity for very old SVR.JS mods
 process.serverConfig.version = version;
@@ -385,7 +400,7 @@ try {
   // Failed to get inspector URL
 }
 
-if (!process.stdout.isTTY && !inspectorURL) {
+if (!stdoutNoTTY && !process.stdout.isTTY && !inspectorURL) {
   // When stdout is not a terminal and not attached to an Node.JS inspector, disable it to improve performance of SVR.JS
   console.log = () => {};
   process.stdout.write = () => {};
@@ -797,7 +812,11 @@ if (!disableMods) {
   }
 
   // Determine path of server-side script file
-  let SSJSPath = "./serverSideScript.js";
+  let SSJSPath = `${
+    process.serverConfig.wwwroot != undefined
+      ? process.serverConfig.wwwroot
+      : process.dirname
+  }/serverSideScript.js`;
   if (!process.serverConfig.useWebRootServerSideScript)
     SSJSPath = process.dirname + "/serverSideScript.js";
 
@@ -1686,6 +1705,8 @@ function saveConfig() {
         configJSONobj.allowDoubleSlashes = false;
       if (configJSONobj.optOutOfStatisticsServer === undefined)
         configJSONobj.optOutOfStatisticsServer = false;
+      if (configJSONobj.disableConfigurationSaving === undefined)
+        configJSONobj.disableConfigurationSaving = false;
 
       fs.writeFileSync(
         process.dirname + "/config.json",
@@ -1978,69 +1999,73 @@ function start(init) {
     let workersToFork = 1;
 
     if (cluster.isPrimary === undefined) {
-      setInterval(() => {
-        try {
-          saveConfig();
-          serverconsole.locmessage("Configuration saved.");
-        } catch (err) {
-          throw new Error(err);
-        }
-      }, 300000);
-    } else if (cluster.isPrimary) {
-      setInterval(() => {
-        let allWorkers = Object.keys(cluster.workers);
-        let goodWorkers = [];
-
-        const checkWorker = (callback, _id) => {
-          if (typeof _id === "undefined") _id = 0;
-          if (_id >= allWorkers.length) {
-            callback();
-            return;
-          }
+      if (!noSaveConfig) {
+        setInterval(() => {
           try {
-            if (cluster.workers[allWorkers[_id]]) {
-              isWorkerHungUpBuff2 = true;
-              cluster.workers[allWorkers[_id]].on("message", msgListener);
-              cluster.workers[allWorkers[_id]].send("\x14PINGPING");
-              setTimeout(() => {
-                if (isWorkerHungUpBuff2) {
-                  checkWorker(callback, _id + 1);
-                } else {
-                  goodWorkers.push(allWorkers[_id]);
-                  checkWorker(callback, _id + 1);
-                }
-              }, 250);
-            } else {
+            saveConfig();
+            serverconsole.locmessage("Configuration saved.");
+          } catch (err) {
+            throw new Error(err);
+          }
+        }, 300000);
+      }
+    } else if (cluster.isPrimary) {
+      if (!noSaveConfig) {
+        setInterval(() => {
+          let allWorkers = Object.keys(cluster.workers);
+          let goodWorkers = [];
+
+          const checkWorker = (callback, _id) => {
+            if (typeof _id === "undefined") _id = 0;
+            if (_id >= allWorkers.length) {
+              callback();
+              return;
+            }
+            try {
+              if (cluster.workers[allWorkers[_id]]) {
+                isWorkerHungUpBuff2 = true;
+                cluster.workers[allWorkers[_id]].on("message", msgListener);
+                cluster.workers[allWorkers[_id]].send("\x14PINGPING");
+                setTimeout(() => {
+                  if (isWorkerHungUpBuff2) {
+                    checkWorker(callback, _id + 1);
+                  } else {
+                    goodWorkers.push(allWorkers[_id]);
+                    checkWorker(callback, _id + 1);
+                  }
+                }, 250);
+              } else {
+                checkWorker(callback, _id + 1);
+              }
+              // eslint-disable-next-line no-unused-vars
+            } catch (err) {
+              if (cluster.workers[allWorkers[_id]]) {
+                cluster.workers[allWorkers[_id]].removeAllListeners("message");
+                addListenersToWorker(cluster.workers[allWorkers[_id]]);
+              }
               checkWorker(callback, _id + 1);
             }
-            // eslint-disable-next-line no-unused-vars
-          } catch (err) {
-            if (cluster.workers[allWorkers[_id]]) {
-              cluster.workers[allWorkers[_id]].removeAllListeners("message");
-              addListenersToWorker(cluster.workers[allWorkers[_id]]);
+          };
+          checkWorker(() => {
+            const wN = Math.floor(Math.random() * goodWorkers.length); //Send a configuration saving message to a random worker.
+            try {
+              if (cluster.workers[goodWorkers[wN]]) {
+                isWorkerHungUpBuff2 = true;
+                cluster.workers[goodWorkers[wN]].on("message", msgListener);
+                cluster.workers[goodWorkers[wN]].send("\x14SAVECONF");
+              }
+            } catch (err) {
+              if (cluster.workers[goodWorkers[wN]]) {
+                cluster.workers[goodWorkers[wN]].removeAllListeners("message");
+                addListenersToWorker(cluster.workers[goodWorkers[wN]]);
+              }
+              serverconsole.locwarnmessage(
+                `There was a problem while saving configuration file. Reason: ${err.message}`
+              );
             }
-            checkWorker(callback, _id + 1);
-          }
-        };
-        checkWorker(() => {
-          const wN = Math.floor(Math.random() * goodWorkers.length); //Send a configuration saving message to a random worker.
-          try {
-            if (cluster.workers[goodWorkers[wN]]) {
-              isWorkerHungUpBuff2 = true;
-              cluster.workers[goodWorkers[wN]].on("message", msgListener);
-              cluster.workers[goodWorkers[wN]].send("\x14SAVECONF");
-            }
-          } catch (err) {
-            if (cluster.workers[goodWorkers[wN]]) {
-              cluster.workers[goodWorkers[wN]].removeAllListeners("message");
-              addListenersToWorker(cluster.workers[goodWorkers[wN]]);
-            }
-            serverconsole.locwarnmessage(
-              `There was a problem while saving configuration file. Reason: ${err.message}`
-            );
-          }
-        });
-      }, 300000);
+          });
+        }, 300000);
+      }
     }
 
     if (!cluster.isPrimary && cluster.isPrimary !== undefined) {
@@ -2429,7 +2454,7 @@ if (cluster.isPrimary || cluster.isPrimary === undefined) {
 
   process.on("exit", (code) => {
     try {
-      if (!configJSONRErr && !configJSONPErr) {
+      if (!configJSONRErr && !configJSONPErr && !noSaveConfig) {
         saveConfig();
       }
     } catch (err) {

src/middleware/checkForbiddenPaths.js

@@ -8,8 +8,12 @@ const {
 } = require("../utils/forbiddenPaths.js");
 const svrjsInfo = require("../../svrjs.json");
 const { name } = svrjsInfo;
+const wwwroot =
+  process.serverConfig && process.serverConfig.wwwroot !== undefined
+    ? process.serverConfig.wwwroot
+    : ".";
 
-forbiddenPaths.config = getInitializePath("./config.json");
+forbiddenPaths.config = getInitializePath(`${wwwroot}/config.json`);
 forbiddenPaths.certificates = [];
 if (process.serverConfig.secure) {
   forbiddenPaths.certificates.push(
@@ -26,7 +30,8 @@ if (process.serverConfig.secure) {
   });
 }
 forbiddenPaths.svrjs = getInitializePath(
-  "./" +
+  wwwroot +
+    "/" +
     (process.dirname[process.dirname.length - 1] != "/"
       ? process.filename.replace(process.dirname + "/", "")
       : process.filename.replace(process.dirname, ""))
@@ -36,16 +41,18 @@ if (process.serverConfig.useWebRootServerSideScript) {
   forbiddenPaths.serverSideScripts.push("/serverSideScript.js");
 } else {
   forbiddenPaths.serverSideScripts.push(
-    getInitializePath("./serverSideScript.js")
+    getInitializePath(`${wwwroot}/serverSideScript.js`)
   );
 }
 forbiddenPaths.serverSideScriptDirectories = [];
 forbiddenPaths.serverSideScriptDirectories.push(
-  getInitializePath("./node_modules")
+  getInitializePath(`${wwwroot}/node_modules`)
 );
-forbiddenPaths.serverSideScriptDirectories.push(getInitializePath("./mods"));
-forbiddenPaths.temp = getInitializePath("./temp");
-forbiddenPaths.log = getInitializePath("./log");
+forbiddenPaths.serverSideScriptDirectories.push(
+  getInitializePath(wwwroot + "/mods")
+);
+forbiddenPaths.temp = getInitializePath(`${wwwroot}/temp`);
+forbiddenPaths.log = getInitializePath(`${wwwroot}/log`);
 
 module.exports = (req, res, logFacilities, config, next) => {
   let decodedHrefWithoutDuplicateSlashes = "";

src/middleware/redirectTrailingSlashes.js

@@ -9,22 +9,25 @@ module.exports = (req, res, logFacilities, config, next) => {
     req.originalParsedURL.pathname[req.originalParsedURL.pathname.length - 1] !=
       "/"
   ) {
-    fs.stat("." + decodeURIComponent(req.parsedURL.pathname), (err, stats) => {
-      if (err || !stats.isDirectory()) {
-        try {
-          next();
-        } catch (err) {
-          res.error(500, err);
+    fs.stat(
+      config.wwwroot + decodeURIComponent(req.parsedURL.pathname),
+      (err, stats) => {
+        if (err || !stats.isDirectory()) {
+          try {
+            next();
+          } catch (err) {
+            res.error(500, err);
+          }
+        } else {
+          res.redirect(
+            req.originalParsedURL.pathname +
+              "/" +
+              (req.parsedURL.search ? req.parsedURL.search : "") +
+              (req.parsedURL.hash ? req.parsedURL.hash : "")
+          );
         }
-      } else {
-        res.redirect(
-          req.originalParsedURL.pathname +
-            "/" +
-            (req.parsedURL.search ? req.parsedURL.search : "") +
-            (req.parsedURL.hash ? req.parsedURL.hash : "")
-        );
       }
-    });
+    );
   } else {
     next();
   }

src/middleware/rewriteURL.js

@@ -28,7 +28,7 @@ module.exports = (req, res, logFacilities, config, next) => {
           !_fileState
         ) {
           fs.stat(
-            "." + decodeURIComponent(req.parsedURL.pathname),
+            config.wwwroot + decodeURIComponent(req.parsedURL.pathname),
             (err, stats) => {
               let _fileState = 3;
               if (err) {

src/middleware/staticFileServingAndDirectoryListings.js

@@ -86,7 +86,7 @@ module.exports = (req, res, logFacilities, config, next) => {
     res.error(400);
     return;
   }
-  let readFrom = "." + dHref;
+  let readFrom = config.wwwroot + dHref;
   let dirImagesMissing = false;
   fs.stat(readFrom, (err, stats) => {
     if (err) {
@@ -502,13 +502,16 @@ module.exports = (req, res, logFacilities, config, next) => {
 
           const getCustomDirListingHeader = (callback) => {
             fs.readFile(
-              ("." + dHref + "/.dirhead").replace(/\/+/g, "/"),
+              (config.wwwroot + dHref + "/.dirhead").replace(/\/+/g, "/"),
               (err, data) => {
                 if (err) {
                   if (err.code == "ENOENT" || err.code == "EISDIR") {
                     if (os.platform != "win32" || href != "/") {
                       fs.readFile(
-                        ("." + dHref + "/HEAD.html").replace(/\/+/g, "/"),
+                        (config.wwwroot + dHref + "/HEAD.html").replace(
+                          /\/+/g,
+                          "/"
+                        ),
                         (err, data) => {
                           if (err) {
                             if (err.code == "ENOENT" || err.code == "EISDIR") {
@@ -538,13 +541,16 @@ module.exports = (req, res, logFacilities, config, next) => {
 
           const getCustomDirListingFooter = (callback) => {
             fs.readFile(
-              ("." + dHref + "/.dirfoot").replace(/\/+/g, "/"),
+              (config.wwwroot + dHref + "/.dirfoot").replace(/\/+/g, "/"),
               (err, data) => {
                 if (err) {
                   if (err.code == "ENOENT" || err.code == "EISDIR") {
                     if (os.platform != "win32" || href != "/") {
                       fs.readFile(
-                        ("." + dHref + "/FOOT.html").replace(/\/+/g, "/"),
+                        (config.wwwroot + dHref + "/FOOT.html").replace(
+                          /\/+/g,
+                          "/"
+                        ),
                         (err, data) => {
                           if (err) {
                             if (err.code == "ENOENT" || err.code == "EISDIR") {
@@ -646,7 +652,7 @@ module.exports = (req, res, logFacilities, config, next) => {
 
               if (
                 fs.existsSync(
-                  "." +
+                  config.wwwroot +
                     decodeURIComponent(href) +
                     "/.maindesc".replace(/\/+/g, "/")
                 )
@@ -654,7 +660,7 @@ module.exports = (req, res, logFacilities, config, next) => {
                 htmlFoot =
                   "</table><hr/>" +
                   fs.readFileSync(
-                    "." +
+                    config.wwwroot +
                       decodeURIComponent(href) +
                       "/.maindesc".replace(/\/+/g, "/")
                   ) +

svrjs.json

@@ -1,9 +1,9 @@
 {
-  "version": "4.1.0",
+  "version": "Nightly-GitNext",
   "name": "SVR.JS",
   "documentationURL": "https://svrjs.org/docs",
   "statisticsServerCollectEndpoint": "https://statistics.svrjs.org/collect.svr",
   "changes": [
-    "Added experimental support for Deno 2."
+    "INSERT CHANGES THERE"
   ]
 }

templates/index.ejs

@@ -73,7 +73,8 @@
   "disableTrailingSlashRedirects": false,
   "environmentVariables": {},
   "allowDoubleSlashes": false,
-  "optOutOfStatisticsServer": false
+  "optOutOfStatisticsServer": false,
+  "disableConfigurationSaving": false
 }</pre>
     </code>
     <p>Changes:</p>

tests/middleware/blocklist.test.js

@@ -1,8 +1,8 @@
 const middleware = require("../../src/utils/ipBlockList.js");
-const cluster = require("../../src/utils/clusterBunShim.js");
+const cluster = require("../../src/utils/clusterShim.js");
 
 jest.mock("../../src/utils/ipBlockList.js");
-jest.mock("../../src/utils/clusterBunShim.js");
+jest.mock("../../src/utils/clusterShim.js");
 
 const ipBlockListAdd = jest.fn();
 const ipBlockListCheck = jest.fn();

tests/middleware/nonStandardCodesAndHttpAuthentication.test.js

@@ -2,13 +2,13 @@ const sha256 = require("../../src/utils/sha256.js");
 const ipMatch = require("../../src/utils/ipMatch.js");
 const matchHostname = require("../../src/utils/matchHostname.js");
 const ipBlockList = require("../../src/utils/ipBlockList.js");
-const cluster = require("../../src/utils/clusterBunShim.js");
+const cluster = require("../../src/utils/clusterShim.js");
 
 jest.mock("../../src/utils/sha256.js");
 jest.mock("../../src/utils/ipMatch.js");
 jest.mock("../../src/utils/matchHostname.js");
 jest.mock("../../src/utils/ipBlockList.js");
-jest.mock("../../src/utils/clusterBunShim.js");
+jest.mock("../../src/utils/clusterShim.js");
 
 let mockScryptHash = "mocked-scrypt-hash";
 let mockPbkdf2Hash = "mocked-pbkdf2-hash";