analogger 2.2.1 → 2.3.0

package/README.md

@@ -302,6 +302,7 @@ Display the browser native message box if run from it; otherwise, it displays th
 | logMaxArchives        | 3           | number                            | _Maximum number of log files to use_                                               |
 | requiredLogLevel      | "LOG"       | "LOG" / "INFO" / "WARN" / "ERROR" | _Define the log level from which the system can show a log entry_                  |
 | enableDate            | false       | boolean                           | _Show date + time (instead of time only)_                                          |
+| enableMillisec       | false       | boolean                           | _Show milliseconds in the log time (e.g., 12:22:04,555)_                          |
 | logToLocalStorage     | false       | 	boolean                          | _Persist logs in browser localStorage_                                             |
 | logToLocalStorageMax	 | 50	         | number                            | _Max entries to keep in localStorage_                                             |
 | logToLocalStorageSize	 | 10000	     | number                            | _Max size in bytes for localStorage logs_                                         |

package/ana-logger.d.cts

@@ -54,6 +54,8 @@ declare class ____AnaLogger {
     options: {
         hideHookMessage: boolean;
     };
+    remoteBuffer: any[];
+    remoteTimer: any;
     originalFormatFunction: string;
     forceLidOn: boolean;
     resolveLineCall: boolean;
@@ -114,10 +116,8 @@ declare class ____AnaLogger {
      */
     isBrowser(): boolean;
     resetLogger(): void;
-    remoteBuffer: any[];
-    remoteTimer: NodeJS.Timeout;
     resetOptions(): void;
-    setOptions({ contextLenMax, idLenMax, lidLenMax, symbolLenMax, enableTrace, messageLenMax, hideLog, hideError, hideHookMessage, hidePassingTests, logToDom, logToFile, logMaxSize, logMaxArchives, logIndexArchive, addArchiveTimestamp, addArchiveIndex, compressArchives, compressionLevel, logToRemote, logToRemoteUrl, logToRemoteBinaryUrl, loopback, requiredLogLevel, oneConsolePerContext, silent, enableDate, logToLocalStorage, logToLocalStorageMax, logToLocalStorageSize, logToRemoteMaxEntries, logToRemoteDebounce, protocol, host, port, pathname, binarypathname, loadHtmlToImage }?: any): void;
+    setOptions({ timeLenMax, contextLenMax, idLenMax, lidLenMax, symbolLenMax, enableTrace, messageLenMax, hideLog, hideError, hideHookMessage, hidePassingTests, logToDom, logToFile, logMaxSize, logMaxArchives, logIndexArchive, addArchiveTimestamp, addArchiveIndex, compressArchives, compressionLevel, logToRemote, logToRemoteUrl, logToRemoteBinaryUrl, loopback, requiredLogLevel, oneConsolePerContext, silent, enableDate, enableMillisec, logToLocalStorage, logToLocalStorageMax, logToLocalStorageSize, logToRemoteMaxEntries, logToRemoteDebounce, logToRemoteMaxSize, logToRemoteMinSize, protocol, host, port, pathname, binarypathname, loadHtmlToImage }?: any): void;
     EOL: string;
     updateOptions(options: any): void;
     getOptions(): {
@@ -131,19 +131,10 @@ declare class ____AnaLogger {
     /**
      * Format inputs
      * @see Override {@link setLogFormat}
-     * @param contextName
-     * @param id
-     * @param message
-     * @param lid
-     * @param symbol
      * @returns {string}
+     * @param localContext
      */
-    onBuildLog({ contextName, message, lid, symbol }?: {
-        contextName: any;
-        message?: string;
-        lid?: string;
-        symbol?: string;
-    }): string;
+    onBuildLog(localContext?: {}): string;
     onErrorForUserTarget(context: any, ...args: any[]): void;
     onError(context: any, ...args: any[]): void;
     /**

package/browser/ana-logger.mjs

@@ -642,6 +642,9 @@ class ____AnaLogger
         hideHookMessage: false
     };
 
+    remoteBuffer = [];
+    remoteTimer = null;
+
     static Console = null;
 
     #overridenMap = {
@@ -691,6 +694,9 @@ class ____AnaLogger
         this.errorTargetHandler = this.onError.bind(this);
         this.errorUserTargetHandler = this.onErrorForUserTarget.bind(this);
 
+        this.remoteBuffer = [];
+        this.remoteTimer = null;
+
         this.setOptions(this.options);
 
         if (!____AnaLogger.Console) {
@@ -899,7 +905,7 @@ class ____AnaLogger
     resetLogger()
     {
         this.options = {};
-        this.options.timeLenMax = 12;
+        this.options.timeLenMax = 8;
         this.options.contextLenMax = 10;
         this.options.idLenMax = 5;
         this.options.lidLenMax = 6;
@@ -928,11 +934,14 @@ class ____AnaLogger
         this.options.pathname = undefined;
         this.options.binarypathname = undefined;
         this.options.enableDate = undefined;
+        this.options.enableMillisec = undefined;
         this.options.logToLocalStorage = undefined;
         this.options.logToLocalStorageMax = 50;
         this.options.logToLocalStorageSize = 10000;
         this.options.logToRemoteMaxEntries = undefined;
         this.options.logToRemoteDebounce = undefined;
+        this.options.logToRemoteMaxSize = undefined;
+        this.options.logToRemoteMinSize = undefined;
         this.remoteBuffer = [];
         this.remoteTimer = null;
     }
@@ -943,6 +952,7 @@ class ____AnaLogger
     }
 
     setOptions({
+                   timeLenMax = undefined,
                    contextLenMax = 10,
                    idLenMax = 5,
                    lidLenMax = 6,
@@ -970,11 +980,14 @@ class ____AnaLogger
                    oneConsolePerContext = undefined,
                    silent = undefined,
                    enableDate = undefined,
+                   enableMillisec = undefined,
                    logToLocalStorage = undefined,
                    logToLocalStorageMax = 50,
                    logToLocalStorageSize = 10000,
                    logToRemoteMaxEntries = undefined,
                    logToRemoteDebounce = undefined,
+                   logToRemoteMaxSize = undefined,
+                   logToRemoteMinSize = undefined,
                    /** Remote - all optional **/
                    protocol = undefined,
                    host = undefined,
@@ -990,6 +1003,9 @@ class ____AnaLogger
         this.options.messageLenMax = messageLenMax;
         this.options.symbolLenMax = symbolLenMax;
 
+        this.options.enableMillisec = enableMillisec;
+        this.options.timeLenMax = timeLenMax;
+
         this.options.logMaxSize = logMaxSize;
         this.options.logMaxArchives = logMaxArchives;
         this.options.logIndexArchive = logIndexArchive;
@@ -1001,10 +1017,23 @@ class ____AnaLogger
         this.options.requiredLogLevel = requiredLogLevel;
         this.options.enableTrace = enableTrace;
 
+        this.options.enableMillisec = enableMillisec;
+        if (this.options.enableMillisec)
+        {
+            this.options.timeLenMax += 4;
+        }
+
         this.options.logToLocalStorageMax = logToLocalStorageMax;
         this.options.logToLocalStorageSize = logToLocalStorageSize;
+
+        // Remote logging options
+        this.options.logToRemote = logToRemote;
+        this.options.logToRemoteUrl = logToRemoteUrl;
+        this.options.logToRemoteBinaryUrl = logToRemoteBinaryUrl;
         this.options.logToRemoteMaxEntries = logToRemoteMaxEntries;
         this.options.logToRemoteDebounce = logToRemoteDebounce;
+        this.options.logToRemoteMaxSize = logToRemoteMaxSize;
+        this.options.logToRemoteMinSize = logToRemoteMinSize;
 
         if (loadHtmlToImage) {
             const code = getHtmlToImage();
@@ -1062,6 +1091,19 @@ class ____AnaLogger
             }
         });
 
+        if (this.options.enableDate && this.options.timeLenMax === undefined) {
+            this.options.timeLenMax = 17;
+        }
+
+        if (this.options.timeLenMax === undefined) {
+            if (this.options.enableDate) {
+                this.options.timeLenMax = 17;
+            }
+            else {
+                this.options.timeLenMax = 8;
+            }
+        }
+
         if (this.options.logToRemote && !this.options.logToRemoteUrl)
         {
             this.options.logToRemoteUrl = this.convertToUrl({
@@ -1135,17 +1177,14 @@ class ____AnaLogger
     /**
      * Format inputs
      * @see Override {@link setLogFormat}
-     * @param contextName
-     * @param id
-     * @param message
-     * @param lid
-     * @param symbol
      * @returns {string}
+     * @param localContext
      */
-    onBuildLog({contextName, message = "", lid = "", symbol = ""} = {})
+    onBuildLog(localContext = {})
     {
         try
         {
+            let {contextName, message = "", lid = "", symbol = ""} = localContext;
             let strResult = "";
 
             const strs = message.split(/\n/g);
@@ -1158,14 +1197,22 @@ class ____AnaLogger
                 const now = new Date();
                 let time = ("0" + now.getHours()).slice(-2) + ":" + ("0" + now.getMinutes()).slice(-2) + ":" + ("0" + now.getSeconds()).slice(-2);
 
-                if (this.options.enableDate)
+                const enableMillisec = localContext.hasOwnProperty("enableMillisec") ? localContext.enableMillisec : this.options.enableMillisec;
+                if (enableMillisec)
+                {
+                    time += "," + ("00" + now.getMilliseconds()).slice(-3);
+                }
+
+                const enableDate = localContext.hasOwnProperty("enableDate") ? localContext.enableDate : this.options.enableDate;
+                if (enableDate)
                 {
                     let date = now.getFullYear().toString().slice(-2) + "-" + (now.getMonth() + 1).toString().padStart(2, "0") + "-" + now.getDate().toString().padStart(2, "0");
                     time = date + " " + time;
                 }
 
                 // Display content in columns
-                time = this.truncateMessage(time, {fit: this.options.timeLenMax});
+                const timeLenMax = localContext.hasOwnProperty("timeLenMax") ? localContext.timeLenMax : this.options.timeLenMax;
+                time = this.truncateMessage(time, {fit: timeLenMax});
 
                 if (i > 0)
                 {
@@ -1178,7 +1225,8 @@ class ____AnaLogger
                 });
                 lid = this.truncateMessage(lid, {fit: this.options.lidLenMax});
 
-                if (this.options.messageLenMax !== undefined)
+                const messageLenMax = localContext.hasOwnProperty("messageLenMax") ? localContext.messageLenMax : this.options.messageLenMax;
+                if (messageLenMax !== undefined)
                 {
                     message0 = this.truncateMessage(message0, {fit: this.options.messageLenMax});
                 }
@@ -2000,18 +2048,31 @@ class ____AnaLogger
     {
         try
         {
-            if (this.options.logToRemoteMaxEntries === undefined && this.options.logToRemoteDebounce === undefined)
+            if (this.options.logToRemoteMaxEntries === undefined && this.options.logToRemoteDebounce === undefined && this.options.logToRemoteMaxSize === undefined)
             {
                 this.performRemotePost([...data]);
                 return;
             }
 
-            this.remoteBuffer.push([...data]);
-
-            if (this.options.logToRemoteMaxEntries !== undefined && this.remoteBuffer.length >= this.options.logToRemoteMaxEntries)
+            if (Array.isArray(this.remoteBuffer))
             {
-                this.flushRemoteLogs();
-                return;
+                this.remoteBuffer.push([...data]);
+
+                if (this.options.logToRemoteMaxEntries !== undefined && this.remoteBuffer.length >= this.options.logToRemoteMaxEntries)
+                {
+                    this.flushRemoteLogs();
+                    return;
+                }
+
+                if (this.options.logToRemoteMaxSize !== undefined)
+                {
+                    const currentSize = JSON.stringify(this.remoteBuffer).length;
+                    if (currentSize >= this.options.logToRemoteMaxSize)
+                    {
+                        this.flushRemoteLogs();
+                        return;
+                    }
+                }
             }
 
             if (this.options.logToRemoteDebounce !== undefined && !this.remoteTimer)
@@ -2031,15 +2092,32 @@ class ____AnaLogger
 
     flushRemoteLogs()
     {
-        if (this.remoteTimer)
+        if (this.remoteBuffer.length === 0)
         {
-            clearTimeout(this.remoteTimer);
-            this.remoteTimer = null;
+            return;
         }
 
-        if (this.remoteBuffer.length === 0)
+        if (this.options.logToRemoteMinSize !== undefined)
         {
-            return;
+            const currentSize = JSON.stringify(this.remoteBuffer).length;
+            if (currentSize < this.options.logToRemoteMinSize)
+            {
+                // If we haven't reached min size, and there's no timer, start one if debounce is set
+                if (this.options.logToRemoteDebounce !== undefined && !this.remoteTimer)
+                {
+                    this.remoteTimer = setTimeout(() =>
+                    {
+                        this.flushRemoteLogs();
+                    }, this.options.logToRemoteDebounce);
+                }
+                return;
+            }
+        }
+
+        if (this.remoteTimer)
+        {
+            clearTimeout(this.remoteTimer);
+            this.remoteTimer = null;
         }
 
         const dataToFlush = [...this.remoteBuffer];