From 67925bb9145825c719c956d567ef3b2007a5eaea Mon Sep 17 00:00:00 2001
From: Benjamin Gruenbaum <benjamingr@gmail.com>
Date: Thu, 29 Jun 2023 10:45:44 +0300
Subject: [PATCH] test: add Symbol.dispose support to mock timers

PR-URL: https://github.com/nodejs/node/pull/48549
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
---
 doc/api/test.md                              |  4 ++++
 lib/internal/test_runner/mock/mock_timers.js |  5 +++++
 test/parallel/test-runner-mock-timers.js     | 15 +++++++++++++++
 3 files changed, 24 insertions(+)

diff --git a/doc/api/test.md b/doc/api/test.md
index c45eb183caabd7..a4936c0b72c35e 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1587,6 +1587,10 @@ const { mock } = require('node:test');
 mock.timers.reset();
 ```
 
+### `timers[Symbol.dispose]()`
+
+Calls `timers.reset()`.
+
 ### `timers.tick(milliseconds)`
 
 <!-- YAML
diff --git a/lib/internal/test_runner/mock/mock_timers.js b/lib/internal/test_runner/mock/mock_timers.js
index 32ee71d8bb2ff0..dc75bcd4afbee5 100644
--- a/lib/internal/test_runner/mock/mock_timers.js
+++ b/lib/internal/test_runner/mock/mock_timers.js
@@ -12,6 +12,7 @@ const {
   FunctionPrototypeBind,
   Promise,
   SymbolAsyncIterator,
+  SymbolDispose,
   globalThis,
 } = primordials;
 const {
@@ -315,6 +316,10 @@ class MockTimers {
     this.#toggleEnableTimers(true);
   }
 
+  [SymbolDispose]() {
+    this.reset();
+  }
+
   reset() {
     // Ignore if not enabled
     if (!this.#isEnabled) return;
diff --git a/test/parallel/test-runner-mock-timers.js b/test/parallel/test-runner-mock-timers.js
index 150883f52237e0..883dd9d08ad752 100644
--- a/test/parallel/test-runner-mock-timers.js
+++ b/test/parallel/test-runner-mock-timers.js
@@ -61,6 +61,21 @@ describe('Mock Timers Test Suite', () => {
       assert.strictEqual(fn.mock.callCount(), 0);
     });
 
+    it('should reset all timers when calling Symbol.dispose', (t) => {
+      t.mock.timers.enable();
+      const fn = t.mock.fn();
+      global.setTimeout(fn, 1000);
+      // TODO(benjamingr) refactor to `using`
+      t.mock.timers[Symbol.dispose]();
+      assert.throws(() => {
+        t.mock.timers.tick(1000);
+      }, {
+        code: 'ERR_INVALID_STATE',
+      });
+
+      assert.strictEqual(fn.mock.callCount(), 0);
+    });
+
     it('should execute in order if timeout is the same', (t) => {
       t.mock.timers.enable();
       const order = [];