test-listen's Introduction

Warning test-listen is deprecated. Please use async-listen instead.

test-listen

URLs with ephemeral ports. async/await ready.

Usage

Install it:

npm install --save-dev test-listen

Pass a http.Server to test-listen and it will return an URL in the format http://localhost:{port}.

The second parameter can optionally be a hostname to return in the URL instead of localhost.

Useful for running HTTP server testsuites:

const http = require('http')
const listen = require('test-listen')

const srv = http.createServer((req, res) => res.end('1'))
const srv2 = http.createServer((req, res) => res.end('2'))

test('urls', async t => {
  let url = await listen(srv)
  t.ok(url == 'http://localhost:11401')
  let url = await listen(srv2)
  t.ok(url == 'http://localhost:42333')
})

It also works with Express:

const http = require('http')
const express = require('express')
const listen = require('test-listen')

const srv = express()

test('urls', async t => {
  let url = await listen(http.createServer(srv))
  t.ok(url == 'http://localhost:11401')
})

Or Koa:

const http = require('http')
const Koa = require('koa')
const listen = require('test-listen')

const srv = new Koa();

test('urls', async t => {
  let url = await listen(http.createServer(srv.callback()))
  t.ok(url == 'http://localhost:11401')
})

Authors

Guillermo Rauch (@rauchg) - Vercel
Leo Lamprecht (@notquiteleo) - Vercel

test-listen's People

Contributors

Stargazers

Watchers

test-listen's Issues

Server is not closed properly with Jest

When used with Jest, it keeps complaining about keeping the server alive.

A worker process has failed to exit gracefully and has been force exited. This is likely caused by tests leaking due to improper teardown. Try running with --runInBand --detectOpenHandles to find leaks.

Jest did not exit one second after the test run has completed.

This usually means that there are asynchronous operations that weren't stopped in your tests. Consider running Jest with `--detectOpenHandles` to troubleshoot this issue.

jest --runInBand --detectOpenHandles

Jest has detected the following 1 open handle potentially keeping Jest from exiting:

  ●  TCPSERVERWRAP

      29 |     };
      30 |     server = http.createServer(requestHandler);
    > 31 |     url = await listen(server);
         |                 ^
      32 |   });
      33 | 
at Promise (node_modules/test-listen/index.js:4:7)
      at module.exports (node_modules/test-listen/index.js:1:51)
      at Object.<anonymous> (pages/api/status/__tests__/status.test.ts:31:17)

this is my code

beforeAll(async () => {
    server = http.createServer(requestHandler);
    url = await listen(server);
});

afterAll((done: () => void) => {
    server.close(done);
  });

any idea why it's not closing the server?