feat: handling connections draining before closing socket

* Related #9

[ci skip]

Author: tegefaulkes

src/QUICClient.ts

@@ -91,7 +91,7 @@ class QUICClient extends EventTarget {
     const {
       p: errorP,
       rejectP: rejectErrorP
-    } = utils.promise();
+    } = utils.promise<never>();
     const handleQUICSocketError = (e: events.QUICSocketErrorEvent) => {
       rejectErrorP(e.detail);
     };
@@ -174,10 +174,24 @@ class QUICClient extends EventTarget {
     try {
       await Promise.race([connection.establishedP, errorP]);
     } catch (e) {
+      logger.error(e.toString());
+      // console.error(e);
+      logger.debug(`Is shared?: ${isSocketShared}`);
+      // Waiting for connection to destroy
+      const destroyedProm = utils.promise<void>();
+      connection.addEventListener('destroy', ()=> {
+          destroyedProm.resolveP();
+        },
+        {
+          once: true,
+        },
+      )
+      await destroyedProm.p;
       if (!isSocketShared) {
         // Stop our own socket
         await socket.stop();
       }
+      // Wrapping error to contain both stack traces
       throw e;
     }
 

src/QUICConnection.ts

@@ -251,7 +251,7 @@ class QUICConnection extends EventTarget {
   }
 
   /**
-   * This provides the ability to destroy with a specific error
+   * This provides the ability to destroy with a specific error. This will wait for the connection to fully drain.
    */
   public async destroy(
     {
@@ -289,7 +289,7 @@ class QUICConnection extends EventTarget {
       }
     }
     // If it is not closed, it could still be draining
-    if (!this.conn.isClosed()) {
+    if (this.conn.isDraining()) {
       // The `recv`, `send`, `timeout`, and `on_timeout` should continue to be called
       const { p: closeP, resolveP: resolveCloseP } = utils.promise();
       this.resolveCloseP = resolveCloseP;
@@ -300,6 +300,11 @@ class QUICConnection extends EventTarget {
     }
     this.connectionMap.delete(this.connectionId);
     this.dispatchEvent(new events.QUICConnectionDestroyEvent());
+    // Clean up timeout
+    if (this.timer != null) {
+      clearTimeout(this.timer);
+      delete this.timer;
+    }
     this.logger.info(`Destroyed ${this.constructor.name}`);
   }
 
@@ -339,6 +344,9 @@ class QUICConnection extends EventTarget {
         this.logger.debug(`Did a recv ${data.byteLength}`);
         this.conn.recv(data, recvInfo);
       } catch (e) {
+        this.logger.error(e.toString());
+        // console.error(e);
+        // console.log(this.conn.isClosed());
         // Depending on the exception, the `this.conn.recv`
         // may have automatically started closing the connection
         this.dispatchEvent(
@@ -427,13 +435,12 @@ class QUICConnection extends EventTarget {
 
     try {
       if (this.conn.isClosed()) {
-
-
         if (this.resolveCloseP != null) this.resolveCloseP();
         return;
-      } else if (this.conn.isDraining()) {
-        return;
       }
+      // else if (this.conn.isDraining()) {
+      //   return;
+      // }
       const sendBuffer = new Uint8Array(quiche.MAX_DATAGRAM_SIZE);
       let sendLength: number;
       let sendInfo: SendInfo;
@@ -481,7 +488,7 @@ class QUICConnection extends EventTarget {
             sendInfo.to.host
           );
         } catch (e) {
-          console.error(e);
+          this.logger.error(e.toString())
           this.dispatchEvent(new events.QUICConnectionErrorEvent({ detail: e }));
           return;
         }
@@ -491,11 +498,12 @@ class QUICConnection extends EventTarget {
       this.logger.debug('SEND FINALLY');
 
       this.setTimeout();
+      this.logger.debug(`connection is closed?: ${this.conn.isClosed()}`)
+      this.logger.debug(`connection is draining?: ${this.conn.isDraining()}`)
       if (
         this[status] !== 'destroying' &&
         (this.conn.isClosed() || this.conn.isDraining())
       ) {
-
         this.logger.debug('CALLING DESTROY');
 
         await this.destroy();

src/config.ts

@@ -15,6 +15,7 @@ export type TlsConfig = {
 
 type QUICConfig = {
   tlsConfig: TlsConfig | undefined;
+  verifyFromPemFile: string | undefined;
   supportedPrivateKeyAlgos: string | undefined;
   verifyPeer: boolean;
   logKeys: string | undefined;
@@ -34,9 +35,10 @@ type QUICConfig = {
 
 const clientDefault: QUICConfig = {
   tlsConfig: undefined,
+  verifyFromPemFile: undefined,
   supportedPrivateKeyAlgos: supportedPrivateKeyAlgosDefault,
   logKeys: undefined,
-  verifyPeer: false,
+  verifyPeer: true,
   grease: true,
   maxIdleTimeout: 5000,
   maxRecvUdpPayloadSize: quiche.MAX_DATAGRAM_SIZE,
@@ -59,6 +61,7 @@ const clientDefault: QUICConfig = {
 
 const serverDefault: QUICConfig = {
   tlsConfig: undefined,
+  verifyFromPemFile: undefined,
   supportedPrivateKeyAlgos: supportedPrivateKeyAlgosDefault,
   logKeys: undefined,
   verifyPeer: false,
@@ -102,6 +105,9 @@ function buildQuicheConfig(config: QUICConfig): QuicheConfig {
       quicheConfig.loadPrivKeyFromPemFile(config.tlsConfig.privKeyFromPemFile);
     }
   }
+  if (config.verifyFromPemFile != null) {
+    quicheConfig.loadVerifyLocationsFromFile(config.verifyFromPemFile);
+  }
   if (config.logKeys != null) {
     quicheConfig.logKeys();
   }