Clean up logging and code importing

Author: i-a-n

binaries/helper-code/logger.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const SORT_ME_LAST_UNICODE = "\uFFFF";
 /*
  * Since the config and server startup functions are a big mix of sync/async, the logging often
  * gets weird, so this helper class will store the logs during execution, then flush them to
@@ -19,16 +20,34 @@ class Logger {
         const seq = this.sequence++;
         this.logs.push({ sequence: seq, ...logEntry });
     }
+    // we only want to print some things during startup (not during lint)
+    printDuringStartup(entry) {
+        // CHILD_PROCESS is only true during startup
+        if (process.env.CHILD_PROCESS) {
+            console.log(entry);
+        }
+    }
     flushLogs() {
         this.logs
             .sort((a, b) => {
             var _a, _b, _c, _d;
-            // First, sort by domain
-            if (((_a = a.domain) !== null && _a !== void 0 ? _a : "\uFFFF") < ((_b = b.domain) !== null && _b !== void 0 ? _b : "\uFFFF"))
+            /*
+             * Sorting the logs can be a bit tricky. We want to sort all the log messages by the domain
+             * name that threw the log.. but many logs are thrown without a specific domain name
+             * attached. We can sort those too of course, but we always want them to come at the very
+             * end of the logs, because in practice it makes way more sense to read them this way.
+             * So the best way I found to do that, maybe it's hacky, but if a domain isn't there we
+             * sort that log as if it were the very last unicode character, so no domain name could
+             * ever come after it. Yes, we could probably do an extra if statement and just return
+             * `1`, but this felt like the most intuitive way to implement and talk about this concept.
+             */
+            if (((_a = a.domain) !== null && _a !== void 0 ? _a : SORT_ME_LAST_UNICODE) <
+                ((_b = b.domain) !== null && _b !== void 0 ? _b : SORT_ME_LAST_UNICODE))
                 return -1;
-            if (((_c = a.domain) !== null && _c !== void 0 ? _c : "\uFFFF") > ((_d = b.domain) !== null && _d !== void 0 ? _d : "\uFFFF"))
+            if (((_c = a.domain) !== null && _c !== void 0 ? _c : SORT_ME_LAST_UNICODE) >
+                ((_d = b.domain) !== null && _d !== void 0 ? _d : SORT_ME_LAST_UNICODE))
                 return 1;
