Middleware testing strategies in Express

Introduction

Middleware helps handle requests in Express apps. Testing it ensures your app works right and handles errors well.

You want to check if middleware correctly modifies request or response objects.

You need to verify middleware calls next() to pass control properly.

You want to test error handling middleware to catch and respond to errors.

You want to confirm middleware runs in the right order.

You want to test authentication or logging middleware behavior.

Syntax

Express

function middleware(req, res, next) {
  // your code here
  next();
}

Middleware functions take three arguments: req, res, and next.

Call next() to pass control to the next middleware or route handler.

Examples

This middleware logs the HTTP method and URL, then passes control.

Express

function logger(req, res, next) {
  console.log(`${req.method} ${req.url}`);
  next();
}

Error-handling middleware has four arguments and sends a 500 response.

Express

function errorHandler(err, req, res, next) {
  res.status(500).send('Server error');
}

Sample Program

This example shows two middlewares: one adds a property to the request, the other checks it and sends a response. The test uses supertest to simulate a request and prints the response text.

Express

import express from 'express';
import request from 'supertest';

const app = express();

// Middleware to add a property
function addProperty(req, res, next) {
  req.custom = 'test';
  next();
}

// Middleware to check property
function checkProperty(req, res, next) {
  if (req.custom === 'test') {
    res.send('Property found');
  } else {
    res.status(400).send('Property missing');
  }
}

app.use(addProperty);
app.get('/', checkProperty);

// Test using supertest
async function runTest() {
  const response = await request(app).get('/');
  console.log(response.text);
}

runTest();

Important Notes

Use tools like supertest to simulate HTTP requests for testing middleware.

Always test that next() is called to avoid hanging requests.

Test error middleware separately by simulating errors.

Summary

Middleware testing ensures your Express app handles requests correctly.

Use simulated requests to check middleware behavior and responses.

Remember to test normal and error cases for full coverage.

Practice

1. What is the main purpose of testing middleware in an Express app?

easy

A. To verify that middleware correctly processes requests and responses

B. To check the database connection speed

C. To test the frontend user interface

D. To measure server hardware performance

Solution

1. Step 1: Understand middleware role

   Middleware functions handle requests and responses in Express apps.

2. Step 2: Identify testing focus

   Testing middleware ensures it processes requests and responses correctly.

3. Final Answer:

   To verify that middleware correctly processes requests and responses -> Option A

4. Quick Check:

   Middleware testing = request/response handling [OK]

Hint: Middleware tests check request and response flow [OK]

Common Mistakes:

• Confusing middleware testing with UI testing
• Testing unrelated server hardware
• Ignoring request and response handling

2. Which syntax correctly uses a testing library to simulate a request to Express middleware?

easy

A. request(app).get('/path').expect(200, done)

B. app.request('/path').send(200)

C. middleware.test('/path').status(200)

D. express.test(app).get('/path').check(200)

Solution

1. Step 1: Recognize common testing syntax

   Using 'request(app).get(path).expect(status, done)' is standard with supertest library.

2. Step 2: Compare options

   Only request(app).get('/path').expect(200, done) matches valid syntax for simulating requests in Express tests.

3. Final Answer:

   request(app).get('/path').expect(200, done) -> Option A

4. Quick Check:

   Simulate request = request(app).get() [OK]

Hint: Use request(app).get() to simulate Express requests [OK]

Common Mistakes:

• Using non-existent methods like app.request()
• Confusing middleware with app methods
• Incorrect chaining of test methods

3. Given this middleware test snippet, what will be the output if the middleware calls next() without error?

app.use((req, res, next) => {
  if (req.query.fail) return next(new Error('Fail'));
  res.status(200).send('Success');
});

request(app).get('/?fail=true').expect(500, done);

medium

A. The test passes with status 200

B. The test fails because status 200 is sent

C. The test throws a syntax error

D. The test passes because error triggers 500 status

Solution

1. Step 1: Analyze middleware behavior on fail query

   If req.query.fail is true, middleware calls next() with an error, triggering Express error handling.

2. Step 2: Understand test expectation

   The test expects status 500, which matches Express default error response status.

3. Final Answer:

   The test passes because error triggers 500 status -> Option D

4. Quick Check:

   Error passed to next() = 500 response [OK]

Hint: Error in next() triggers 500 status by default [OK]

Common Mistakes:

• Assuming next() without error sends 200
• Ignoring error passed to next()
• Confusing status codes for errors

4. You wrote this test but it always times out. What is the likely error?

app.use((req, res, next) => {
  if (!req.headers.auth) return res.status(401);
  next();
});

request(app).get('/').expect(401, done);

medium

A. next() is called twice causing conflict

B. Missing res.send() causes response never to finish

C. Incorrect HTTP method used in request

D. Middleware does not check headers properly

Solution

1. Step 1: Check middleware response on missing auth

   res.status(401) sets status but does not end response without res.send() or res.end().

2. Step 2: Understand test timeout cause

   Without ending response, test waits indefinitely causing timeout.

3. Final Answer:

   Missing res.send() causes response never to finish -> Option B

4. Quick Check:

   res.status() alone doesn't end response [OK]

Hint: Always end response with res.send() or res.end() [OK]

Common Mistakes:

• Assuming res.status() ends response
• Calling next() after sending response
• Using wrong HTTP method in test

5. You want to test middleware that conditionally modifies the request object and passes control. Which approach best ensures both modification and flow are tested?

hard

A. Test middleware by calling it without any request data

B. Only check the final response status code

C. Use a mock request object and spy on next() to confirm it was called

D. Skip testing and rely on manual checks

Solution

1. Step 1: Understand middleware modifies request and calls next()

   Testing must confirm request changes and that next() is called to continue flow.

2. Step 2: Choose testing approach

   Using a mock request and spying on next() lets you verify both modification and flow control.

3. Final Answer:

   Use a mock request object and spy on next() to confirm it was called -> Option C

4. Quick Check:

   Mock request + spy next() = full middleware test [OK]

Hint: Spy next() and check request changes for full test [OK]

Common Mistakes:

• Ignoring next() call verification
• Testing only response status
• Not providing request data in tests