@cley_faye/boilerplate 3.18.0 → 3.20.0

package/README.md

@@ -443,6 +443,7 @@ appStart({
   port: 3000,
   shutdownFunction: () => {;},
   logger: consoleLogger,
+  noReady: false,
 }).then(({port, server}) => {;});
 ```
 
@@ -453,8 +454,14 @@ The settings are:
 - port: port to listen to. Can be 0 to use a random available port
 - shutdownFunction: a function to call after the server stop listening
 - logger: a winston logger to log that the server started listening
+- noReady: if true, does not call `process.send("ready");` (used by PM2)
 
-The function returns a promise that resolve with the actual port used for listening when the server is started.
+The shutdown function can return a promise, and if it returns/resolve with `true` the process is
+left alive.
+Otherwise `process.exit()` is called after `shutdownFunction()` resolves/returns.
+
+The `appStart()` function returns a promise that resolve with the actual port used for listening
+when the server is started.
 
 The server is automatically registered using the `autoclose` part to stop when a SIGINT signal is
 received.

package/lib/bin/serve_spa.js

@@ -53,16 +53,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = __importStar(require("node:path"));
+const node_fs_1 = require("node:fs");
 const express_1 = __importDefault(require("express"));
 const minimist_1 = __importDefault(require("minimist"));
 const singlepageapp_js_1 = require("../express/middlewares/singlepageapp.js");
 const express_js_1 = require("../express.js");
 const winston_js_1 = require("../winston.js");
 const ARGV_START_OFFSET = 2;
-const { port, root, index, help, static: staticDirs } = (0, minimist_1.default)(process.argv.slice(ARGV_START_OFFSET));
+const { port, root, index, help, staticlist, static: staticDirs } = (0, minimist_1.default)(process.argv.slice(ARGV_START_OFFSET));
 const DEFAULT_PORT = 3000;
 const DEFAULT_PATH = path.join("dist", "webapp");
 const DEFAULT_INDEX = "index.html";
+const DEFAULT_STATICFILE = "spa_static.config";
 const DEFAULT_STATIC = ["js", "css", "img"];
 if (help) {
     winston_js_1.consoleLogger.info(`
@@ -72,20 +74,34 @@ serve_spa \\
   [--port=${DEFAULT_PORT}] \\
   [--root=${DEFAULT_PATH}] \\
   [--index=${DEFAULT_INDEX}] \\
+  [--staticlist=${DEFAULT_STATICFILE}] \\
   [--static=js…] \\
   [--help]
 
 The --static argument can be repeated to add more directories to it.
 It defaults to ${JSON.stringify(DEFAULT_STATIC)}.
