chia-agent 14.3.5 → 14.3.6-beta.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [14.3.6]
+### Fixed
+- Fixed logging issues where it crashes upon stringifying an object with circular references
+
 ## [14.3.5]
 ### Fixed
 - Fixed an issue where it exhausts heap when logging an object with circular references
@@ -1756,6 +1760,8 @@ daemon.sendMessage(destination, get_block_record_by_height_command, data);
 Initial release.
 
 <!-- [Unreleased]: https://github.com/Chia-Mine/chia-agent/compare/v0.0.1...v0.0.2 -->
+[14.3.6]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.5...v14.3.6
+[14.3.5]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.4...v14.3.5
 [14.3.4]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.3...v14.3.4
 [14.3.3]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.2...v14.3.3
 [14.3.2]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.1...v14.3.2

package/daemon/index.js

@@ -42,14 +42,14 @@ const onProcessExit = () => {
     setTimeout(() => __awaiter(void 0, void 0, void 0, function* () {
         try {
             if (daemon && daemon.connected && !daemon.closing) {
-                (0, logger_1.getLogger)().debug("Detected Ctrl+C. Initiating shutdown...");
+                (0, logger_1.getLogger)().debug(() => "Detected Ctrl+C. Initiating shutdown...");
                 yield daemon.close();
                 process.removeListener("SIGINT", onProcessExit);
                 process.kill(process.pid, "SIGINT");
             }
         }
         catch (e) {
-            process.stderr.write(JSON.stringify(e));
+            process.stderr.write((0, logger_1.stringify)(e));
             process.exit(1);
         }
     }), 67);
@@ -106,7 +106,7 @@ class Daemon {
         }
         else {
             try {
-                (0, logger_1.getLogger)().error(`Error: ${JSON.stringify(e)}`);
+                (0, logger_1.getLogger)().error(() => `Error: ${(0, logger_1.stringify)(e)}`);
             }
             catch (_e) {
                 (0, logger_1.getLogger)().error("Unknown error");
@@ -152,7 +152,7 @@ class Daemon {
             // Attempt connection with retry logic
             let lastError;
             for (let attempt = 1; attempt <= this._retryOptions.maxAttempts; attempt++) {
-                (0, logger_1.getLogger)().debug(`Opening websocket connection to ${daemonServerURL} (attempt ${attempt}/${this._retryOptions.maxAttempts})`);
+                (0, logger_1.getLogger)().debug(() => `Opening websocket connection to ${daemonServerURL} (attempt ${attempt}/${this._retryOptions.maxAttempts})`);
                 const result = yield (0, connection_1.open)(daemonServerURL, timeoutMs).catch((error) => {
                     lastError = error;
                     return null;
@@ -196,7 +196,7 @@ class Daemon {
                 // Disable reconnection for manual close
                 this._autoReconnect = false;
                 this._isReconnecting = false;
-                (0, logger_1.getLogger)().debug("Closing web socket connection");
+                (0, logger_1.getLogger)().debug(() => "Closing web socket connection");
                 this._socket.close();
                 this._closing = true;
                 this._connectedUrl = "";
@@ -227,12 +227,12 @@ class Daemon {
                     rejecter: reject,
                     timeout,
                 };
-                (0, logger_1.getLogger)().debug(`Sending Ws message. dest=${destination} command=${command} reqId=${reqId}`);
-                const messageStr = JSON.stringify(message);
+                (0, logger_1.getLogger)().debug(() => `Sending Ws message. dest=${destination} command=${command} reqId=${reqId}`);
+                const messageStr = (0, logger_1.stringify)(message);
                 this._socket.send(messageStr, (err) => {
                     if (err) {
                         (0, logger_1.getLogger)().error(`Error while sending message: ${messageStr}`);
-                        (0, logger_1.getLogger)().error(JSON.stringify(err));
+                        (0, logger_1.getLogger)().error(() => (0, logger_1.stringify)(err));
                         // Clean up on send error
                         const entry = this._responseQueue[reqId];
                         if (entry) {
@@ -282,7 +282,7 @@ class Daemon {
                 (0, logger_1.getLogger)().error("Failed to register agent service to daemon");
                 (0, logger_1.getLogger)().error(error instanceof Error
                     ? `${error.name}: ${error.message}`
-                    : JSON.stringify(error));
+                    : (0, logger_1.stringify)(error));
                 throw new Error("Subscribe failed");
             }
             this._subscriptions.push(service);
@@ -383,7 +383,7 @@ class Daemon {
             ({ request_id, origin, command } = payload);
         }
         catch (err) {
-            (0, logger_1.getLogger)().error(`Failed to parse ws message data: ${JSON.stringify(err)}`);
+            (0, logger_1.getLogger)().error(`Failed to parse ws message data: ${(0, logger_1.stringify)(err)}`);
             (0, logger_1.getLogger)().error(`ws payload: ${event.data}`);
             return;
         }
@@ -391,13 +391,13 @@ class Daemon {
         if (entry) {
             clearTimeout(entry.timeout);
             delete this._responseQueue[request_id];
-            (0, logger_1.getLogger)().debug(`Ws response received. origin=${origin} command=${command} reqId=${request_id}`);
+            (0, logger_1.getLogger)().debug(() => `Ws response received. origin=${origin} command=${command} reqId=${request_id}`);
             entry.resolver(payload);
         }
         else {
-            (0, logger_1.getLogger)().debug(`Ws message arrived. origin=${origin} command=${command} reqId=${request_id}`);
+            (0, logger_1.getLogger)().debug(() => `Ws message arrived. origin=${origin} command=${command} reqId=${request_id}`);
         }
-        (0, logger_1.getLogger)().trace(`Ws message: ${JSON.stringify(payload)}`);
+        (0, logger_1.getLogger)().trace(() => `Ws message: ${(0, logger_1.stringify)(payload)}`);
         this._messageEventListeners.forEach((l) => l(event));
         for (const o in this._messageListeners) {
             if (!Object.prototype.hasOwnProperty.call(this._messageListeners, o)) {
@@ -441,10 +441,10 @@ class Daemon {
         }
     }
     onPing() {
-        (0, logger_1.getLogger)().debug("Received ping");
+        (0, logger_1.getLogger)().debug(() => "Received ping");
     }
     onPong() {
-        (0, logger_1.getLogger)().debug("Received pong");
+        (0, logger_1.getLogger)().debug(() => "Received pong");
     }
     _attemptReconnection(previousSubscriptions) {
         if (this._reconnectAttempts >= this._retryOptions.maxAttempts) {
@@ -481,7 +481,7 @@ class Daemon {
                     for (const service of previousSubscriptions) {
                         try {
                             yield this.subscribe(service);
-                            (0, logger_1.getLogger)().debug(`Re-subscribed to ${service}`);
+                            (0, logger_1.getLogger)().debug(() => `Re-subscribed to ${service}`);
                         }
                         catch (e) {
                             (0, logger_1.getLogger)().error(`Failed to re-subscribe to ${service}: ${e}`);

package/logger.d.ts

@@ -24,6 +24,7 @@ export declare function getLogger(name?: string): Logger;
 export declare function clearLoggerCache(): void;
 export declare function createConsoleWriter(): Writer;
 export declare function createNullWriter(): Writer;
+export declare function stringify(obj: any, indent?: number): string;
 export declare class Logger {
     private _name;
     private _logLevel;
@@ -39,11 +40,11 @@ export declare class Logger {
     getFormatter(): LogFormatter;
     private _shouldWrite;
     private _formatMessage;
-    trace(msg: any): void;
-    debug(msg: any): void;
-    info(msg: any): void;
-    warning(msg: any): void;
-    error(msg: any): void;
+    trace(msg: any | (() => any)): void;
+    debug(msg: any | (() => any)): void;
+    info(msg: any | (() => any)): void;
+    warning(msg: any | (() => any)): void;
+    error(msg: any | (() => any)): void;
 }
 export declare function getLogLevel(): TLogLevel;
 export declare function setLogLevel(level: TLogLevel): void;

package/logger.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLogLevel = exports.getLogLevel = exports.Logger = exports.createNullWriter = exports.createConsoleWriter = exports.clearLoggerCache = exports.getLogger = exports.jsonLogFormatter = exports.simpleLogFormatter = exports.defaultLogFormatter = exports.DEFAULT_LOGGER_NAME = exports.getDefaultFormatter = exports.setDefaultFormatter = exports.setDefaultWriter = exports.getDefaultLogLevel = exports.setDefaultLogLevel = exports.normalizeLogLevel = exports.isValidLogLevel = void 0;
+exports.setLogLevel = exports.getLogLevel = exports.Logger = exports.stringify = exports.createNullWriter = exports.createConsoleWriter = exports.clearLoggerCache = exports.getLogger = exports.jsonLogFormatter = exports.simpleLogFormatter = exports.defaultLogFormatter = exports.DEFAULT_LOGGER_NAME = exports.getDefaultFormatter = exports.setDefaultFormatter = exports.setDefaultWriter = exports.getDefaultLogLevel = exports.setDefaultLogLevel = exports.normalizeLogLevel = exports.isValidLogLevel = void 0;
 const LOG_LEVELS = [
     "error",
     "warning",
@@ -163,7 +163,7 @@ function stringify(obj, indent) {
         return `${obj}`;
     }
     else if (typeof obj === "bigint") {
-        return `${obj}`;
+        return `${obj}n`;
     }
     else if (typeof obj === "symbol") {
         return obj.toString();
@@ -178,17 +178,12 @@ function stringify(obj, indent) {
         return "null";
     }
     try {
-        // Custom replacer for circular references
-        const getCircularReplacer = () => {
-            const seen = new WeakSet();
-            return (_key, value) => {
-                if (typeof value === "object" && value !== null) {
-                    if (seen.has(value)) {
-                        return "[Circular]";
-                    }
-                    seen.add(value);
-                }
-                else if (typeof value === "bigint") {
+        // Deep clone the object while removing circular references
+        const seen = new WeakSet();
+        const deepCloneWithoutCircular = (value, path = []) => {
+            // Handle primitives and null
+            if (value === null || typeof value !== "object") {
+                if (typeof value === "bigint") {
                     return `${value}n`;
                 }
                 else if (typeof value === "function") {
@@ -198,15 +193,50 @@ function stringify(obj, indent) {
                     return value.toString();
                 }
                 return value;
-            };
+            }
+            // Check for circular reference
+            if (seen.has(value)) {
+                return undefined; // This will cause the property to be omitted
+            }
+            seen.add(value);
+            try {
+                // Handle arrays
+                if (Array.isArray(value)) {
+                    const cloned = [];
+                    for (let i = 0; i < value.length; i++) {
+                        const clonedValue = deepCloneWithoutCircular(value[i], [...path, String(i)]);
+                        if (clonedValue !== undefined) {
+                            cloned.push(clonedValue);
+                        }
+                    }
+                    return cloned;
+                }
+                // Handle objects
+                const cloned = {};
+                for (const key in value) {
+                    if (Object.prototype.hasOwnProperty.call(value, key)) {
+                        const clonedValue = deepCloneWithoutCircular(value[key], [...path, key]);
+                        if (clonedValue !== undefined) {
+                            cloned[key] = clonedValue;
+                        }
+                    }
+                }
+                return cloned;
+            }
+            finally {
+                // Remove from seen set when we're done processing this level
+                seen.delete(value);
+            }
         };
-        return JSON.stringify(obj, getCircularReplacer(), indent);
+        const clonedObj = deepCloneWithoutCircular(obj);
+        return JSON.stringify(clonedObj, null, indent);
     }
     catch (error) {
         const msg = error && typeof error === "object" && "message" in error ? error.message : "Unknown error";
         return `[Error stringifying object: ${msg}]`;
     }
 }
+exports.stringify = stringify;
 class Logger {
     constructor(name, logLevel, writer, formatter) {
         // Normalize for JavaScript users who might pass uppercase
@@ -261,27 +291,32 @@ class Logger {
     }
     trace(msg) {
         if (this._shouldWrite("trace")) {
-            this._writer.write(this._formatMessage("trace", stringify(msg)), "trace");
+            const message = typeof msg === "function" ? msg() : msg;
+            this._writer.write(this._formatMessage("trace", stringify(message)), "trace");
         }
     }
     debug(msg) {
         if (this._shouldWrite("debug")) {
-            this._writer.write(this._formatMessage("debug", stringify(msg)), "debug");
+            const message = typeof msg === "function" ? msg() : msg;
+            this._writer.write(this._formatMessage("debug", stringify(message)), "debug");
         }
     }
     info(msg) {
         if (this._shouldWrite("info")) {
-            this._writer.write(this._formatMessage("info", stringify(msg)), "info");
+            const message = typeof msg === "function" ? msg() : msg;
+            this._writer.write(this._formatMessage("info", stringify(message)), "info");
         }
     }
     warning(msg) {
         if (this._shouldWrite("warning")) {
-            this._writer.write(this._formatMessage("warning", stringify(msg)), "warning");
+            const message = typeof msg === "function" ? msg() : msg;
+            this._writer.write(this._formatMessage("warning", stringify(message)), "warning");
         }
     }
     error(msg) {
         if (this._shouldWrite("error")) {
-            this._writer.write(this._formatMessage("error", stringify(msg)), "error");
+            const message = typeof msg === "function" ? msg() : msg;
+            this._writer.write(this._formatMessage("error", stringify(message)), "error");
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chia-agent",
-  "version": "14.3.5",
+  "version": "14.3.6-beta.1",
   "author": "ChiaMineJP <admin@chiamine.jp>",
   "description": "chia rpc/websocket client library",
   "license": "MIT",

package/rpc/index.js

@@ -79,9 +79,9 @@ function loadCertFilesFromConfig(config) {
     const caCertPath = (0, index_1.resolveFromChiaRoot)([
         config["/private_ssl_ca/crt"],
     ]);
-    (0, logger_1.getLogger)().debug(`Loading client cert file from ${clientCertPath}`);
-    (0, logger_1.getLogger)().debug(`Loading client key file from ${clientKeyPath}`);
-    (0, logger_1.getLogger)().debug(`Loading ca cert file from ${caCertPath}`);
+    (0, logger_1.getLogger)().debug(() => `Loading client cert file from ${clientCertPath}`);
+    (0, logger_1.getLogger)().debug(() => `Loading client key file from ${clientKeyPath}`);
+    (0, logger_1.getLogger)().debug(() => `Loading ca cert file from ${caCertPath}`);
     const getCertOrKey = (path) => {
         if (!(0, fs_1.existsSync)(path)) {
             (0, logger_1.getLogger)().error(`ssl crt/key does not exist at: ${path}`);
@@ -111,10 +111,10 @@ class RPCAgent {
             if (agent.options && agent.options.host && agent.options.port) {
                 this._host = agent.options.host;
                 this._port = agent.options.port;
-                (0, logger_1.getLogger)().debug(`Constructing RPCAgent with httpsAgent: ${this._host}:${this._port}`);
+                (0, logger_1.getLogger)().debug(() => `Constructing RPCAgent with httpsAgent: ${this._host}:${this._port}`);
             }
             else {
-                (0, logger_1.getLogger)().debug("Constructing RPCAgent with httpsAgent (host/port not available in agent options)");
+                (0, logger_1.getLogger)().debug(() => "Constructing RPCAgent with httpsAgent (host/port not available in agent options)");
             }
         }
         else if ("httpAgent" in props) {
@@ -123,7 +123,7 @@ class RPCAgent {
             this._host = props.host;
             this._port = props.port;
             this._skip_hostname_verification = Boolean(props.skip_hostname_verification);
-            (0, logger_1.getLogger)().debug(`Constructing RPCAgent with httpAgent: ${this._host}:${this._port}`);
+            (0, logger_1.getLogger)().debug(() => `Constructing RPCAgent with httpAgent: ${this._host}:${this._port}`);
         }
         else if ("protocol" in props) {
             this._protocol = props.protocol;
@@ -172,7 +172,7 @@ class RPCAgent {
                     maxSockets,
                     timeout,
                 });
-                (0, logger_1.getLogger)().debug(`Constructed RPCAgent with httpsAgent: ${host}:${port}`);
+                (0, logger_1.getLogger)().debug(() => `Constructed RPCAgent with httpsAgent: ${host}:${port}`);
             }
             else {
                 this._agent = new http_1.Agent({
@@ -206,7 +206,7 @@ class RPCAgent {
                 host = props.host ? props.host : info.hostname;
                 port = typeof props.port === "number" ? props.port : info.port;
             }
-            (0, logger_1.getLogger)().debug(`Picked ${host}:${port} for ${props.service}`);
+            (0, logger_1.getLogger)().debug(() => `Picked ${host}:${port} for ${props.service}`);
             const certs = loadCertFilesFromConfig(config);
             const { clientCert, clientKey, caCert } = certs;
             this._skip_hostname_verification = Boolean(props.skip_hostname_verification);
@@ -229,7 +229,7 @@ class RPCAgent {
     sendMessage(destination, command, data) {
         return __awaiter(this, void 0, void 0, function* () {
             // parameter `destination` is not used because target rpc server is determined by url.
-            (0, logger_1.getLogger)().debug(`Sending RPC message. dest=${destination} command=${command}`);
+            (0, logger_1.getLogger)().debug(() => `Sending RPC message. dest=${destination} command=${command}`);
             return this.request("POST", command, data);
         });
     }
@@ -284,9 +284,9 @@ class RPCAgent {
                     }
                 }
                 const transporter = this._protocol === "https" ? https_1.request : http_1.request;
-                (0, logger_1.getLogger)().debug(`Dispatching RPC ${METHOD} request to ${this._protocol}//${this._host}:${this._port}${options.path}`);
-                (0, logger_1.getLogger)().trace(`Request options: ${JSON.stringify(options)}`);
-                (0, logger_1.getLogger)().trace(`Request body: ${body}`);
+                (0, logger_1.getLogger)().debug(() => `Dispatching RPC ${METHOD} request to ${this._protocol}//${this._host}:${this._port}${options.path}`);
+                (0, logger_1.getLogger)().trace(() => `Request options: ${(0, logger_1.stringify)(options)}`);
+                (0, logger_1.getLogger)().trace(() => `Request body: ${body}`);
                 const req = transporter(options, (res) => {
                     if (!res.statusCode || res.statusCode < 200 || res.statusCode >= 300) {
                         (0, logger_1.getLogger)().error(`Status not ok: ${res.statusCode}`);
@@ -302,9 +302,9 @@ class RPCAgent {
                     res.on("data", (chunk) => {
                         chunks.push(chunk);
                         if (chunks.length === 0) {
-                            (0, logger_1.getLogger)().debug("The first response chunk data arrived");
+                            (0, logger_1.getLogger)().debug(() => "The first response chunk data arrived");
                         }
-                        (0, logger_1.getLogger)().trace(`Response chunk #${chunks.length} - ${chunk.length} bytes: ${chunk.toString()}`);
+                        (0, logger_1.getLogger)().trace(() => `Response chunk #${chunks.length} - ${chunk.length} bytes: ${chunk.toString()}`);
                     });
                     res.on("end", () => {
                         try {
@@ -324,8 +324,8 @@ class RPCAgent {
                                     (0, logger_1.getLogger)().info(`API failure: ${d.error}`);
                                     return reject(d);
                                 }
-                                (0, logger_1.getLogger)().debug(`RPC response received from ${this._protocol}//${this._host}:${this._port}${options.path}`);
-                                (0, logger_1.getLogger)().trace(`RPC response data: ${JSON.stringify(d)}`);
+                                (0, logger_1.getLogger)().debug(() => `RPC response received from ${this._protocol}//${this._host}:${this._port}${options.path}`);
+                                (0, logger_1.getLogger)().trace(() => `RPC response data: ${(0, logger_1.stringify)(d)}`);
                                 return resolve(d);
                             }
                             // RPC Server should return response like
@@ -335,7 +335,7 @@ class RPCAgent {
                             reject(new Error("Server responded without expected data"));
                         }
                         catch (e) {
-                            (0, logger_1.getLogger)().error(`Failed to parse response data: ${JSON.stringify(e)}`);
+                            (0, logger_1.getLogger)().error(`Failed to parse response data: ${(0, logger_1.stringify)(e)}`);
                             try {
                                 (0, logger_1.getLogger)().error(Buffer.concat(chunks).toString());
                             }
@@ -347,7 +347,7 @@ class RPCAgent {
                     });
                 });
                 req.on("error", (error) => {
-                    (0, logger_1.getLogger)().error(JSON.stringify(error));
+                    (0, logger_1.getLogger)().error(() => (0, logger_1.stringify)(error));
                     reject(error);
                 });
                 if ((METHOD === "POST" || METHOD === "PUT" || METHOD === "DELETE") &&