@prairielearn/express-test-utils 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import * as express from 'express';
+import { Server } from 'node:http';
+export interface WithServerContext {
+    server: Server;
+    port: number;
+    url: string;
+}
+export declare function withServer(app: express.Express, fn: (ctx: WithServerContext) => Promise<void>): Promise<void>;

package/dist/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withServer = void 0;
+async function withServer(app, fn) {
+    const server = app.listen();
+    await new Promise((resolve, reject) => {
+        server.on('listening', () => resolve());
+        server.on('error', (err) => reject(err));
+    });
+    try {
+        await fn({
+            server,
+            port: getServerPort(server),
+            url: `http://localhost:${getServerPort(server)}`,
+        });
+    }
+    finally {
+        server.close();
+    }
+}
+exports.withServer = withServer;
+function getServerPort(server) {
+    const address = server.address();
+    // istanbul ignore next
+    if (!address)
+        throw new Error('Server is not listening');
+    // istanbul ignore next
+    if (typeof address === 'string')
+        throw new Error('Server is listening on a pipe');
+    return address.port;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASO,KAAK,UAAU,UAAU,CAC9B,GAAoB,EACpB,EAA6C;IAE7C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;IAE5B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI;QACF,MAAM,EAAE,CAAC;YACP,MAAM;YACN,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;YAC3B,GAAG,EAAE,oBAAoB,aAAa,CAAC,MAAM,CAAC,EAAE;SACjD,CAAC,CAAC;KACJ;YAAS;QACR,MAAM,CAAC,KAAK,EAAE,CAAC;KAChB;AACH,CAAC;AApBD,gCAoBC;AAED,SAAS,aAAa,CAAC,MAAc;IACnC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAEjC,uBAAuB;IACvB,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEzD,uBAAuB;IACvB,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAElF,OAAO,OAAO,CAAC,IAAI,CAAC;AACtB,CAAC"}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@prairielearn/express-test-utils",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PrairieLearn/PrairieLearn.git",
+    "directory": "packages/express-test-utils"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput"
+  },
+  "dependencies": {
+    "@types/express": "^4.17.20"
+  }
+}

package/src/index.ts

@@ -0,0 +1,42 @@
+import * as express from 'express';
+import { Server } from 'node:http';
+
+export interface WithServerContext {
+  server: Server;
+  port: number;
+  url: string;
+}
+
+export async function withServer(
+  app: express.Express,
+  fn: (ctx: WithServerContext) => Promise<void>,
+) {
+  const server = app.listen();
+
+  await new Promise<void>((resolve, reject) => {
+    server.on('listening', () => resolve());
+    server.on('error', (err) => reject(err));
+  });
+
+  try {
+    await fn({
+      server,
+      port: getServerPort(server),
+      url: `http://localhost:${getServerPort(server)}`,
+    });
+  } finally {
+    server.close();
+  }
+}
+
+function getServerPort(server: Server): number {
+  const address = server.address();
+
+  // istanbul ignore next
+  if (!address) throw new Error('Server is not listening');
+
+  // istanbul ignore next
+  if (typeof address === 'string') throw new Error('Server is listening on a pipe');
+
+  return address.port;
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@prairielearn/tsconfig/tsconfig.package.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["node"]
+  },
+  "ts-node": {
+    "transpileOnly": true
+  }
+}