Update keepalive settings to agreed naming / behaviour

Author: George-Payne

src/Client/index.ts

@@ -22,10 +22,16 @@ import { parseConnectionString } from "./parseConnectionString";
 
 interface ClientOptions {
   /**
-   * The optional amount of time to wait after which a keepalive ping is sent on the transport. (in ms)
+   * The amount of time to wait after which a keepalive ping is sent on the transport. (in ms)
+   * Use -1 to disable
    * @default 10_000
    */
-  keepAlive?: number | false;
+  keepAliveInterval?: number;
+  /**
+   * The amount of time to wait after which a keepalive ping is sent on the transport. (in ms)
+   * @default 10_000
+   */
+  keepAliveTimeout?: number;
   /**
    * Whether or not to immediately throw an exception when an append fails.
    * @default true
@@ -82,7 +88,9 @@ export class Client {
   #connectionSettings: ConnectionTypeOptions;
   #channelCredentials: ChannelCredentials;
   #insecure: boolean;
-  #keepAlive: number | false;
+  #keepAliveInterval: number;
+  #keepAliveTimeout: number;
+
   #defaultCredentials?: Credentials;
 
   #channel?: Promise<Channel>;
@@ -131,7 +139,8 @@ export class Client {
           gossipTimeout: options.gossipTimeout,
           maxDiscoverAttempts: options.maxDiscoverAttempts,
           throwOnAppendFailure: options.throwOnAppendFailure,
-          keepAlive: options.keepAlive,
+          keepAliveInterval: options.keepAliveInterval,
+          keepAliveTimeout: options.keepAliveTimeout,
         },
         channelCredentials,
         options.defaultCredentials
@@ -147,7 +156,8 @@ export class Client {
           gossipTimeout: options.gossipTimeout,
           maxDiscoverAttempts: options.maxDiscoverAttempts,
           throwOnAppendFailure: options.throwOnAppendFailure,
-          keepAlive: options.keepAlive,
+          keepAliveInterval: options.keepAliveInterval,
+          keepAliveTimeout: options.keepAliveTimeout,
         },
         channelCredentials,
         options.defaultCredentials
@@ -158,7 +168,8 @@ export class Client {
       {
         endpoint: options.hosts[0],
         throwOnAppendFailure: options.throwOnAppendFailure,
-        keepAlive: options.keepAlive,
+        keepAliveInterval: options.keepAliveInterval,
+        keepAliveTimeout: options.keepAliveTimeout,
       },
       channelCredentials,
       options.defaultCredentials
@@ -183,14 +194,28 @@ export class Client {
   constructor(
     {
       throwOnAppendFailure = true,
-      keepAlive = 10_000,
+      keepAliveInterval = 10_000,
+      keepAliveTimeout = 10_000,
       ...connectionSettings
     }: ConnectionTypeOptions,
     channelCredentials: ChannelCredentialOptions = { insecure: false },
     defaultUserCredentials?: Credentials
   ) {
+    if (keepAliveInterval < -1) {
+      throw new Error(
+        `Invalid keepAliveInterval "${keepAliveInterval}". Please provide a positive integer, or -1 to disable.`
+      );
+    }
+
+    if (keepAliveTimeout < -1) {
+      throw new Error(
+        `Invalid keepAliveTimeout "${keepAliveTimeout}". Please provide a positive integer, or -1 to disable.`
+      );
+    }
+
     this.#throwOnAppendFailure = throwOnAppendFailure;
-    this.#keepAlive = keepAlive;
+    this.#keepAliveInterval = keepAliveInterval;
+    this.#keepAliveTimeout = keepAliveTimeout;
     this.#connectionSettings = connectionSettings;
     this.#insecure = !!channelCredentials.insecure;
     this.#defaultCredentials = defaultUserCredentials;
@@ -266,15 +291,14 @@ export class Client {
       uri
     );
 
-    return new Channel(
-      uri,
-      this.#channelCredentials,
-      this.#keepAlive && this.#keepAlive > 0
-        ? {
-            "grpc.keepalive_time_ms": this.#keepAlive,
-          }
-        : {}
-    );
+    return new Channel(uri, this.#channelCredentials, {
+      "grpc.keepalive_time_ms":
+        this.#keepAliveInterval < 0
+          ? Number.MAX_VALUE
+          : this.#keepAliveInterval,
+      "grpc.keepalive_timeout_ms":
+        this.#keepAliveTimeout < 0 ? Number.MAX_VALUE : this.#keepAliveTimeout,
+    });
   };
 
   private resolveUri = async (): Promise<string> => {

src/Client/parseConnectionString.ts

@@ -12,7 +12,8 @@ const lowerToKey: Record<string, keyof ConnectionOptions> = {
   tls: "tls",
   tlsverifycert: "tlsVerifyCert",
   throwonappendfailure: "throwOnAppendFailure",
-  keepalive: "keepAlive",
+  keepaliveinterval: "keepAliveInterval",
+  keepalivetimeout: "keepAliveTimeout",
 };
 
 export interface ConnectionOptions {
@@ -24,7 +25,9 @@ export interface ConnectionOptions {
   tls: boolean;
   tlsVerifyCert: boolean;
   throwOnAppendFailure: boolean;
-  keepAlive?: number;
+  keepAliveInterval: number;
+  keepAliveTimeout: number;
+
   defaultCredentials?: Credentials;
   hosts: EndPoint[];
 }
@@ -37,6 +40,8 @@ const defaultConnectionOptions: ConnectionOptions = {
   nodePreference: "random",
   tls: true,
   tlsVerifyCert: true,
+  keepAliveInterval: 10_000,
+  keepAliveTimeout: 10_000,
   throwOnAppendFailure: true,
   hosts: [],
 };
@@ -255,7 +260,8 @@ const verifyKeyValuePair = (
     case "maxDiscoverAttempts":
     case "discoveryInterval":
     case "gossipTimeout":
-    case "keepAlive": {
+    case "keepAliveInterval":
+    case "keepAliveTimeout": {
       const parsedValue = parseInt(value);
 
       if (Number.isNaN(parsedValue)) {

src/__test__/connection/__snapshots__/parseConnectionString.test.ts.snap

@@ -8,7 +8,7 @@ exports[`connection string parser Should throw on invalid strings esdb://host1;h
 
 exports[`connection string parser Should throw on invalid strings esdb://localhost/&tlsVerifyCert=false 1`] = `"Unexpected \\"&\\" at position 17, expected ?key=value."`;
 
-exports[`connection string parser Should throw on invalid strings esdb://localhost?keepAlive=please 1`] = `"Unexpected \\"please\\" at position 27, expected Integer."`;
+exports[`connection string parser Should throw on invalid strings esdb://localhost?keepAliveTimeout=please 1`] = `"Unexpected \\"please\\" at position 34, expected Integer."`;
 
 exports[`connection string parser Should throw on invalid strings esdb://localhost?throwOnAppendFailure=sometimes 1`] = `"Unexpected \\"sometimes\\" at position 38, expected true or false."`;