feat: added optional timeout timers to NodeConnectionManager methods

In some cases we want to specify how long we attempt to connect to a node on a per-connection basis.

Related #363

src/PolykeyClient.ts

@@ -1,4 +1,4 @@
-import type { FileSystem } from './types';
+import type { FileSystem, Timer } from './types';
 import type { NodeId } from './nodes/types';
 import type { Host, Port } from './network/types';
 
@@ -29,7 +29,7 @@ class PolykeyClient {
     nodePath = config.defaults.nodePath,
     session,
     grpcClient,
-    timeout,
+    timer,
     fs = require('fs'),
     logger = new Logger(this.name),
     fresh = false,
@@ -38,7 +38,7 @@ class PolykeyClient {
     host: Host;
     port: Port;
     nodePath?: string;
-    timeout?: number;
+    timer?: Timer;
     session?: Session;
     grpcClient?: GRPCClientClient;
     fs?: FileSystem;
@@ -66,7 +66,7 @@ class PolykeyClient {
         port,
         tlsConfig: { keyPrivatePem: undefined, certChainPem: undefined },
         session,
-        timeout,
+        timer,
         logger: logger.getChild(GRPCClientClient.name),
       }));
     const pkClient = new PolykeyClient({

src/agent/GRPCClientAgent.ts

@@ -10,6 +10,7 @@ import type * as utilsPB from '../proto/js/polykey/v1/utils/utils_pb';
 import type * as vaultsPB from '../proto/js/polykey/v1/vaults/vaults_pb';
 import type * as nodesPB from '../proto/js/polykey/v1/nodes/nodes_pb';
 import type * as notificationsPB from '../proto/js/polykey/v1/notifications/notifications_pb';
+import type { Timer } from '../types';
 import Logger from '@matrixai/logger';
 import { CreateDestroy, ready } from '@matrixai/async-init/dist/CreateDestroy';
 import * as agentErrors from './errors';
@@ -32,7 +33,7 @@ class GRPCClientAgent extends GRPCClient<AgentServiceClient> {
     port,
     tlsConfig,
     proxyConfig,
-    timeout = Infinity,
+    timer,
     destroyCallback = async () => {},
     logger = new Logger(this.name),
   }: {
@@ -41,7 +42,7 @@ class GRPCClientAgent extends GRPCClient<AgentServiceClient> {
     port: Port;
     tlsConfig?: Partial<TLSConfig>;
     proxyConfig?: ProxyConfig;
-    timeout?: number;
+    timer?: Timer;
     destroyCallback?: () => Promise<void>;
     logger?: Logger;
   }): Promise<GRPCClientAgent> {
@@ -53,7 +54,7 @@ class GRPCClientAgent extends GRPCClient<AgentServiceClient> {
         port,
         tlsConfig,
         proxyConfig,
-        timeout,
+        timer,
         logger,
       });
     const grpcClientAgent = new GRPCClientAgent({

src/client/GRPCClientClient.ts

@@ -14,6 +14,7 @@ import type * as identitiesPB from '../proto/js/polykey/v1/identities/identities
 import type * as keysPB from '../proto/js/polykey/v1/keys/keys_pb';
 import type * as permissionsPB from '../proto/js/polykey/v1/permissions/permissions_pb';
 import type * as secretsPB from '../proto/js/polykey/v1/secrets/secrets_pb';
+import type { Timer } from '../types';
 import { CreateDestroy, ready } from '@matrixai/async-init/dist/CreateDestroy';
 import Logger from '@matrixai/logger';
 import * as clientErrors from './errors';
@@ -38,7 +39,7 @@ class GRPCClientClient extends GRPCClient<ClientServiceClient> {
     tlsConfig,
     proxyConfig,
     session,
-    timeout = Infinity,
+    timer,
     destroyCallback = async () => {},
     logger = new Logger(this.name),
   }: {
@@ -48,7 +49,7 @@ class GRPCClientClient extends GRPCClient<ClientServiceClient> {
     tlsConfig?: Partial<TLSConfig>;
     proxyConfig?: ProxyConfig;
     session?: Session;
-    timeout?: number;
+    timer?: Timer;
     destroyCallback?: () => Promise<void>;
     logger?: Logger;
   }): Promise<GRPCClientClient> {
@@ -64,7 +65,7 @@ class GRPCClientClient extends GRPCClient<ClientServiceClient> {
         port,
         tlsConfig,
         proxyConfig,
-        timeout,
+        timer,
         interceptors,
         logger,
       });

src/grpc/GRPCClient.ts

@@ -9,6 +9,7 @@ import type {
 import type { NodeId } from '../nodes/types';
 import type { Certificate } from '../keys/types';
 import type { Host, Port, TLSConfig, ProxyConfig } from '../network/types';
+import type { Timer } from '../types';
 import http2 from 'http2';
 import Logger from '@matrixai/logger';
 import * as grpc from '@grpc/grpc-js';
@@ -44,7 +45,7 @@ abstract class GRPCClient<T extends Client = Client> {
     port,
     tlsConfig,
     proxyConfig,
-    timeout = Infinity,
+    timer,
     interceptors = [],
     logger = new Logger(this.name),
   }: {
@@ -58,7 +59,7 @@ abstract class GRPCClient<T extends Client = Client> {
     port: Port;
     tlsConfig?: Partial<TLSConfig>;
     proxyConfig?: ProxyConfig;
-    timeout?: number;
+    timer?: Timer;
     interceptors?: Array<Interceptor>;
     logger?: Logger;
   }): Promise<{
@@ -123,9 +124,17 @@ abstract class GRPCClient<T extends Client = Client> {
     }
     const waitForReady = promisify(client.waitForReady).bind(client);
     // Add the current unix time because grpc expects the milliseconds since unix epoch
-    timeout += Date.now();
     try {
-      await waitForReady(timeout);
+      if (timer != null) {
+        await Promise.race([timer.timerP, waitForReady(Infinity)]);
+        // If the timer resolves first we throw a timeout error
+        if (timer?.timedOut === true) {
+          throw new grpcErrors.ErrorGRPCClientTimeout();
+        }
+      } else {
+        // No timer given so we wait forever
+        await waitForReady(Infinity);
+      }
     } catch (e) {
       // If we fail here then we leak the client object...
       client.close();

src/nodes/NodeConnection.ts

@@ -5,6 +5,7 @@ import type { Certificate, PublicKey, PublicKeyPem } from '../keys/types';
 import type Proxy from '../network/Proxy';
 import type GRPCClient from '../grpc/GRPCClient';
 import type NodeConnectionManager from './NodeConnectionManager';
+import type { Timer } from '../types';
 import Logger from '@matrixai/logger';
 import { CreateDestroy, ready } from '@matrixai/async-init/dist/CreateDestroy';
 import * as asyncInit from '@matrixai/async-init';
@@ -38,7 +39,7 @@ class NodeConnection<T extends GRPCClient> {
     targetHost,
     targetPort,
     targetHostname,
-    connConnectTime = 20000,
+    timer,
     proxy,
     keyManager,
     clientFactory,
@@ -50,7 +51,7 @@ class NodeConnection<T extends GRPCClient> {
     targetHost: Host;
     targetPort: Port;
     targetHostname?: Hostname;
-    connConnectTime?: number;
+    timer?: Timer;
     proxy: Proxy;
     keyManager: KeyManager;
     clientFactory: (...args) => Promise<T>;
@@ -125,7 +126,7 @@ class NodeConnection<T extends GRPCClient> {
               await nodeConnection.destroy();
             }
           },
-          timeout: connConnectTime,
+          timer: timer,
         }),
         holePunchPromises,
       ]);