test: use tsx for TypeScript test execution

Author: theorderingmachine

.github/maintainers_guide.md

@@ -21,7 +21,7 @@ Test code should be written in syntax that runs on the oldest supported Node.js
 
 #### Debugging
 
-A useful trick for debugging inside tests is to use the Chrome Debugging Protocol feature of Node.js to set breakpoints and interactively debug. In order to do this you should have already linted the source (`npm run lint`), manually. You can then run a specific test file with Node.js's test runner, for example: `node --inspect-brk --require ts-node/register --require source-map-support/register --test test/unit/{test-name}.spec.ts` (replace `{test-name}` with an actual test file path).
+A useful trick for debugging inside tests is to use the Chrome Debugging Protocol feature of Node.js to set breakpoints and interactively debug. In order to do this you should have already linted the source (`npm run lint`), manually. You can then run a specific test file with Node.js's test runner, for example: `node --inspect-brk --import tsx --test test/unit/{test-name}.spec.ts` (replace `{test-name}` with an actual test file path).
 
 #### Local Development
 

.vscode/launch.json

@@ -12,18 +12,15 @@
       "stopOnEntry": false,
       "args": [
         "--inspect-brk",
-        "--require",
-        "ts-node/register",
-        "--require",
-        "source-map-support/register",
+        "--import",
+        "tsx",
         "--test",
         "test/unit/**/*.spec.ts"
       ],
       "cwd": "${workspaceFolder}",
       "env": {
         "NODE_ENV": "testing",
-        "TS_NODE_FILES": "true",
-        "TS_NODE_PROJECT": "tsconfig.test.json"
+        "TSX_TSCONFIG_PATH": "tsconfig.test.json"
       },
       "skipFiles": ["<node_internals>/**"]
     }

package.json

@@ -32,8 +32,8 @@
     "lint": "npx @biomejs/biome check docs src test examples",
     "lint:fix": "npx @biomejs/biome check --write docs src test examples",
     "test": "npm run build && npm run lint && npm run test:types && npm run test:coverage",
-    "test:unit": "TS_NODE_PROJECT=tsconfig.test.json TS_NODE_FILES=true node --require ts-node/register --require source-map-support/register --test test/unit/**/*.spec.ts",
-    "test:coverage": "TS_NODE_PROJECT=tsconfig.test.json TS_NODE_FILES=true node --experimental-test-coverage --require ts-node/register --require source-map-support/register --test test/unit/**/*.spec.ts",
+    "test:unit": "TSX_TSCONFIG_PATH=tsconfig.test.json tsx --test test/unit/**/*.spec.ts",
+    "test:coverage": "TSX_TSCONFIG_PATH=tsconfig.test.json node --experimental-test-coverage --import tsx --test test/unit/**/*.spec.ts",
     "test:types": "tsd --files test/types",
     "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build"
   },
@@ -68,9 +68,8 @@
     "proxyquire": "^2.1.3",
     "shx": "^0.3.2",
     "sinon": "^20.0.0",
-    "source-map-support": "^0.5.12",
-    "ts-node": "^10.9.2",
     "tsd": "^0.31.2",
