From 71236097d0e8782988c4b26049748197d963e4f5 Mon Sep 17 00:00:00 2001
From: James M Snell <jasnell@gmail.com>
Date: Tue, 7 Jul 2020 15:08:26 -0700
Subject: [PATCH] quic: use Number() instead of bigint for QuicSocket stats

PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net>
---
 doc/api/quic.md                               | 97 ++++++++++++-------
 lib/internal/quic/core.js                     | 31 +++---
 .../test-quic-maxconnectionsperhost.js        |  2 +-
 .../test-quic-quicsocket-serverbusy.js        |  2 +-
 test/parallel/test-quic-quicsocket.js         | 33 +++----
 5 files changed, 92 insertions(+), 73 deletions(-)

diff --git a/doc/api/quic.md b/doc/api/quic.md
index c33ea1c4829399..1e71654badfffb 100644
--- a/doc/api/quic.md
+++ b/doc/api/quic.md
@@ -1319,10 +1319,7 @@ added: REPLACEME
 -->
 
 New instances of `QuicSocket` are created using the `net.createQuicSocket()`
-method.
-
-Once created, a `QuicSocket` can be configured to work as both a client and a
-server.
+method, and can be used as both a client and a server.
 
 #### Event: `'busy'`
 <!-- YAML
@@ -1477,46 +1474,60 @@ added: REPLACEME
 
 * Type: {boolean}
 
-Will be `true` if the `QuicSocket` has been successfully bound to the local UDP
-port.
+Will be `true` if the `QuicSocket` has been successfully bound to a local UDP
+port. Initially the value is `false`.
+
+`QuicSocket` instances are not bound to a local UDP port until the first time
+eithe `quicsocket.listen()` or `quicsocket.connect()` is called. The `'ready'`
+event will be emitted once the `QuicSocket` has been bound and the value of
+`quicsocket.bound` will become `true`.
+
+Read-only.
 
 #### quicsocket.boundDuration
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
 
-A `BigInt` representing the length of time this `QuicSocket` has been bound
-to a local port.
+The length of time this `QuicSocket` has been bound to a local port.
+
+Read-only.
 
 #### quicsocket.bytesReceived
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
 
-A `BigInt` representing the number of bytes received by this `QuicSocket`.
+The number of bytes received by this `QuicSocket`.
+
+Read-only.
 
 #### quicsocket.bytesSent
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of bytes sent by this `QuicSocket`.
 
-A `BigInt` representing the number of bytes sent by this `QuicSocket`.
+Read-only.
 
 #### quicsocket.clientSessions
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of client `QuicSession` instances that have been associated
+with this `QuicSocket`.
 
-A `BigInt` representing the number of client `QuicSession` instances that
-have been associated with this `QuicSocket`.
+Read-only.
 
 #### quicsocket.close(\[callback\])
 <!-- YAML
@@ -1690,9 +1701,11 @@ Will be `true` if the `QuicSocket` has been destroyed.
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The length of time this `QuicSocket` has been active,
 
-A `BigInt` representing the length of time this `QuicSocket` has been active,
+Read-only.
 
 #### quicsocket.endpoints
 <!-- YAML
@@ -1828,10 +1841,11 @@ If a `callback` is given, it is registered as a handler for the
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
 
-A `BigInt` representing the length of time this `QuicSocket` has been listening
-for connections.
+The length of time this `QuicSocket` has been listening for connections.
+
+Read-only
 
 #### quicsocket.listening
 <!-- YAML
@@ -1847,29 +1861,33 @@ Set to `true` if the `QuicSocket` is listening for new connections.
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
 
-A `BigInt` representing the number of packets received by this `QuicSocket` that
-have been ignored.
+The number of packets received by this `QuicSocket` that have been ignored.
+
+Read-only.
 
 #### quicsocket.packetsReceived
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of packets successfully received by this `QuicSocket`.
 
-A `BigInt` representing the number of packets successfully received by this
-`QuicSocket`.
+Read-only
 
 #### quicsocket.packetsSent
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of packets sent by this `QuicSocket`.
 
