dgram: socket add asyncDispose

PR-URL: #48717 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
nodejs · Sep 16, 2023 · 573eb4b · 573eb4b
1 parent f74c2fc
commit 573eb4b
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 1 deletion.
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
@@ -372,6 +372,17 @@ added: v0.1.99
 Close the underlying socket and stop listening for data on it. If a callback is
 provided, it is added as a listener for the [`'close'`][] event.
 
+### `socket[Symbol.asyncDispose]()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Calls [`socket.close()`][] and returns a promise that fulfills when the
+socket has closed.
+
 ### `socket.connect(port[, address][, callback])`
 
 <!-- YAML
@@ -988,4 +999,5 @@ and `udp6` sockets). The bound address and port can be retrieved using
 [`socket.address().address`]: #socketaddress
 [`socket.address().port`]: #socketaddress
 [`socket.bind()`]: #socketbindport-address-callback
+[`socket.close()`]: #socketclosecallback
 [byte length]: buffer.md#static-method-bufferbytelengthstring-encoding
diff --git a/lib/dgram.js b/lib/dgram.js
@@ -30,6 +30,7 @@ const {
   ObjectDefineProperty,
   ObjectSetPrototypeOf,
   ReflectApply,
+  SymbolAsyncDispose,
   SymbolDispose,
 } = primordials;
 
@@ -60,7 +61,7 @@ const {
   validatePort,
 } = require('internal/validators');
 const { Buffer } = require('buffer');
-const { deprecate } = require('internal/util');
+const { deprecate, promisify } = require('internal/util');
 const { isArrayBufferView } = require('internal/util/types');
 const EventEmitter = require('events');
 const {
@@ -753,6 +754,13 @@ Socket.prototype.close = function(callback) {
   return this;
 };
 
+Socket.prototype[SymbolAsyncDispose] = async function() {
+  if (!this[kStateSymbol].handle) {
+    return;
+  }
+  return FunctionPrototypeCall(promisify(this.close), this);
+};
+
 
 function socketCloseNT(self) {
   self.emit('close');

diff --git a/test/parallel/test-dgram-async-dispose.mjs b/test/parallel/test-dgram-async-dispose.mjs
@@ -0,0 +1,20 @@
+import * as common from '../common/index.mjs';
+import assert from 'node:assert';
+import dgram from 'node:dgram';
+import { describe, it } from 'node:test';
+
+describe('dgram.Socket[Symbol.asyncDispose]()', () => {
+  it('should close the socket', async () => {
+    const server = dgram.createSocket({ type: 'udp4' });
+    server.on('close', common.mustCall());
+    await server[Symbol.asyncDispose]().then(common.mustCall());
+
+    assert.throws(() => server.address(), { code: 'ERR_SOCKET_DGRAM_NOT_RUNNING' });
+  });
+
+  it('should resolve even if the socket is already closed', async () => {
+    const server = dgram.createSocket({ type: 'udp4' });
+    await server[Symbol.asyncDispose]().then(common.mustCall());
+    await server[Symbol.asyncDispose]().then(common.mustCall(), common.mustNotCall());
+  });
+});