+    "tsx": "^4.20.6",
     "typescript": "5.3.3"
   },
   "peerDependencies": {

test/unit/.mocharc.json

@@ -19,7 +19,6 @@ import ExpressReceiver, {
   verifySignatureAndParseRawBody,
   buildBodyParserMiddleware,
 } from '../../../src/receivers/ExpressReceiver';
-import * as httpFunc from '../../../src/receivers/HTTPModuleFunctions';
 import type { ReceiverEvent } from '../../../src/types';
 import {
   FakeServer,
@@ -30,7 +29,7 @@ import {
   withHttpCreateServer,
   withHttpsCreateServer,
 } from '../helpers';
-import { afterEach, beforeEach, after, describe, it } from 'node:test';
+import { afterEach, beforeEach, describe, it } from 'node:test';
 
 // Loading the system under test using overrides
 function importExpressReceiver(
@@ -318,32 +317,38 @@ describe('ExpressReceiver', () => {
   });
 
   describe('#requestHandler()', () => {
-    const extractRetryNumStub = sinon.stub(httpFunc, 'extractRetryNumFromHTTPRequest');
-    const extractRetryReasonStub = sinon.stub(httpFunc, 'extractRetryReasonFromHTTPRequest');
-    const buildNoBodyResponseStub = sinon.stub(httpFunc, 'buildNoBodyResponse');
-    const buildContentResponseStub = sinon.stub(httpFunc, 'buildContentResponse');
+    let extractRetryNumStub: sinon.SinonStub;
+    let extractRetryReasonStub: sinon.SinonStub;
+    let buildNoBodyResponseStub: sinon.SinonStub;
+    let buildContentResponseStub: sinon.SinonStub;
     const processStub = sinon.stub<[ReceiverEvent]>().resolves({});
     const ackStub = function ackStub() {};
     ackStub.prototype.bind = function () {
       return this;
     };
     ackStub.prototype.ack = sinon.spy();
     beforeEach(() => {
+      extractRetryNumStub = sinon.stub().returns(undefined);
+      extractRetryReasonStub = sinon.stub().returns(undefined);
+      buildNoBodyResponseStub = sinon.stub().returns(undefined);
+      buildContentResponseStub = sinon.stub().returns(undefined);
       overrides = mergeOverrides(
         withHttpCreateServer(fakeCreateServer),
         withHttpsCreateServer(sinon.fake.throws('Should not be used.')),
         { './HTTPResponseAck': { HTTPResponseAck: ackStub } },
+        {
+          './HTTPModuleFunctions': {
+            extractRetryNumFromHTTPRequest: extractRetryNumStub,
+            extractRetryReasonFromHTTPRequest: extractRetryReasonStub,
+            buildNoBodyResponse: buildNoBodyResponseStub,
+            buildContentResponse: buildContentResponseStub,
+          },
+        },
       );
     });
     afterEach(() => {
       sinon.reset();
     });
-    after(() => {
-      extractRetryNumStub.restore();
-      extractRetryReasonStub.restore();
-      buildNoBodyResponseStub.restore();
-      buildContentResponseStub.restore();
-    });
     it('should not build an HTTP response if processBeforeResponse=false', async () => {
       const ER = importExpressReceiver(overrides);
       const receiver = new ER({ signingSecret: '' });

test/unit/receivers/ExpressReceiver.spec.ts

@@ -1,14 +1,19 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
+import path from 'node:path';
 import assert from 'node:assert/strict';
 import sinon from 'sinon';
 import { expectType } from 'tsd';
 import { ReceiverMultipleAckError } from '../../../src/errors';
-import * as HTTPModuleFunctions from '../../../src/receivers/HTTPModuleFunctions';
 import { HTTPResponseAck } from '../../../src/receivers/HTTPResponseAck';
 import type { ResponseAck } from '../../../src/types';
-import { createFakeLogger } from '../helpers';
+import { createFakeLogger, proxyquire } from '../helpers';
 import { afterEach, beforeEach, describe, it } from 'node:test';
 
+function importHTTPResponseAck(overrides = {}): typeof import('../../../src/receivers/HTTPResponseAck') {
+  const absolutePath = path.resolve(__dirname, '../../../src/receivers/HTTPResponseAck');
+  return proxyquire(absolutePath, overrides);
+}
+
 describe('HTTPResponseAck', async () => {
   let setTimeoutSpy: sinon.SinonSpy;
 
@@ -129,10 +134,15 @@ describe('HTTPResponseAck', async () => {
     assert.equal(responseAck.storedResponse, '', 'Falsy body passed to bound handler not stored as empty string in Ack instance.');
   });
   it('should call buildContentResponse with response body if processBeforeResponse=false', async () => {
-    const stub = sinon.stub(HTTPModuleFunctions, 'buildContentResponse');
+    const stub = sinon.stub();
+    const { HTTPResponseAck: HTTPResponseAckWithStub } = importHTTPResponseAck({
+      './HTTPModuleFunctions': {
+        buildContentResponse: stub,
+      },
+    });
     const httpRequest = sinon.createStubInstance(IncomingMessage) as IncomingMessage;
     const httpResponse: ServerResponse = sinon.createStubInstance(ServerResponse) as unknown as ServerResponse;
-    const responseAck = new HTTPResponseAck({
+    const responseAck = new HTTPResponseAckWithStub({
       logger: createFakeLogger(),
       processBeforeResponse: false,
       httpRequest,