.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+{
+  "name": "docker",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-20",
+  "containerEnv": {
+    "SHELL": "/bin/zsh"
+  }
+}

etc/test-helpers.api.md

@@ -4,10 +4,8 @@
 
 ```ts
 
-/// <reference types="jest" />
-
 import { IConfigComponent } from '@well-known-components/interfaces';
-import { IFetchComponent } from '@well-known-components/http-server';
+import { IFetchComponent } from '@well-known-components/interfaces';
 import { Lifecycle } from '@well-known-components/interfaces';
 import { default as sinon_2 } from 'sinon';
 

jest.config.js

@@ -1,13 +1,8 @@
 module.exports = {
-  globals: {
-    'ts-jest': {
-      tsconfig: 'tsconfig.json'
-    }
-  },
-  moduleFileExtensions: ['ts', 'js'],
   transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest'
+    "^.+\\.(ts|tsx)$": ["ts-jest", {tsconfig: "test/tsconfig.json"}]
   },
+  moduleFileExtensions: ['ts', 'js'],
   testMatch: ['**/*.spec.(ts)'],
   testEnvironment: 'node'
-}
+}

package.json

@@ -17,21 +17,26 @@
   },
   "prettier": {
     "printWidth": 120,
-    "semi": false
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "tabWidth": 2
   },
   "homepage": "https://github.com/well-known-components/test-helpers#readme",
   "devDependencies": {
     "@microsoft/api-extractor": "^7.36.0",
-    "@well-known-components/http-server": "^2.0.0",
+    "@well-known-components/http-server": "^2.1.0",
     "@well-known-components/interfaces": "^1.4.2",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.5"
+    "typescript": "^5.6.2"
   },
   "dependencies": {
     "@types/jest": "^29.5.2",
+    "@types/node": "^22.5.4",
     "@types/sinon": "^17.0.1",
     "jest": "^29.5.0",
-    "sinon": "^17.0.0",
+    "node-fetch": "2.x",
+    "sinon": "^18.0.0",
     "ts-jest": "^29.1.0"
   },
   "files": [

src/index.ts

@@ -44,8 +44,8 @@ if (!_beforeAll || !_afterAll) {
  */
 export type SpiedInstance<TType extends {}> = {
   [P in keyof TType]: Required<TType>[P] extends (...args: any[]) => any
-    ? jest.SpyInstance<ReturnType<Required<TType>[P]>, jest.ArgsType<Required<TType>[P]>>
-    : never
+  ? jest.SpyInstance<ReturnType<Required<TType>[P]>, jest.ArgsType<Required<TType>[P]>>
+  : never
 }
 
 /**
@@ -58,7 +58,7 @@ export function createRunner<TestComponents extends Record<string, any>>(
 ) {
   return (name: string, suite: (testArgs: TestArguments<TestComponents>) => void) => {
     let program: Lifecycle.ComponentBasedProgram<TestComponents>
-    let sandbox: sinon.SinonSandbox
+    let sandbox: sinon.SinonSandbox | null = null
     const stubComponentInstances = new Map<keyof TestComponents, sinon.SinonStubbedInstance<any>>()
     const spyComponentInstances = new Map<keyof TestComponents, SpiedInstance<any>>()
 
@@ -146,7 +146,7 @@ export function createRunner<TestComponents extends Record<string, any>>(
       })
 
       afterEach(() => {
-        sandbox.restore()
+        sandbox?.restore()
         jest.restoreAllMocks()
       })
 

src/localFetch.ts

@@ -1,11 +1,11 @@
-import nodeFetch, { RequestInfo, RequestInit } from "node-fetch"
+import nodeFetch, { RequestInfo, RequestInit } from 'node-fetch'
+import * as http from 'http'
 
-import { IFetchComponent } from "@well-known-components/http-server"
-import { IConfigComponent } from "@well-known-components/interfaces"
+import { IFetchComponent, IConfigComponent } from '@well-known-components/interfaces'
 
 // start TCP port for listeners
 /* istanbul ignore next */
-let lastUsedPort = 19000 + parseInt(process.env.JEST_WORKER_ID || "1") * 1000
+let lastUsedPort = 19000 + parseInt(process.env.JEST_WORKER_ID || '1') * 1000
 
 function getPort() {
   lastUsedPort += 1
@@ -15,7 +15,7 @@ function getPort() {
 /**
  * Default Server config
  * @public
-**/
+ **/
 export const defaultServerConfig = () => ({
   HTTP_SERVER_HOST: '0.0.0.0',
   HTTP_SERVER_PORT: String(getPort())
@@ -24,22 +24,22 @@ export const defaultServerConfig = () => ({
 /**
  * Local Fetch component for testing local urls
  * @public
-**/
-export async function createLocalFetchCompoment(
-  configComponent: IConfigComponent
-): Promise<IFetchComponent> {
+ **/
+export async function createLocalFetchCompoment(configComponent: IConfigComponent): Promise<IFetchComponent> {
   const protocolHostAndProtocol = `http://${await configComponent.requireString(
