Path checks and version update. (#189)

This PR adds checking before starting a `StaticServer` and prepares for
a new release.

Author: danfuzz

CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+### v0.5.13 -- 2023-05-09
+
+Notable changes:
+
+* Somewhat better error checking on startup.
+* Build infrastructure update:
+  * Introduced use of `package-lock.json`.
+  * Pulled in improved `bashy-lib`.
+
 ### v0.5.12 -- 2023-05-02
 
 Notable changes:

src/app-util/package.json

@@ -14,6 +14,7 @@
   "dependencies": {
     "@this/app-config": "*",
     "@this/async": "*",
+    "@this/fs-util": "*",
     "@this/loggy": "*",
     "@this/typey": "*"
   }

src/app-util/private/BaseFilePreserver.js

@@ -5,6 +5,7 @@ import * as fs from 'node:fs/promises';
 
 import { FileServiceConfig } from '@this/app-config';
 import { Condition, Threadlet } from '@this/async';
+import { FsUtil } from '@this/fs-util';
 import { IntfLogger } from '@this/loggy';
 import { Methods, MustBe } from '@this/typey';
 
@@ -305,7 +306,7 @@ export class BaseFilePreserver {
       // turns out to be wrong, we'll fall back to the more involved code.
       const count    = this.#lastInfixCount + 1;
       const firstTry = resolve(count);
-      if (!await BaseFilePreserver.#fileExists(firstTry)) {
+      if (!await FsUtil.fileExists(firstTry)) {
         this.#lastInfixCount = count;
         return firstTry;
       }
@@ -334,25 +335,6 @@ export class BaseFilePreserver {
   // Static members
   //
 
-  /**
-   * Checks to see if the given file exists.
-   *
-   * @param {string} filePath Path to the file.
-   * @returns {boolean} The answer.
-   */
-  static async #fileExists(filePath) {
-    try {
-      await fs.stat(filePath);
-      return true;
-    } catch (e) {
-      if (e.code === 'ENOENT') {
-        // Not found. Not a real error in this case.
-        return false;
-      }
-      throw e;
-    }
-  }
-
   /**
    * Gets a date string with optional count to use as an "infix" for a preserved
    * file.

src/async/tests/EventSink.test.js

@@ -4,7 +4,8 @@
 import * as timers from 'node:timers/promises';
 
 import { EventPayload, EventSink, LinkedEvent, ManualPromise, PromiseState,
-  PromiseUtil } from '@this/async';
+  PromiseUtil }
+  from '@this/async';
 
 
 const payload1 = new EventPayload('wacky');

src/async/tests/EventTracker.test.js

@@ -3,8 +3,7 @@
 
 import * as timers from 'node:timers/promises';
 
-import { EventPayload, EventTracker, LinkedEvent, ManualPromise, PromiseState }
-  from '@this/async';
+import { EventPayload, EventTracker, LinkedEvent, ManualPromise, PromiseState } from '@this/async';
 
 
 const payload1 = new EventPayload('1:wacky:1');

src/builtin-applications/export/StaticFiles.js

@@ -5,6 +5,7 @@ import express from 'express';
 
 import { ApplicationConfig, Files } from '@this/app-config';
 import { BaseApplication } from '@this/app-framework';
+import { FsUtil } from '@this/fs-util';
 import { IntfLogger } from '@this/loggy';
 
 
@@ -33,8 +34,10 @@ export class StaticFiles extends BaseApplication {
   constructor(config, logger) {
     super(config, logger);
 
-    this.#notFoundPath     = config.notFoundPath;
-    this.#staticMiddleware = express.static(config.siteDirectory);
+    const { notFoundPath, siteDirectory } = config;
+
+    this.#notFoundPath     = notFoundPath;
+    this.#staticMiddleware = express.static(siteDirectory);
   }
 
   /** @override */
@@ -52,7 +55,17 @@ export class StaticFiles extends BaseApplication {
 
   /** @override */
   async _impl_start(isReload_unused) {
-    // Nothing to do here.
+    const { notFoundPath, siteDirectory } = this.config;
+
+    if (!await FsUtil.directoryExists(siteDirectory)) {
+      throw new Error(`Not found or not a directory: ${siteDirectory}`);
+    }
+
+    if (notFoundPath) {
+      if (!await FsUtil.fileExists(notFoundPath)) {
+        throw new Error(`Not found or not a file: ${notFoundPath}`);
+      }
+    }
   }
 
   /** @override */

src/builtin-applications/package.json

@@ -14,6 +14,7 @@
   "dependencies": {
     "@this/app-config": "*",
     "@this/app-framework": "*",
+    "@this/fs-util": "*",
     "@this/loggy": "*",
     "@this/typey": "*",
     "express": "^4.18.2"

src/fs-util/README.md

@@ -0,0 +1,10 @@
+@this/fs-util
+=============
+
+Filesystem utility classes.
+
+- - - - - - - - - -
+```
+Copyright 2022-2023 the Lactoserv Authors (Dan Bornstein et alia).
+SPDX-License-Identifier: Apache-2.0
+```

src/fs-util/export/FsUtil.js

@@ -0,0 +1,83 @@
+// Copyright 2022-2023 the Lactoserv Authors (Dan Bornstein et alia).
+// SPDX-License-Identifier: Apache-2.0
+
+import * as fs from 'node:fs/promises';
+
+import { MustBe } from '@this/typey';
+
+
+/**
+ * General filesystem utility class.
+ */
+export class FsUtil {
+  /**
+   * Checks to see if the given path exists in the filesystem, and is a
+   * directory (not a regular or special file).
+   *
+   * @param {string} path Path to check.
+   * @returns {boolean} The answer.
+   */
+  static async directoryExists(path) {
+    const stats = await this.#statOrNull(path);
+
+    return stats && stats.isDirectory();
+  }
+
+  /**
+   * Checks to see if the given path exists in the filesystem, and is a regular
+   * file (not a directory or special file).
+   *
+   * @param {string} path Path to check.
+   * @returns {boolean} The answer.
+   */
+  static async fileExists(path) {
+    const stats = await this.#statOrNull(path);
+
+    return stats && stats.isFile();
+  }
+
+  /**
+   * Checks to see if the given path exists in the filesystem.
+   *
+   * @param {string} path Path to check.
+   * @returns {boolean} The answer.
+   */
+  static async pathExists(path) {
+    const stats = await this.#statOrNull(path);
+
+    return (stats !== null);
+  }
+
+  /**
+   * Checks to see if the given path exists in the filesystem, and is a socket.
+   *
+   * @param {string} path Path to check.
+   * @returns {boolean} The answer.
+   */
+  static async socketExists(path) {
+    const stats = await this.#statOrNull(path);
+
+    return stats && stats.isSocket();
+  }
+
+  /**
+   * Gets the `fs.Stats` of the path if it exists, or returns `null` if the
+   * path does not exist in the filesystem.
+   *
+   * @param {string} path Path to check.
+   * @returns {?fs.Stats} The stats, if the path exists, or `null` if not.
+   */
+  static async #statOrNull(path) {
+    MustBe.string(path);
+
+    try {
+      return await fs.stat(path);
+    } catch (e) {
+      if (e.code === 'ENOENT') {
+        // Not found. Not a real error in this case.
+        return null;
+      }
+      throw e;
+    }
+  }
+}

src/fs-util/index.js

@@ -0,0 +1,4 @@
+// Copyright 2022-2023 the Lactoserv Authors (Dan Bornstein et alia).
+// SPDX-License-Identifier: Apache-2.0
+
+export * from '#x/FsUtil';

src/fs-util/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@this/fs-util",
+  "version": "0.0.1",
+  "type": "module",
+  "private": true,
+  "license": "Apache-2.0",
+
+  "exports": "./index.js",
+  "imports": {
+    "#x/*": "./export/*.js",
+    "#p/*": "./private/*.js"
+  },
+
+  "dependencies": {
+    "@this/typey": "*"
+  }
+}

src/main-lactoserv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@this/main-lactoserv",
-  "version": "0.5.12",
+  "version": "0.5.13",
   "type": "module",
   "private": true,
   "license": "Apache-2.0",