+
+The staticfile value is a text file with one static directory line.
+If present, they are merged with the CLI arguments.
 `.trim());
     // eslint-disable-next-line no-process-exit
     process.exit(0);
 }
 const getPort = () => port ?? DEFAULT_PORT;
 const getStatic = () => {
-    if (!staticDirs)
-        return;
-    return Array.isArray(staticDirs) ? staticDirs : [staticDirs];
+    const result = [];
+    if (staticDirs)
+        result.push(...(Array.isArray(staticDirs) ? staticDirs : [staticDirs]));
+    if (staticlist) {
+        for (const staticsrc of (Array.isArray(staticlist) ? staticlist : [staticlist])) {
+            if (!(0, node_fs_1.existsSync)(staticsrc))
+                continue;
+            result.push(...(0, node_fs_1.readFileSync)(staticsrc, "utf8")
+                .split("\n")
+                .filter(c => c));
+        }
+    }
+    return result.length > 0 ? result : undefined;
 };
 const app = (0, express_1.default)();
 app.use((0, express_js_1.createPipeline)({

package/lib/express.d.ts

@@ -104,6 +104,15 @@ export declare const createPipeline: (settings: PipelineSettings, debugLog?: Log
  * Configure the views rendering engine for an ExpressJS App
  */
 export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number>) => void;
+/**
+ * Function to call when the server stops.
+ *
+ * This is usually triggered by a SIGTERM.
+ *
+ * If the function returns "true", it prevent the process from stopping.
+ * Otherwise `process.exit()` is called.
+ */
+type ShutdownFunction = () => Promise<boolean> | boolean | undefined;
 export interface StartDefinition {
     app: express.Application;
     /** @deprecated use listenInterface instead */
@@ -117,8 +126,9 @@ export interface StartDefinition {
      */
     listenInterface?: boolean | string;
     port?: number;
-    shutdownFunction?: () => void;
+    shutdownFunction?: ShutdownFunction;
     logger?: winston.Logger;
+    noReady?: boolean;
 }
 export interface StartResult {
     port: number;
@@ -144,4 +154,5 @@ export interface StartResult {
  *
  * @property server
  */
-export declare const appStart: ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }: StartDefinition) => Promise<StartResult>;
+export declare const appStart: ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, noReady, }: StartDefinition) => Promise<StartResult>;
+export {};

package/lib/express.js

@@ -149,6 +149,19 @@ const setViewEngine = (app, viewEngine, viewsDirectory, extraLocals) => {
     }
 };
 exports.setViewEngine = setViewEngine;
+const handleShutdown = (logger, shutdownFunction) => () => {
+    const fn = async () => {
+        const noExit = shutdownFunction ? Boolean(await shutdownFunction()) : false;
+        if (noExit)
+            return;
+        // We *want* to exit on server shutdown
+        // eslint-disable-next-line no-process-exit
+        process.exit();
+    };
+    fn().catch(err => {
+        logger?.error(err);
+    });
+};
 /** Start the server and register signal for automatic closing.
  *
  * @param app
@@ -169,7 +182,7 @@ exports.setViewEngine = setViewEngine;
  *
  * @property server
  */
-const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }) => new Promise(resolve => {
+const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, noReady, }) => new Promise(resolve => {
     let server = null;
     const readyCallback = () => {
         if (server === null) {
@@ -185,11 +198,13 @@ const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction,
             port: effectivePort,
             server,
         });
+        if (!noReady && process.send)
+            process.send("ready");
     };
     if (allowNonLocal !== undefined && listenInterface !== undefined) {
         throw new Error("You can't specify both allowNonLocal and listenInterface at the same time");
     }
-    if (allowNonLocal || listenInterface === true) {
+    if (allowNonLocal ?? listenInterface === true) {
         server = app.listen(port ?? 0, readyCallback);
     }
     else if (typeof listenInterface === "string") {
@@ -198,8 +213,6 @@ const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction,
     else {
         server = app.listen(port ?? 0, "localhost", readyCallback);
     }
-    if (shutdownFunction) {
-        server.on("close", shutdownFunction);
-    }
+    server.on("close", handleShutdown(logger, shutdownFunction));
 });
 exports.appStart = appStart;

package/lib/grunt/args.js

@@ -37,7 +37,7 @@ var OptType;
     OptType["NUMBER"] = "number";
     // eslint-disable-next-line @typescript-eslint/naming-convention
     OptType["BOOLEAN"] = "boolean";
-})(OptType = exports.OptType || (exports.OptType = {}));
+})(OptType || (exports.OptType = OptType = {}));
 /**
  * Process a string-type argument
  */

package/lib/grunt/reactapp.js

@@ -47,7 +47,7 @@ var HandlerType;
     HandlerType["SASS"] = "sass";
     // eslint-disable-next-line @typescript-eslint/naming-convention
     HandlerType["COPY"] = "copy";
-})(HandlerType = exports.HandlerType || (exports.HandlerType = {}));
+})(HandlerType || (exports.HandlerType = HandlerType = {}));
 const gatherTasks = (handlers, gruntConfig, targetName, options) => Object.keys(handlers)
     .reduce((acc, cur) => acc.concat((options?.[cur] && options[cur]?.disabled)
     ? []

package/lib/winston.js

@@ -69,7 +69,7 @@ exports.filterStacktrace = filterStacktrace;
  * Prefix all lines with the level and the timestamp if needed
  */
 const prefixOutput = (level, message, timestamp) => {
-    const timestampPrefix = timestamp
+    const timestampPrefix = (timestamp ?? (level.toLowerCase() === "error"))
         ? `${new Date().toISOString()} `
         : "";
     const levelPrefix = `${level.toString().padStart(LOG_LEVEL_PADDING_SIZE)}: `;
@@ -119,12 +119,7 @@ const addAxiosContent = (error) => {
                 res.push(JSON.stringify(error.response.data));
             }
             catch {
-                try {
-                    res.push(error.response.data.toString());
-                }
-                catch {
-                    res.push("<cannot output body>");
-                }
+                res.push("<cannot output body>");
             }
         }
     }
@@ -145,7 +140,7 @@ const getCause = (error) => {
     if (cause instanceof Error)
         return cause;
     try {
-        return new Error(cause.toString());
+        return new Error(JSON.stringify(cause));
     }
     catch {
         return new Error("Unknown cause");
@@ -205,15 +200,10 @@ const getErrorFromTransformable = (info) => {
     }
 };
 const customFormat = (timestamp, collapseStacktrace, stacktraceFilter) => winston_1.default.format.printf((info) => {
-    const effectiveTimestamp = timestamp === undefined
-        ? logConfig.timestamp
-        : timestamp;
-    const effectiveCollapse = collapseStacktrace === undefined
-        ? logConfig.collapseNodeModules || logConfig.collapseStacktrace
-        : collapseStacktrace;
-    const effectiveStacktraceFilter = stacktraceFilter === undefined
-        ? logConfig.stacktraceFilter
-        : stacktraceFilter;
+    const effectiveTimestamp = timestamp ?? logConfig.timestamp;
+    const effectiveCollapse = collapseStacktrace
+        ?? (logConfig.collapseNodeModules || logConfig.collapseStacktrace);
+    const effectiveStacktraceFilter = stacktraceFilter ?? logConfig.stacktraceFilter;
     const error = getErrorFromTransformable(info);
     const message = error
         ? (0, exports.filterError)(error, effectiveCollapse, effectiveStacktraceFilter)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.18.0",
+  "version": "3.20.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -21,19 +21,19 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.9.3",
-    "@types/express": "^4.17.17",
-    "@types/grunt": "^0.4.27",
-    "@types/http-errors": "^2.0.1",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^18.15.7",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
-    "eslint": "^8.36.0",
-    "eslint-plugin-deprecation": "^1.3.3",
-    "eslint-plugin-import": "^2.27.5",
+    "@keeex/eslint-config": "^1.11.5",
+    "@types/express": "^4.17.18",
+    "@types/grunt": "^0.4.28",
+    "@types/http-errors": "^2.0.2",
+    "@types/minimist": "^1.2.3",
+    "@types/node": "^18.18.3",
+    "@typescript-eslint/eslint-plugin": "^6.7.4",
+    "@typescript-eslint/parser": "^6.7.4",
+    "eslint": "^8.50.0",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-webpack-plugin": "^4.0.0",
+    "eslint-webpack-plugin": "^4.0.1",
     "express-winston": "^4.2.0",
     "grunt": "^1.6.1",
     "grunt-banner": "^0.6.0",
@@ -41,9 +41,9 @@
     "grunt-run": "^0.8.1",
     "load-grunt-tasks": "^5.1.0",
     "logform": "^2.5.1",
-    "typescript": "^4.9.5",
-    "webpack": "^5.76.3",
-    "winston": "^3.8.2"
+    "typescript": "^5.2.2",
+    "webpack": "^5.88.2",
+    "winston": "^3.10.0"
   },
   "peerDependencies": {
     "@babel/core": "7.x",