-    "HTTP_SERVER_HOST"
-  )}:${await configComponent.requireNumber("HTTP_SERVER_PORT")}`
+    'HTTP_SERVER_HOST'
+  )}:${await configComponent.requireNumber('HTTP_SERVER_PORT')}`
+
+  const agent = new http.Agent({ keepAlive: false })
   // test fetch, to hit our local server
   const localFetch: IFetchComponent = {
     async fetch(url: RequestInfo, initRequest?: RequestInit) {
-      if (typeof url == "string" && url.startsWith("/")) {
-        return nodeFetch(protocolHostAndProtocol + url, { ...initRequest })
+      if (typeof url == 'string' && url.startsWith('/')) {
+        return nodeFetch(protocolHostAndProtocol + url, { agent, ...initRequest })
       } else {
-        throw new Error("localFetch only works for local testing-URLs")
+        throw new Error('localFetch only works for local testing-URLs')
       }
-    },
+    }
   }
   return localFetch
 }

test/simple-smoke-test/localFetch.spec.ts

@@ -1,33 +1,33 @@
-import { createServerComponent, IFetchComponent, Router } from "@well-known-components/http-server"
-import { IHttpServerComponent } from "@well-known-components/interfaces"
+import { createServerComponent, Router } from '@well-known-components/http-server'
+import { IHttpServerComponent, IFetchComponent } from '@well-known-components/interfaces'
 
-import expect from "expect"
-import { createRunner } from "../../src"
-import { createLocalFetchCompoment, defaultServerConfig } from "../../src/localFetch"
+import expect from 'expect'
+import { createRunner } from '../../src'
+import { createLocalFetchCompoment, defaultServerConfig } from '../../src/localFetch'
 
 type Components = {
-  fetch: IFetchComponent,
+  fetch: IFetchComponent
   server: IHttpServerComponent<GlobalContext>
 }
 type GlobalContext = {
   components: Components
 }
 
 const logs = {
-  getLogger: (a: string) => ({
-    log: (message: string) => {},
-    error: (error: string | Error) => {},
-    debug: (message: string) => {},
-    info: (message: string) => {},
-    warn: (message: string) => {},
+  getLogger: (_a: string) => ({
+    log: (_message: string) => {},
+    error: (_error: string | Error) => {},
+    debug: (_message: string) => {},
+    info: (_message: string) => {},
+    warn: (_message: string) => {}
   })
 }
 const configMap = defaultServerConfig()
 const config = {
   getString: async (a: string) => a,
   getNumber: async (a: string) => Number(a),
   requireNumber: async (a: keyof typeof configMap) => Number(configMap[a])!,
-  requireString: async (a: keyof typeof configMap) => configMap[a]!,
+  requireString: async (a: keyof typeof configMap) => configMap[a]!
 }
 
 const ROUTE_URL = '/some-route'
@@ -38,7 +38,7 @@ const test = createRunner<Components>({
     const router = new Router<GlobalContext>()
 
     router.get(ROUTE_URL, async (_ctx) => {
-     return { status: 200, body: RESPONSE }
+      return { status: 200, body: RESPONSE }
     })
 
     components.server.use(router.allowedMethods())
@@ -53,18 +53,18 @@ const test = createRunner<Components>({
       fetch: await createLocalFetchCompoment(config),
       server: await createServerComponent<GlobalContext>({ config, logs }, {})
     }
-  },
+  }
 })
 
-test("test local fetch component", ({ components, stubComponents }) => {
-  it("should return response json", async () => {
+test('test local fetch component', ({ components, stubComponents }) => {
+  it('should return response json', async () => {
     const { fetch } = components
     const response = await (await fetch.fetch(ROUTE_URL)).json()
 
     expect(response).toStrictEqual(RESPONSE)
   })
 
-  it("sould fail if its an external url", async () => {
+  it('sould fail if its an external url', async () => {
     const { fetch } = components
     try {
       await fetch.fetch('https://some-route.com')