-A `BigInt` representing the number of packets sent by this `QuicSocket`.
+Read-only
 
 #### quicsocket.pending
 <!-- YAML
@@ -1902,20 +1920,23 @@ error code. To begin receiving connections again, disable busy mode by setting
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of `QuicSession` instances rejected due to server busy status.
 
-A `BigInt` representing the number of `QuicSession` instances rejected
-due to server busy status.
+Read-only.
 
 #### quicsocket.serverSessions
 <!-- YAML
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
 
-A `BigInt` representing the number of server `QuicSession` instances that
-have been associated with this `QuicSocket`.
+The number of server `QuicSession` instances that have been associated with
+this `QuicSocket`.
+
+Read-only.
 
 #### quicsocket.setDiagnosticPacketLoss(options)
 <!-- YAML
@@ -1939,9 +1960,11 @@ This method is *not* to be used in production applications.
 added: REPLACEME
 -->
 
-* Type: {bigint}
+* Type: {number}
+
+The number of stateless resets that have been sent.
 
-A `BigInt` that represents the number of stateless resets that have been sent.
+Read-only.
 
 #### quicsocket.toggleStatelessReset()
 <!-- YAML
diff --git a/lib/internal/quic/core.js b/lib/internal/quic/core.js
index 1edb60beed9418..1b18ec4a10e9a3 100644
--- a/lib/internal/quic/core.js
+++ b/lib/internal/quic/core.js
@@ -14,6 +14,7 @@ const {
   BigInt64Array,
   Error,
   Map,
+  Number,
   RegExp,
   Set,
   Symbol,
@@ -1527,58 +1528,58 @@ class QuicSocket extends EventEmitter {
   get duration() {
     // TODO(@jasnell): If the object is destroyed, it should
     // use a fixed duration rather than calculating from now
-    return process.hrtime.bigint() -
-      getStats(this, IDX_QUIC_SOCKET_STATS_CREATED_AT);
+    return Number(process.hrtime.bigint() -
+      getStats(this, IDX_QUIC_SOCKET_STATS_CREATED_AT));
   }
 
   get boundDuration() {
     // TODO(@jasnell): If the object is destroyed, it should
     // use a fixed duration rather than calculating from now
-    return process.hrtime.bigint() -
-      getStats(this, IDX_QUIC_SOCKET_STATS_BOUND_AT);
+    return Number(process.hrtime.bigint() -
+      getStats(this, IDX_QUIC_SOCKET_STATS_BOUND_AT));
   }
 
   get listenDuration() {
     // TODO(@jasnell): If the object is destroyed, it should
     // use a fixed duration rather than calculating from now
-    return process.hrtime.bigint() -
-      getStats(this, IDX_QUIC_SOCKET_STATS_LISTEN_AT);
+    return Number(process.hrtime.bigint() -
+      getStats(this, IDX_QUIC_SOCKET_STATS_LISTEN_AT));
   }
 
   get bytesReceived() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_BYTES_RECEIVED);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_BYTES_RECEIVED));
   }
 
   get bytesSent() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_BYTES_SENT);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_BYTES_SENT));
   }
 
   get packetsReceived() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_RECEIVED);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_RECEIVED));
   }
 
   get packetsSent() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_SENT);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_SENT));
   }
 
   get packetsIgnored() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_IGNORED);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_PACKETS_IGNORED));
   }
 
   get serverSessions() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_SERVER_SESSIONS);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_SERVER_SESSIONS));
   }
 
   get clientSessions() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_CLIENT_SESSIONS);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_CLIENT_SESSIONS));
   }
 
   get statelessResetCount() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_STATELESS_RESET_COUNT);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_STATELESS_RESET_COUNT));
   }
 
   get serverBusyCount() {
-    return getStats(this, IDX_QUIC_SOCKET_STATS_SERVER_BUSY_COUNT);
+    return Number(getStats(this, IDX_QUIC_SOCKET_STATS_SERVER_BUSY_COUNT));
   }
 
   // Diagnostic packet loss is a testing mechanism that allows simulating
