fix: updating config defaults

[ci skip]

Author: tegefaulkes

src/QUICClient.ts

@@ -16,7 +16,7 @@ import { quiche } from './native';
 import * as utils from './utils';
 import * as errors from './errors';
 import * as events from './events';
-import { clientDefault } from './config';
+import { clientDefault, minIdleTimeout } from './config';
 import QUICSocket from './QUICSocket';
 import QUICConnection from './QUICConnection';
 import QUICConnectionId from './QUICConnectionId';
@@ -87,7 +87,7 @@ class QUICClient extends EventTarget {
     },
     ctx?: Partial<ContextTimedInput>,
   ): PromiseCancellable<QUICClient>;
-  @timedCancellable(true, Infinity, errors.ErrorQUICClientCreateTimeOut)
+  @timedCancellable(true, minIdleTimeout, errors.ErrorQUICClientCreateTimeOut)
   public static async createQUICClient(
     {
       host,

src/QUICConnection.ts

@@ -26,7 +26,7 @@ import { Timer } from '@matrixai/timer';
 import { context, timedCancellable } from '@matrixai/contexts/dist/decorators';
 import { withF } from '@matrixai/resources';
 import { utils as contextsUtils } from '@matrixai/contexts';
-import { buildQuicheConfig } from './config';
+import { buildQuicheConfig, minIdleTimeout } from './config';
 import QUICStream from './QUICStream';
 import { quiche } from './native';
 import * as events from './events';
@@ -237,7 +237,11 @@ class QUICConnection extends EventTarget {
         },
     ctx?: Partial<ContextTimedInput>,
   ): PromiseCancellable<QUICConnection>;
-  @timedCancellable(true, Infinity, errors.ErrorQUICConnectionStartTimeOut)
+  @timedCancellable(
+    true,
+    minIdleTimeout,
+    errors.ErrorQUICConnectionStartTimeOut,
+  )
   public static async createQUICConnection(
     args:
       | {

src/QUICServer.ts

@@ -53,7 +53,7 @@ class QUICServer extends EventTarget {
   protected codeToReason: StreamCodeToReason | undefined;
   protected verifyCallback: VerifyCallback | undefined;
   protected connectionMap: QUICConnectionMap;
-  protected connectTimeoutTime: number;
+  protected minIdleTimeout: number | undefined;
   // Used to track address string for logging ONLY
   protected address: string;
 
@@ -110,7 +110,7 @@ class QUICServer extends EventTarget {
     reasonToCode,
     codeToReason,
     verifyCallback,
-    connectTimeoutTime = 15000,
+    minIdleTimeout,
     logger,
   }: {
     crypto: {
@@ -126,7 +126,7 @@ class QUICServer extends EventTarget {
     reasonToCode?: StreamReasonToCode;
     codeToReason?: StreamCodeToReason;
     verifyCallback?: VerifyCallback;
-    connectTimeoutTime?: number;
+    minIdleTimeout?: number;
     logger?: Logger;
   }) {
     super();
@@ -154,7 +154,7 @@ class QUICServer extends EventTarget {
     this.reasonToCode = reasonToCode;
     this.codeToReason = codeToReason;
     this.verifyCallback = verifyCallback;
-    this.connectTimeoutTime = connectTimeoutTime;
+    this.minIdleTimeout = minIdleTimeout;
   }
 
   @ready(new errors.ErrorQUICServerNotRunning())
@@ -379,7 +379,7 @@ class QUICServer extends EventTarget {
               .slice(32)}-${clientConnRef}`,
           ),
         },
-        { timer: this.connectTimeoutTime },
+        { timer: this.minIdleTimeout },
       );
     } catch (e) {
       // Ignoring any errors here as a failure to connect

src/config.ts

@@ -23,12 +23,26 @@ const sigalgs = [
   'ed25519',
 ].join(':');
 
+/**
+ * Usually we would create separate timeouts for connecting vs idling.
+ * Unfortunately quiche only has 1 config option that controls both.
+ * And it is not possible to mutate this option after connecting.
+ * Therefore, this option is just a way to set a shorter connecting timeout
+ * compared to the idling timeout.
+ * If this is the larger than the `maxIdleTimeout` (remember that `0` is `Infinity`) for `maxIdleTimeout`, then this has no effect.
+ * This only has an effect if this is set to a number less than `maxIdleTimeout`.
+ * Thus, it is the "minimum boundary" of the timeout during connecting.
+ * While the `maxIdleTimeout` is still the "maximum boundary" during connecting.
+ */
+const minIdleTimeout = Infinity;
+
 const clientDefault: QUICConfig = {
   sigalgs,
   verifyPeer: true,
   verifyAllowFail: false,
   grease: true,
-  maxIdleTimeout: 1 * 60 * 1000,
+  keepAliveIntervalTime: undefined,
+  maxIdleTimeout: 0,
   maxRecvUdpPayloadSize: quiche.MAX_DATAGRAM_SIZE, // 65527
   maxSendUdpPayloadSize: quiche.MIN_CLIENT_INITIAL_LEN, // 1200,
   initialMaxData: 10 * 1024 * 1024,
@@ -48,7 +62,8 @@ const serverDefault: QUICConfig = {
   verifyPeer: false,
   verifyAllowFail: false,
   grease: true,
-  maxIdleTimeout: 1 * 60 * 1000,
+  keepAliveIntervalTime: undefined,
+  maxIdleTimeout: 0,
   maxRecvUdpPayloadSize: quiche.MAX_DATAGRAM_SIZE, // 65527
   maxSendUdpPayloadSize: quiche.MIN_CLIENT_INITIAL_LEN, // 1200
   initialMaxData: 10 * 1024 * 1024,
@@ -188,4 +203,4 @@ function buildQuicheConfig(config: QUICConfig): QuicheConfig {
   return quicheConfig;
 }
 
-export { clientDefault, serverDefault, buildQuicheConfig };
+export { minIdleTimeout, clientDefault, serverDefault, buildQuicheConfig };