-            // If domains are equal or non existent, compare by sequence
+            // If domains are equal (or both non existent), compare by sequence
             return a.sequence - b.sequence;
         })
             .forEach((log) => {

binaries/helper-code/utilities.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidDomain = exports.isDirectoryOrSymlinkDirectory = exports.formatElapsedTime = void 0;
-const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 // Helper function to format milliseconds into human-readable format
 const formatElapsedTime = (ms) => {
     const seconds = Math.floor(ms / 1000);

binaries/server/configure.js

@@ -33,10 +33,10 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const serve_static_1 = __importDefault(require("serve-static"));
 const vhost_1 = __importDefault(require("vhost"));
-const utilities_1 = require("../helper-code/utilities");
+const logger_1 = __importDefault(require("../helper-code/logger"));
 const tree_traversal_1 = require("../helper-code/tree-traversal");
+const utilities_1 = require("../helper-code/utilities");
 const _404_1 = __importDefault(require("../html/404"));
-const logger_1 = __importDefault(require("../helper-code/logger"));
 // Synchronous function to check for the existence of a direct-child 'html' directory
 const containsHtmlDirectory = (pathToDirectory) => {
     try {
@@ -103,6 +103,7 @@ const configureHttpServer = async () => {
         if (containsHtmlDirectory(pathToDomain)) {
             pathToDomain = path_1.default.join(pathToDomain, "html");
         }
+        logger_1.default.printDuringStartup(`found domain ${match.toUpperCase()} - serving from ${pathToDomain}`);
         logger_1.default.log({
             locationInCode: "configureHttpServer",
             domain: match,

binaries/server/ssl.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const vhttps_1 = __importDefault(require("vhttps"));
-const tree_traversal_1 = require("../helper-code/tree-traversal");
 const logger_1 = __importDefault(require("../helper-code/logger"));
+const tree_traversal_1 = require("../helper-code/tree-traversal");
 const getCertificateFiles = (match) => {
     const basePath = path_1.default.join(process.cwd(), `./certificates/${match}`);
     let cert;
@@ -33,6 +33,7 @@ const configureSSL = (app) => {
     // Loop through directories in `./certificates`, looking for domain names
     const matches = (0, tree_traversal_1.findDomainSubdirectories)("./certificates");
     matches.forEach((match) => {
+        logger_1.default.printDuringStartup(`retrieving certificate files for ${match.toUpperCase()}`);
         certificates.push({
             hostname: match,
             ...getCertificateFiles(match),

binaries/union.js

@@ -6,12 +6,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_HTTPS_PORT = exports.DEFAULT_HTTP_PORT = void 0;
 const pm2_1 = __importDefault(require("pm2"));
-const ssl_1 = __importDefault(require("./server/ssl"));
 const configure_1 = __importDefault(require("./server/configure"));
+const ssl_1 = __importDefault(require("./server/ssl"));
 const lint_1 = __importDefault(require("./commands/lint"));
+const logger_1 = __importDefault(require("./helper-code/logger"));
+const help_1 = __importDefault(require("./commands/help"));
 const status_1 = __importDefault(require("./commands/status"));
 const stop_1 = __importDefault(require("./commands/stop"));
-const help_1 = __importDefault(require("./commands/help"));
 exports.DEFAULT_HTTP_PORT = 80;
 exports.DEFAULT_HTTPS_PORT = 443;
 // Check if it's the child process
@@ -48,8 +49,8 @@ switch (args[0]) {
                 const httpPort = args[1] || exports.DEFAULT_HTTP_PORT;
                 const httpsApp = (0, ssl_1.default)(httpApp);
                 const httpsPort = args[2] || exports.DEFAULT_HTTPS_PORT;
-                httpApp.listen(httpPort);
-                httpsApp.listen(httpsPort);
+                httpApp.listen(httpPort, () => logger_1.default.printDuringStartup(`union server (http) is running on port ${httpPort}`));
+                httpsApp.listen(httpsPort, () => logger_1.default.printDuringStartup(`union server (https) is running on port ${httpsPort}`));
             })
                 .catch((error) => console.error("error configuring app: ", error));
         }

source/helper-code/logger.ts

@@ -42,6 +42,14 @@ class Logger {
     this.logs.push({ sequence: seq, ...logEntry });
   }
 
+  // we only want to print some things during startup (not during lint)
+  printDuringStartup(entry: any) {
+    // CHILD_PROCESS is only true during startup
+    if (process.env.CHILD_PROCESS) {
+      console.log(entry);
+    }
+  }
+
   flushLogs() {
     this.logs
       .sort((a, b) => {

source/helper-code/utilities.ts

@@ -1,5 +1,5 @@
-import path from "path";
 import fs from "fs";
+import path from "path";
 
 // Helper function to format milliseconds into human-readable format
 export const formatElapsedTime = (ms: number) => {

source/server/configure.ts

@@ -6,14 +6,14 @@ import path from "path";
 import serveStatic from "serve-static";
 import vhost from "vhost";
 
-import { isDirectoryOrSymlinkDirectory } from "../helper-code/utilities";
+import logger from "../helper-code/logger";
 import {
   findDomainSubdirectories,
   findFilesRecursive,
   findSingleFile,
 } from "../helper-code/tree-traversal";
+import { isDirectoryOrSymlinkDirectory } from "../helper-code/utilities";
 import errorPageHTML from "../html/404";
-import logger from "../helper-code/logger";
 
 // Synchronous function to check for the existence of a direct-child 'html' directory
 const containsHtmlDirectory = (pathToDirectory: string): boolean => {
@@ -95,6 +95,10 @@ const configureHttpServer = async (): Promise<express.Express> => {
         pathToDomain = path.join(pathToDomain, "html");
       }
 
+      logger.printDuringStartup(
+        `found domain ${match.toUpperCase()} - serving from ${pathToDomain}`
+      );
+
       logger.log({
         locationInCode: "configureHttpServer",
         domain: match,

source/server/ssl.ts

@@ -3,8 +3,8 @@ import path from "path";
 import vhttps, { Credential } from "vhttps";
 import { Express as ExpressType } from "express";
 
-import { findDomainSubdirectories } from "../helper-code/tree-traversal";
 import logger from "../helper-code/logger";
+import { findDomainSubdirectories } from "../helper-code/tree-traversal";
 
 const getCertificateFiles = (
   match: string
@@ -36,6 +36,9 @@ const configureSSL = (app: ExpressType) => {
   // Loop through directories in `./certificates`, looking for domain names
   const matches = findDomainSubdirectories("./certificates");
   matches.forEach((match) => {
+    logger.printDuringStartup(
+      `retrieving certificate files for ${match.toUpperCase()}`
+    );
     certificates.push({
       hostname: match,
       ...getCertificateFiles(match),

source/union.ts

@@ -2,12 +2,13 @@
 
 import pm2 from "pm2";
 
-import configureSSL from "./server/ssl";
 import configureHttpServer from "./server/configure";
+import configureSSL from "./server/ssl";
 import lint from "./commands/lint";
+import logger from "./helper-code/logger";
+import showHelp from "./commands/help";
 import showStatus from "./commands/status";
 import stopAllProcesses from "./commands/stop";
-import showHelp from "./commands/help";
 
 export const DEFAULT_HTTP_PORT = 80;
 export const DEFAULT_HTTPS_PORT = 443;
@@ -50,8 +51,16 @@ switch (args[0]) {
           const httpsApp = configureSSL(httpApp);
           const httpsPort = args[2] || DEFAULT_HTTPS_PORT;
 
-          httpApp.listen(httpPort);
-          httpsApp.listen(httpsPort);
+          httpApp.listen(httpPort, () =>
+            logger.printDuringStartup(
+              `union server (http) is running on port ${httpPort}`
+            )
+          );
+          httpsApp.listen(httpsPort, () =>
+            logger.printDuringStartup(
+              `union server (https) is running on port ${httpsPort}`
+            )
+          );
         })
         .catch((error) => console.error("error configuring app: ", error));
     } else {