RSDK-6041 - Add dial timeout option and default dial timeout (#235)

Author: cheukt

package-lock.json

@@ -45,7 +45,7 @@
   },
   "homepage": "https://github.com/viamrobotics/viam-typescript-sdk#readme",
   "dependencies": {
-    "@viamrobotics/rpc": "^0.2.2",
+    "@viamrobotics/rpc": "^0.2.3",
     "exponential-backoff": "^3.1.1"
   },
   "devDependencies": {

package.json

@@ -0,0 +1 @@
+export const DIAL_TIMEOUT = 5000;

src/constants.ts

@@ -8,6 +8,7 @@ import {
   type DialOptions,
 } from '@viamrobotics/rpc';
 import { grpc } from '@improbable-eng/grpc-web';
+import { DIAL_TIMEOUT } from '../constants';
 import { DISCONNECTED, EventDispatcher, events, RECONNECTED } from '../events';
 import proto from '../gen/robot/v1/robot_pb';
 import type {
@@ -64,6 +65,10 @@ export interface ConnectOptions {
   authEntity?: string;
   creds?: Credentials;
   priority?: number;
+
+  // set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT,
+  // and a value of 0 would disable the timeout.
+  dialTimeout?: number;
 }
 
 abstract class ServiceClient {
@@ -396,6 +401,7 @@ export class RobotClient extends EventDispatcher implements Robot {
     authEntity = this.savedAuthEntity,
     creds = this.savedCreds,
     priority,
+    dialTimeout,
   }: ConnectOptions = {}) {
     if (this.connecting) {
       // This lint is clearly wrong due to how the event loop works such that after an await, the condition may no longer be true.
@@ -429,6 +435,7 @@ export class RobotClient extends EventDispatcher implements Robot {
           disableTrickleICE: false,
           rtcConfig: this.webrtcOptions?.rtcConfig,
         },
+        dialTimeout: dialTimeout ?? DIAL_TIMEOUT,
       };
 
       // Webrtcoptions will always be defined, but TS doesn't know this

src/robot/client.ts

@@ -1,3 +1,4 @@
+import { DIAL_TIMEOUT } from '../constants';
 import { RobotClient } from './client';
 
 interface Credential {
@@ -14,6 +15,9 @@ export interface DialDirectConf {
   noReconnect?: boolean;
   reconnectMaxAttempts?: number;
   reconnectMaxWait?: number;
+  // set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT,
+  // and a value of 0 would disable the timeout.
+  dialTimeout?: number;
 }
 
 /** Check if a given number is a positive integer */
@@ -50,7 +54,11 @@ const dialDirect = async (conf: DialDirectConf): Promise<RobotClient> => {
   if (conf.credential) {
     creds = conf.credential;
   }
-  await client.connect({ authEntity: conf.authEntity, creds });
+  await client.connect({
+    authEntity: conf.authEntity,
+    creds,
+    dialTimeout: conf.dialTimeout ?? DIAL_TIMEOUT,
+  });
 
   // eslint-disable-next-line no-console
   console.debug('connected via gRPC');
@@ -83,6 +91,10 @@ export interface DialWebRTCConf {
   signalingAddress: string;
   iceServers?: ICEServer[];
   priority?: number;
+
+  // set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT,
+  // and a value of 0 would disable the timeout.
+  dialTimeout?: number;
 }
 
 const dialWebRTC = async (conf: DialWebRTCConf): Promise<RobotClient> => {
@@ -117,6 +129,7 @@ const dialWebRTC = async (conf: DialWebRTCConf): Promise<RobotClient> => {
     authEntity: conf.authEntity ?? impliedURL,
     creds,
     priority: conf.priority,
+    dialTimeout: conf.dialTimeout ?? DIAL_TIMEOUT,
   });
 
   // eslint-disable-next-line no-console