@tdxvolt/volt-client-grpc 0.14.58 → 0.14.60

package/lib/index.cjs

@@ -603,6 +603,7 @@ class VoltCredential {
       aud: audience,
       iat: Math.floor(Date.now() / 1000) - ttl,
       exp: Math.floor(Date.now() / 1000) + ttl,
+      sub: this._cryptoCache.client_id,
     };
 
     let sharedKey;
@@ -1082,50 +1083,55 @@ class GRPCCall extends EventEmitter__default["default"] {
 const log$2 = debug__default["default"]("volt-client-grpc:volt-connection");
 
 function _cleanUp(immediateReconnect) {
-	this._session = false;
-
-	if (this._pingTimer) {
-		clearTimeout(this._pingTimer);
-		this._pingTimer = 0;
-	}
-
-	if (this._pingTimeoutTimer) {
-		clearTimeout(this._pingTimeoutTimer);
-		this._pingTimeoutTimer = 0;
-	}
-
-	if (
-		!this._dying &&
-		(immediateReconnect || (this._autoRetry && !this._reconnectTimer))
-	) {
-		this._reconnectTimer = setTimeout(
-			() => {
-				this._reconnectTimer = 0;
-				_doConnect.call(this);
-			},
-			immediateReconnect ? 0 : this._reconnectInterval,
-		);
-	}
-
-	if (this.call?.writable) {
-		this.call.end();
-	}
+  this._connectionId = "";
+
+  if (this._pingTimer) {
+    clearTimeout(this._pingTimer);
+    this._pingTimer = 0;
+  }
+
+  if (this._pingTimeoutTimer) {
+    clearTimeout(this._pingTimeoutTimer);
+    this._pingTimeoutTimer = 0;
+  }
+
+  if (
+    !this._dying &&
+    (immediateReconnect || (this._autoRetry && !this._reconnectTimer))
+  ) {
+    this._reconnectTimer = setTimeout(
+      () => {
+        this._reconnectTimer = 0;
+        _doConnect.call(this, this._helloPayload);
+      },
+      immediateReconnect ? 0 : this._reconnectInterval,
+    );
+  }
+
+  if (this.call?.writable) {
+    this.call.end();
+  }
 }
 
 function _connectionTimeoutHandler() {
-	log$2("server timed out");
-	this.emit("connected", false);
-	_cleanUp.call(this);
+  log$2("server timed out");
+  this.emit("connected", false);
+  _cleanUp.call(this);
 }
 
-function _doConnect() {
-	this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+function _doConnect(connectHello) {
+  this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+
+  const grpcClient = this._voltClient.getVoltAPIClient();
+
+  let helloPayload = connectHello;
+  if (!connectHello) {
+    log$2("defaulting hello payload");
+    helloPayload = {
+      hello: {},
+    };
+  }
 
-	const grpcClient = this._voltClient.getVoltAPIClient();
-	const helloPayload = {
-		hello: {},
-	};
-  
   this.call.on("error", (err) => {
     log$2("error on connection stream [%s]", err.message);
     _cleanUp.call(this);
@@ -1146,10 +1152,11 @@ function _doConnect() {
         _startPingTimer.call(this);
         break;
       }
-      case "hello": {
-        if (!this._session) {
-          this._session = true;
-          this.emit("connected", this._session);
+      case "acknowledge": {
+        if (!this._connectionId) {
+          this._connectionId = response.acknowledge.connection_id;
+          log$2("connection id is %s", this._connectionId);
+          this.emit("connected", this._connectionId);
         }
         break;
       }
@@ -1165,74 +1172,76 @@ function _doConnect() {
   });
 
   this.call.on("end", () => {
-    if (this._session) {
+    if (this._connectionId) {
       this.emit("connected", false);
     }
     _cleanUp.call(this);
   });
 
-	this.call.start(grpcClient, helloPayload);
+  this.call.start(grpcClient, helloPayload);
 
-	_startPingTimer.call(this);
+  _startPingTimer.call(this);
 }
 
 function _startPingTimer() {
-	if (this._pingTimer) {
-		log$2("ping timer running");
-		return;
-	}
-
-	this._pingTimer = setTimeout(() => {
-		// Send next ping to server.
-		const request = { ping: { timestamp: Date.now() } };
-
-		log$2("pinging Volt");
-		this.call.write(request);
-
-		this._pingTimer = 0;
-
-		// Schedule a timeout if we don't hear back from the server.
-		if (this._pingTimeoutTimer) {
-			clearTimeout(this._pingTimeoutTimer);
-		}
-
-		this._pingTimeoutTimer = setTimeout(
-			_connectionTimeoutHandler.bind(this),
-			this._timeoutInterval,
-		);
-	}, this._pingInterval);
+  if (this._pingTimer) {
+    log$2("ping timer running");
+    return;
+  }
+
+  this._pingTimer = setTimeout(() => {
+    // Send next ping to server.
+    const request = { ping: { timestamp: Date.now() } };
+
+    log$2("pinging Volt");
+    this.call.write(request);
+
+    this._pingTimer = 0;
+
+    // Schedule a timeout if we don't hear back from the server.
+    if (this._pingTimeoutTimer) {
+      clearTimeout(this._pingTimeoutTimer);
+    }
+
+    this._pingTimeoutTimer = setTimeout(
+      _connectionTimeoutHandler.bind(this),
+      this._timeoutInterval,
+    );
+  }, this._pingInterval);
 }
 
 class VoltConnection extends EventEmitter__default["default"] {
-	constructor(voltClient, grpc) {
-		super();
-
-		const config = voltClient.config;
-		this._grpc = grpc;
-		this._autoRetry =
-			config.autoReconnect === undefined ? true : !!config.autoReconnect;
-		this._dying = false;
-		this._voltClient = voltClient;
-		this._pingTimer = 0;
-		this._pingTimeoutTimer = 0;
-		this._session = false;
-		this._pingInterval = config.pingInterval || 10000;
-		this._reconnectInterval = config.reconnectInterval || 5000;
-		this._timeoutInterval = config.timeoutInterval || 60000;
-	}
-
-	connect(throwOnFail) {
-		if (throwOnFail) {
-			return _doConnect.call(this);
-		} else {
-			return Promise.resolve(_cleanUp.call(this, true));
-		}
-	}
-
-	disconnect() {
-		this._dying = true;
-		_cleanUp.call(this);
-	}
+  constructor(voltClient, grpc) {
+    super();
+
+    const config = voltClient.config;
+    this._grpc = grpc;
+    this._autoRetry =
+      config.autoReconnect === undefined ? true : !!config.autoReconnect;
+    this._dying = false;
+    this._voltClient = voltClient;
+    this._pingTimer = 0;
+    this._pingTimeoutTimer = 0;
+    this._connectionId = "";
+    this._pingInterval = config.pingInterval || 10000;
+    this._reconnectInterval = config.reconnectInterval || 5000;
+    this._timeoutInterval = config.timeoutInterval || 60000;
+    this._helloPayload = undefined;
+  }
+
+  connect(helloPayload, throwOnFail) {
+    this._helloPayload = helloPayload;
+    if (throwOnFail) {
+      return _doConnect.call(this, this._helloPayload);
+    } else {
+      return Promise.resolve(_cleanUp.call(this, true));
+    }
+  }
+
+  disconnect() {
+    this._dying = true;
+    _cleanUp.call(this);
+  }
 }
 
 /* eslint-disable no-underscore-dangle */
@@ -1413,7 +1422,7 @@ async function bindInternal() {
   }
 }
 
-function connectInternal() {
+function connectInternal(helloPayload) {
   try {
     if (this._voltConnection) {
       log$1("connectInternal - Volt connection already exists");
@@ -1443,7 +1452,7 @@ function connectInternal() {
       if (!this._connected) {
         onDisconnected();
       }
-      this.emit("connected", !!session);
+      this.emit("connected", session);
     });
 
     this._voltConnection.on("error", (err) => {
@@ -1459,7 +1468,7 @@ function connectInternal() {
       this.emit("evt", evt);
     });
 
-    return this._voltConnection.connect();
+    return this._voltConnection.connect(helloPayload);
   } catch (err) {
     log$1("connect - error [%s]", err.message);
     throw err;
@@ -1758,10 +1767,10 @@ class VoltClient extends EventEmitter__default["default"] {
     }
   }
 
-  initialiseAndConnect(configPath, extras = {}) {
+  initialiseAndConnect(configPath, helloPayload = undefined, extras = {}) {
     return this.initialise(configPath, extras)
       .then(() => {
-        return connectInternal.call(this);
+        return connectInternal.call(this, helloPayload);
       })
       .catch((err) => {
         log("initialiseAndConnect failure: %s", err.message);
@@ -1834,8 +1843,8 @@ class VoltClient extends EventEmitter__default["default"] {
     return this.isRemote && !this._voltConfig?.relay.cloud;
   }
 
-  connect() {
-    return connectInternal.call(this);
+  connect(helloPayload) {
+    return connectInternal.call(this, helloPayload);
   }
 
   disconnect() {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.14.58",
+  "version": "0.14.60",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -48,4 +48,4 @@
     "node-forge": "^0.9.0",
     "uuid": "^8.1.0"
   }
-}
+}

package/src/volt-client-internal.js

@@ -187,7 +187,7 @@ export async function bindInternal() {
   }
 }
 
-export function connectInternal() {
+export function connectInternal(helloPayload) {
   try {
     if (this._voltConnection) {
       log("connectInternal - Volt connection already exists");
@@ -217,7 +217,7 @@ export function connectInternal() {
       if (!this._connected) {
         onDisconnected();
       }
-      this.emit("connected", !!session);
+      this.emit("connected", session);
     });
 
     this._voltConnection.on("error", (err) => {
@@ -233,7 +233,7 @@ export function connectInternal() {
       this.emit("evt", evt);
     });
 
-    return this._voltConnection.connect();
+    return this._voltConnection.connect(helloPayload);
   } catch (err) {
     log("connect - error [%s]", err.message);
     throw err;

package/src/volt-client.js

@@ -189,10 +189,10 @@ export class VoltClient extends EventEmitter {
     }
   }
 
-  initialiseAndConnect(configPath, extras = {}) {
+  initialiseAndConnect(configPath, helloPayload = undefined, extras = {}) {
     return this.initialise(configPath, extras)
       .then(() => {
-        return connectInternal.call(this);
+        return connectInternal.call(this, helloPayload);
       })
       .catch((err) => {
         log("initialiseAndConnect failure: %s", err.message);
@@ -265,8 +265,8 @@ export class VoltClient extends EventEmitter {
     return this.isRemote && !this._voltConfig?.relay.cloud;
   }
 
-  connect() {
-    return connectInternal.call(this);
+  connect(helloPayload) {
+    return connectInternal.call(this, helloPayload);
   }
 
   disconnect() {

package/src/volt-connection.js

@@ -7,50 +7,55 @@ import GRPCCall from "./grpc-call.js";
 const log = debug("volt-client-grpc:volt-connection");
 
 function _cleanUp(immediateReconnect) {
-	this._session = false;
-
-	if (this._pingTimer) {
-		clearTimeout(this._pingTimer);
-		this._pingTimer = 0;
-	}
-
-	if (this._pingTimeoutTimer) {
-		clearTimeout(this._pingTimeoutTimer);
-		this._pingTimeoutTimer = 0;
-	}
-
-	if (
-		!this._dying &&
-		(immediateReconnect || (this._autoRetry && !this._reconnectTimer))
-	) {
-		this._reconnectTimer = setTimeout(
-			() => {
-				this._reconnectTimer = 0;
-				_doConnect.call(this);
-			},
-			immediateReconnect ? 0 : this._reconnectInterval,
-		);
-	}
-
-	if (this.call?.writable) {
-		this.call.end();
-	}
+  this._connectionId = "";
+
+  if (this._pingTimer) {
+    clearTimeout(this._pingTimer);
+    this._pingTimer = 0;
+  }
+
+  if (this._pingTimeoutTimer) {
+    clearTimeout(this._pingTimeoutTimer);
+    this._pingTimeoutTimer = 0;
+  }
+
+  if (
+    !this._dying &&
+    (immediateReconnect || (this._autoRetry && !this._reconnectTimer))
+  ) {
+    this._reconnectTimer = setTimeout(
+      () => {
+        this._reconnectTimer = 0;
+        _doConnect.call(this, this._helloPayload);
+      },
+      immediateReconnect ? 0 : this._reconnectInterval,
+    );
+  }
+
+  if (this.call?.writable) {
+    this.call.end();
+  }
 }
 
 function _connectionTimeoutHandler() {
-	log("server timed out");
-	this.emit("connected", false);
-	_cleanUp.call(this);
+  log("server timed out");
+  this.emit("connected", false);
+  _cleanUp.call(this);
 }
 
-function _doConnect() {
-	this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+function _doConnect(connectHello) {
+  this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+
+  const grpcClient = this._voltClient.getVoltAPIClient();
+
+  let helloPayload = connectHello;
+  if (!connectHello) {
+    log("defaulting hello payload");
+    helloPayload = {
+      hello: {},
+    };
+  }
 
-	const grpcClient = this._voltClient.getVoltAPIClient();
-	const helloPayload = {
-		hello: {},
-	};
-  
   this.call.on("error", (err) => {
     log("error on connection stream [%s]", err.message);
     _cleanUp.call(this);
@@ -71,10 +76,11 @@ function _doConnect() {
         _startPingTimer.call(this);
         break;
       }
-      case "hello": {
-        if (!this._session) {
-          this._session = true;
-          this.emit("connected", this._session);
+      case "acknowledge": {
+        if (!this._connectionId) {
+          this._connectionId = response.acknowledge.connection_id;
+          log("connection id is %s", this._connectionId);
+          this.emit("connected", this._connectionId);
         }
         break;
       }
@@ -90,72 +96,74 @@ function _doConnect() {
   });
 
   this.call.on("end", () => {
-    if (this._session) {
+    if (this._connectionId) {
       this.emit("connected", false);
     }
     _cleanUp.call(this);
   });
 
-	this.call.start(grpcClient, helloPayload);
+  this.call.start(grpcClient, helloPayload);
 
-	_startPingTimer.call(this);
+  _startPingTimer.call(this);
 }
 
 function _startPingTimer() {
-	if (this._pingTimer) {
-		log("ping timer running");
-		return;
-	}
-
-	this._pingTimer = setTimeout(() => {
-		// Send next ping to server.
-		const request = { ping: { timestamp: Date.now() } };
-
-		log("pinging Volt");
-		this.call.write(request);
-
-		this._pingTimer = 0;
-
-		// Schedule a timeout if we don't hear back from the server.
-		if (this._pingTimeoutTimer) {
-			clearTimeout(this._pingTimeoutTimer);
-		}
-
-		this._pingTimeoutTimer = setTimeout(
-			_connectionTimeoutHandler.bind(this),
-			this._timeoutInterval,
-		);
-	}, this._pingInterval);
+  if (this._pingTimer) {
+    log("ping timer running");
+    return;
+  }
+
+  this._pingTimer = setTimeout(() => {
+    // Send next ping to server.
+    const request = { ping: { timestamp: Date.now() } };
+
+    log("pinging Volt");
+    this.call.write(request);
+
+    this._pingTimer = 0;
+
+    // Schedule a timeout if we don't hear back from the server.
+    if (this._pingTimeoutTimer) {
+      clearTimeout(this._pingTimeoutTimer);
+    }
+
+    this._pingTimeoutTimer = setTimeout(
+      _connectionTimeoutHandler.bind(this),
+      this._timeoutInterval,
+    );
+  }, this._pingInterval);
 }
 
 export default class VoltConnection extends EventEmitter {
-	constructor(voltClient, grpc) {
-		super();
-
-		const config = voltClient.config;
-		this._grpc = grpc;
-		this._autoRetry =
-			config.autoReconnect === undefined ? true : !!config.autoReconnect;
-		this._dying = false;
-		this._voltClient = voltClient;
-		this._pingTimer = 0;
-		this._pingTimeoutTimer = 0;
-		this._session = false;
-		this._pingInterval = config.pingInterval || 10000;
-		this._reconnectInterval = config.reconnectInterval || 5000;
-		this._timeoutInterval = config.timeoutInterval || 60000;
-	}
-
-	connect(throwOnFail) {
-		if (throwOnFail) {
-			return _doConnect.call(this);
-		} else {
-			return Promise.resolve(_cleanUp.call(this, true));
-		}
-	}
-
-	disconnect() {
-		this._dying = true;
-		_cleanUp.call(this);
-	}
+  constructor(voltClient, grpc) {
+    super();
+
+    const config = voltClient.config;
+    this._grpc = grpc;
+    this._autoRetry =
+      config.autoReconnect === undefined ? true : !!config.autoReconnect;
+    this._dying = false;
+    this._voltClient = voltClient;
+    this._pingTimer = 0;
+    this._pingTimeoutTimer = 0;
+    this._connectionId = "";
+    this._pingInterval = config.pingInterval || 10000;
+    this._reconnectInterval = config.reconnectInterval || 5000;
+    this._timeoutInterval = config.timeoutInterval || 60000;
+    this._helloPayload = undefined;
+  }
+
+  connect(helloPayload, throwOnFail) {
+    this._helloPayload = helloPayload;
+    if (throwOnFail) {
+      return _doConnect.call(this, this._helloPayload);
+    } else {
+      return Promise.resolve(_cleanUp.call(this, true));
+    }
+  }
+
+  disconnect() {
+    this._dying = true;
+    _cleanUp.call(this);
+  }
 }

package/src/volt-credential.js

@@ -149,6 +149,7 @@ export class VoltCredential {
       aud: audience,
       iat: Math.floor(Date.now() / 1000) - ttl,
       exp: Math.floor(Date.now() / 1000) + ttl,
+      sub: this._cryptoCache.client_id,
     };
 
     let sharedKey;