chia-agent 14.3.0 → 14.3.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [14.3.2]
+### Changed
+- Error logs are generated when
+  - an error occurs during sending a message.
+  - it receives a websocket message with unexpected format.
+- Debug logs are generated when ping/pong events are triggered.
+
+## [14.3.1]
+### Changed
+- Added a `Host` header when sending https request to a remote host.
+
 ## [14.3.0]
 ### Changed
 - Removed `RpcWalletMessageOnWs` since it's costly to maintain while there are a few use cases.
@@ -1704,6 +1715,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.2]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.1...v14.3.2
+[14.3.1]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.0...v14.3.1
 [14.3.0]: https://github.com/Chia-Mine/chia-agent/compare/v14.2.2...v14.3.0
 [14.2.2]: https://github.com/Chia-Mine/chia-agent/compare/v14.2.1...v14.2.2
 [14.2.1]: https://github.com/Chia-Mine/chia-agent/compare/v14.2.0...v14.2.1

package/daemon/connection.d.ts

@@ -1,5 +1,6 @@
 import * as WS from "ws";
 import { Event } from "ws";
+export declare const defaultTimeoutInMs = 50000;
 export declare function open(url: string, timeoutMs?: number): Promise<{
     ws: WS;
     openEvent: Event;

package/daemon/connection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.open = void 0;
+exports.open = exports.defaultTimeoutInMs = void 0;
 const fs_1 = require("fs");
 const config_1 = require("../config");
 const WS = require("ws");
@@ -25,25 +25,33 @@ function create(url) {
     };
     return new WS(url, options);
 }
-const defaultTimeoutInMs = 50000;
+exports.defaultTimeoutInMs = 50000;
 function open(url, timeoutMs) {
     return new Promise((resolve, reject) => {
         const ws = create(url);
         let timer = null;
-        timeoutMs = typeof timeoutMs === "number" ? timeoutMs : defaultTimeoutInMs;
+        timeoutMs = typeof timeoutMs === "number" ? timeoutMs : exports.defaultTimeoutInMs;
+        let opened = false;
         timer = setTimeout(() => {
             timer = null;
             (0, logger_1.getLogger)().error("Request to open connection timed out");
             reject("Timeout");
         }, timeoutMs);
-        ws.onopen = (openEvent) => {
+        const onOpenError = (err) => {
+            if (!opened) {
+                reject(err);
+            }
+        };
+        ws.addEventListener("open", (openEvent) => {
+            opened = true;
+            ws.removeEventListener("error", onOpenError);
             if (timer !== null) {
                 clearTimeout(timer);
                 timer = null;
                 resolve({ ws, openEvent });
             }
-        };
-        ws.onerror = (err) => reject(err);
+        });
+        ws.addEventListener("error", onOpenError);
     });
 }
 exports.open = open;

package/daemon/index.d.ts

@@ -57,6 +57,8 @@ declare class Daemon {
     protected onError(error: ErrorEvent): void;
     protected onMessage(event: MessageEvent): void;
     protected onClose(event: CloseEvent): void;
+    protected onPing(): void;
+    protected onPong(): void;
 }
 export type TDaemon = InstanceType<typeof Daemon>;
 export {};

package/daemon/index.js

@@ -68,6 +68,8 @@ class Daemon {
         this.onError = this.onError.bind(this);
         this.onMessage = this.onMessage.bind(this);
         this.onClose = this.onClose.bind(this);
+        this.onPing = this.onPing.bind(this);
+        this.onPong = this.onPong.bind(this);
     }
     /**
      * Connect to local daemon via websocket.
@@ -92,9 +94,11 @@ class Daemon {
             (0, logger_1.getLogger)().debug(`Opening websocket connection to ${daemonServerURL}`);
             const result = yield (0, connection_1.open)(daemonServerURL, timeoutMs);
             this._socket = result.ws;
-            this._socket.onerror = this.onError;
-            this._socket.onmessage = this.onMessage;
-            this._socket.onclose = this.onClose;
+            this._socket.addEventListener("error", this.onError);
+            this._socket.addEventListener("message", this.onMessage);
+            this._socket.addEventListener("close", this.onClose);
+            this._socket.addListener("ping", this.onPing);
+            this._socket.addListener("pong", this.onPong);
             yield this.onOpen(result.openEvent, daemonServerURL);
             return true;
         });
@@ -124,7 +128,13 @@ class Daemon {
                 const reqId = message.request_id;
                 this._responseQueue[reqId] = resolve;
                 (0, logger_1.getLogger)().debug(`Sending message. dest=${destination} command=${command} reqId=${reqId}`);
-                this._socket.send(JSON.stringify(message));
+                const messageStr = JSON.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));
+                    }
+                });
             });
         });
     }
@@ -252,8 +262,19 @@ class Daemon {
         this._errorEventListeners.forEach(l => l(error));
     }
     onMessage(event) {
-        const payload = JSON.parse(event.data);
-        const { request_id, origin, command } = payload;
+        let payload;
+        let request_id;
+        let origin;
+        let command;
+        try {
+            payload = JSON.parse(event.data);
+            ({ request_id, origin, command } = payload);
+        }
+        catch (err) {
+            (0, logger_1.getLogger)().error(`Failed to parse message data: ${JSON.stringify(err)}`);
+            (0, logger_1.getLogger)().error(`payload: ${event.data}`);
+            return;
+        }
         (0, logger_1.getLogger)().debug(`Arrived message. origin=${origin} command=${command} reqId=${request_id}`);
         const resolver = this._responseQueue[request_id];
         if (resolver) {
@@ -276,6 +297,8 @@ class Daemon {
             this._socket.removeEventListener("error", this.onError);
             this._socket.removeEventListener("message", this.onMessage);
             this._socket.removeEventListener("close", this.onClose);
+            this._socket.removeListener("ping", this.onPing);
+            this._socket.removeListener("pong", this.onPong);
             this._socket = null;
         }
         this._closing = false;
@@ -289,4 +312,10 @@ class Daemon {
             this._onClosePromise = undefined;
         }
     }
+    onPing() {
+        (0, logger_1.getLogger)().debug("Received ping");
+    }
+    onPong() {
+        (0, logger_1.getLogger)().debug("Received pong");
+    }
 }

package/package.json

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

package/rpc/index.js

@@ -202,14 +202,19 @@ class RPCAgent {
                 const body = data ? JSONbig.stringify(data) : "{}";
                 const pathname = `/${path.replace(/^\/+/, "")}`;
                 const METHOD = method.toUpperCase();
+                const headers = {
+                    Accept: "application/json, text/plain, */*",
+                    "User-Agent": userAgent,
+                };
+                if ("options" in this._agent && typeof this._agent.options.host === "string") {
+                    // Assuming `this._agent instanceof HttpsAgent` is true.
+                    headers.Host = this._agent.options.host;
+                }
                 const options = {
                     path: pathname,
                     method: METHOD,
                     agent: this._agent,
-                    headers: {
-                        Accept: "application/json, text/plain, */*",
-                        "User-Agent": userAgent,
-                    },
+                    headers,
                 };
                 if (this._skip_hostname_verification) {
                     options.checkServerIdentity = () => {