socket-function 0.28.0 → 0.30.0

package/SocketFunction.ts

@@ -279,6 +279,9 @@ export class SocketFunction {
      *      to add additional imports to ensure the register call runs.
      */
     public static expose(socketRegistered: SocketRegistered) {
+        if (!socketRegistered._classGuid) {
+            throw new Error("SocketFunction.expose must be called with a classGuid");
+        }
         console.log(`Exposing Controller ${blue(socketRegistered._classGuid)}`);
         exposeClass(socketRegistered);
         this.exposedClasses.add(socketRegistered._classGuid);

package/hot/HotReloadController.ts

@@ -8,6 +8,7 @@ import * as fs from "fs";
 import debugbreak from "debugbreak";
 import { isNode } from "../src/misc";
 import { magenta, red } from "../src/formatting/logColors";
+import { formatTime } from "../src/formatting/format";
 
 /** Enables some hot reload functionality.
  *      - Triggers a refresh clientside
@@ -136,7 +137,7 @@ class HotReloadControllerBase {
         clientWatcherNodes.add(callerId);
     }
     async fileUpdated(files: string[], changeTime: number) {
-        console.groupCollapsed(magenta(`Trigger hotreload for files (${Date.now() - changeTime}ms after file change)`));
+        console.groupCollapsed(magenta(`Trigger hotreload for files ${formatTime(Date.now() - changeTime)} after file change`));
         for (let file of files) {
             console.log(file);
         }
@@ -171,7 +172,7 @@ class HotReloadControllerBase {
         for (let callback of hotReloadCallbacks) {
             callback(modules);
         }
-        console.log(magenta(`Hot reload complete (${Date.now() - changeTime}ms after file change)`));
+        console.log(magenta(`Hot reload complete ${formatTime(Date.now() - changeTime)} after file change`));
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "socket-function",
-	"version": "0.28.0",
+	"version": "0.30.0",
 	"main": "index.js",
 	"license": "MIT",
 	"note1": "note on node-forge fork, see https://github.com/digitalbazaar/forge/issues/744 for details",

package/src/formatting/format.ts

@@ -230,6 +230,34 @@ export function formatDateTime(time: number) {
     return date.getFullYear() + "/" + p(date.getMonth() + 1) + "/" + p(date.getDate()) + " " + strTime;
 }
 
+/** 2024 January 1, Monday, 12:53:02pm */
+export function formatNiceDateTime(time: number) {
+    function p(s: number) {
+        return s.toString().padStart(2, "0");
+    }
+    let date = new Date(time);
+    let hours = date.getHours();
+    let minutes = date.getMinutes();
+    let seconds = date.getSeconds();
+    let ampm = hours >= 12 ? "pm" : "am";
+    hours = hours % 12;
+    hours = hours ? hours : 12; // the hour '0' should be '12'
+    let strTime = p(hours) + ":" + p(minutes) + ":" + p(seconds) + ampm;
+    let days = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"];
+    return date.getFullYear() + " " + date.toLocaleString("default", { month: "long" }) + " " + date.getDate() + ", " + days[date.getDay()] + ", " + strTime;
+}
+
+/** 2024 January 1, Monday, 12:53:02pm (4 months ago)  */
+export function formatVeryNiceDateTime(time: number) {
+    if (!time) {
+        return "";
+    }
+    if (typeof time !== "number") {
+        return String(time);
+    }
+    return `${formatNiceDateTime(time)} (${formatTime(Date.now() - time)})`;
+}
+
 /** YYYY/MM/DD */
 export function formatDate(time: number) {
     function p(s: number) {

package/src/misc.ts

@@ -149,7 +149,11 @@ export function keyByArray<T, K>(arr: T[], getKey: (value: T) => K): Map<K, T[]>
 
 export function deepCloneJSON<T>(obj: T): T {
     if (obj === undefined) return obj;
-    return JSON.parse(JSON.stringify(obj));
+    let str = JSON.stringify(obj);
+    // It is possible for an object to not be defined, but return undefined when JSON.stringified,
+    //  via overriding the toJSON method.
+    if (str === undefined) return undefined as any;
+    return JSON.parse(str);
 }
 
 export class PromiseObj<T = void> {

package/src/profiling/measure.ts

@@ -30,6 +30,8 @@ const measureOverhead = 5 / 1000;
 
 const AsyncFunction = (async () => { }).constructor;
 
+const noDiskLogPrefix = "\u200C";
+
 // TIMING: 1-5us. I have seen timing values greatly vary, but it does seem to be quite high, despite
 //  microbenchmarks saying it is slow. Perhaps it is because getOwnTime breaks the cpu pipeline,
 //  which causes slowness for code around us, but not if we are running in isolation?
@@ -131,12 +133,25 @@ export interface LogMeasureTableConfig {
     mergeDepth?: number;
     // Defaults to 10
     maxTableEntries?: number;
+
+    // No logging, just returns FormattedMeasureTable
+    returnOnly?: boolean;
+}
+
+export interface FormattedMeasureTable {
+    title: string;
+    entries: {
+        name: string;
+        ownTime: number;
+        fraction: number;
+        equation: string;
+    }[];
 }
 
 export function logMeasureTable(
     profile: MeasureProfile,
     config?: LogMeasureTableConfig
-) {
+): FormattedMeasureTable | undefined {
     let { useTotalTime, name } = config || {};
     const thresholdInTable = config?.thresholdInTable ?? 0.05;
     let minTimeToLog = config?.minTimeToLog ?? 50;
@@ -149,7 +164,7 @@ export function logMeasureTable(
     entries.sort((a, b) => getTime(b).sum - getTime(a).sum);
 
     let totalTime = entries.map(x => getTime(x).sum).reduce((a, b) => a + b, 0);
-    if (totalTime < minTimeToLog) return;
+    if (totalTime < minTimeToLog) return undefined;
 
     let mergeDepth = config?.mergeDepth ?? 2;
     {
@@ -186,7 +201,7 @@ export function logMeasureTable(
     if (name) {
         title = `(${blue(name)}) ${title}`;
     }
-    console.log(title);
+    console.log(noDiskLogPrefix + title);
     function percent(value: number) {
         return `${(value * 100).toFixed(2)}%`;
     }
@@ -244,9 +259,23 @@ export function logMeasureTable(
             output += red(`    (${entry.stillOpenCount} open)`);
         }
 
-        console.log(output);
+        console.log(noDiskLogPrefix + output);
     }
     console.log();
+
+    return {
+        title,
+        entries: entries.map(entry => {
+            let time = getTime(entry);
+            let fraction = time.sum / totalTime;
+            return {
+                name: entry.name,
+                ownTime: time.sum,
+                fraction,
+                equation: formatStats(time),
+            };
+        })
+    };
 }
 
 export async function measureCode<T>(code: () => Promise<T>, config?: LogMeasureTableConfig) {