diff --git a/test/parallel/test-quic-maxconnectionsperhost.js b/test/parallel/test-quic-maxconnectionsperhost.js
index b94849b88272c3..b8370766c0c661 100644
--- a/test/parallel/test-quic-maxconnectionsperhost.js
+++ b/test/parallel/test-quic-maxconnectionsperhost.js
@@ -56,7 +56,7 @@ const kALPN = 'zzz';
   server.on('session', common.mustCall(() => {}, kMaxConnectionsPerHost));
 
   server.on('close', common.mustCall(() => {
-    assert.strictEqual(server.serverBusyCount, 1n);
+    assert.strictEqual(server.serverBusyCount, 1);
   }));
 
   server.on('ready', common.mustCall(() => {
diff --git a/test/parallel/test-quic-quicsocket-serverbusy.js b/test/parallel/test-quic-quicsocket-serverbusy.js
index 35cc29d8f098b0..8354f09662d74c 100644
--- a/test/parallel/test-quic-quicsocket-serverbusy.js
+++ b/test/parallel/test-quic-quicsocket-serverbusy.js
@@ -32,7 +32,7 @@ server.on('busy', common.mustCall((busy) => {
 
 // When the server is set as busy, all connections
 // will be rejected with a SERVER_BUSY response.
-server.setServerBusy();
+server.serverBusy = true;
 server.listen();
 
 server.on('close', common.mustCall());
diff --git a/test/parallel/test-quic-quicsocket.js b/test/parallel/test-quic-quicsocket.js
index b7c11661205c87..efbce64f8fd4a1 100644
--- a/test/parallel/test-quic-quicsocket.js
+++ b/test/parallel/test-quic-quicsocket.js
@@ -31,16 +31,16 @@ assert(!socket.pending);
 // Socket is not destroyed
 assert(!socket.destroyed);
 
-assert.strictEqual(typeof socket.duration, 'bigint');
-assert.strictEqual(typeof socket.boundDuration, 'bigint');
-assert.strictEqual(typeof socket.listenDuration, 'bigint');
-assert.strictEqual(typeof socket.bytesReceived, 'bigint');
-assert.strictEqual(socket.bytesReceived, 0n);
-assert.strictEqual(socket.bytesSent, 0n);
-assert.strictEqual(socket.packetsReceived, 0n);
-assert.strictEqual(socket.packetsSent, 0n);
-assert.strictEqual(socket.serverSessions, 0n);
-assert.strictEqual(socket.clientSessions, 0n);
+assert.strictEqual(typeof socket.duration, 'number');
+assert.strictEqual(typeof socket.boundDuration, 'number');
+assert.strictEqual(typeof socket.listenDuration, 'number');
+assert.strictEqual(typeof socket.bytesReceived, 'number');
+assert.strictEqual(socket.bytesReceived, 0);
+assert.strictEqual(socket.bytesSent, 0);
+assert.strictEqual(socket.packetsReceived, 0);
+assert.strictEqual(socket.packetsSent, 0);
+assert.strictEqual(socket.serverSessions, 0);
+assert.strictEqual(socket.clientSessions, 0);
 
 const endpoint = socket.endpoints[0];
 assert(endpoint);
@@ -83,8 +83,8 @@ assert(endpoint);
   });
 });
 
-[1, 1n, [], {}, null].forEach((args) => {
-  assert.throws(() => socket.setServerBusy(args), {
+[1, 1n, [], {}, null].forEach((arg) => {
+  assert.throws(() => socket.serverBusy = arg, {
     code: 'ERR_INVALID_ARG_TYPE'
   });
 });
@@ -143,12 +143,7 @@ socket.on('close', common.mustCall(() => {
     });
   });
 
-  [
-    'setServerBusy',
-  ].forEach((op) => {
-    assert.throws(() => socket[op](), {
-      code: 'ERR_QUICSOCKET_DESTROYED',
-      message: `Cannot call ${op} after a QuicSocket has been destroyed`
-    });
+  assert.throws(() => { socket.serverBusy = true; }, {
+    code: 'ERR_QUICSOCKET_DESTROYED'
   });
 }));