Request ID for tracing in Express - Mini Project: Build & Apply

Request ID for Tracing in Express

📖 Scenario: You are building a simple Express server that handles incoming requests. To help track each request uniquely, you want to add a request ID to every request. This ID will help you trace logs and debug issues easily.

🎯 Goal: Create an Express middleware that generates a unique request ID for each incoming request and attaches it to the request object. Then, use this ID in a route handler to send it back in the response.

📋 What You'll Learn

Create an Express app

Add middleware to generate a unique request ID using crypto.randomUUID()

Attach the request ID to req.id

Create a GET route at / that responds with the request ID in JSON format

💡 Why This Matters

🌍 Real World

Assigning unique request IDs helps developers trace and debug requests in logs, especially in complex or distributed systems.

💼 Career

Understanding middleware and request tracing is essential for backend developers working with Express or similar web frameworks.

1

Setup Express app

Create a variable called express by requiring the express module. Then create a variable called app by calling express().

Express

const express = require('express');
// Your code here

Hint

Use require('express') to import Express and call it as a function to create the app.

2

Add request ID middleware

Create a middleware function that uses crypto.randomUUID() to generate a unique ID. Attach this ID to req.id. Use app.use() to add this middleware to the app. Remember to require crypto at the top.

Express

const express = require('express');
const app = express();
const crypto = require('crypto');
// Your code here

Hint

Use app.use() to add a middleware that sets req.id to a new UUID.

3

Create GET route to return request ID

Add a GET route handler for path '/' using app.get(). In the handler, send a JSON response with a key requestId and value req.id.

Express

const express = require('express');
const app = express();
const crypto = require('crypto');

app.use((req, res, next) => {
    req.id = crypto.randomUUID();
    next();
});

// Your code here

Hint

Use app.get() to create a route that sends back the request ID as JSON.

4

Start the server

Add code to start the Express server by calling app.listen() on port 3000. Provide a callback function that does nothing (empty arrow function).

Express

const express = require('express');
const app = express();
const crypto = require('crypto');

app.use((req, res, next) => {
    req.id = crypto.randomUUID();
    next();
});

app.get('/', (req, res) => {
    res.json({ requestId: req.id });
});

// Your code here

Hint

Use app.listen(3000, () => {}) to start the server on port 3000.

Practice

1. What is the main purpose of adding a request ID in an Express app?

easy

A. To encrypt the request data for security

B. To speed up the request processing time

C. To uniquely identify each request for easier tracking and debugging

D. To limit the number of requests from a user

Solution

1. Step 1: Understand the role of request ID

   A request ID is used to uniquely mark each incoming request so it can be tracked through logs and debugging.

2. Step 2: Identify the main benefit

   This helps developers trace requests easily, especially when many requests happen simultaneously.

3. Final Answer:

   To uniquely identify each request for easier tracking and debugging -> Option C

4. Quick Check:

   Request ID purpose = Unique tracking [OK]

Hint: Request ID helps track requests uniquely in logs [OK]

Common Mistakes:

• Thinking request ID speeds up processing
• Confusing request ID with encryption
• Assuming request ID limits requests

2. Which code snippet correctly adds a unique request ID to each request using the 'uuid' library in Express middleware?

easy

A. app.use((req, res, next) => { req.id = uuid.v4(); next(); });

B. app.use((req, res) => { req.id = uuid.v4(); });

C. app.use((req, res, next) => { res.id = uuid.v4(); next(); });

D. app.use((req, res, next) => { req.id = uuid(); next(); });

Solution

1. Step 1: Check middleware signature

   Express middleware must have three parameters: req, res, next to pass control.

2. Step 2: Verify correct uuid usage

   uuid.v4() generates a unique ID; assigning it to req.id is correct.

3. Final Answer:

   app.use((req, res, next) => { req.id = uuid.v4(); next(); }); -> Option A

4. Quick Check:

   Correct middleware and uuid call = app.use((req, res, next) => { req.id = uuid.v4(); next(); }); [OK]

Hint: Middleware needs (req, res, next) and uuid.v4() for ID [OK]

Common Mistakes:

• Omitting next() call in middleware
• Assigning ID to res instead of req
• Calling uuid() instead of uuid.v4()

3. Given this middleware code, what will be logged when a request is made?

const { v4: uuidv4 } = require('uuid');
app.use((req, res, next) => {
  req.id = uuidv4();
  console.log(`Request ID: ${req.id}`);
  next();
});
app.get('/', (req, res) => {
  res.send(`Your request ID is ${req.id}`);
});

medium

A. Logs 'undefined' and responds with 'Your request ID is undefined'

B. Logs a unique UUID string and responds with the same ID

C. Throws an error because req.id is not set

D. Logs a fixed string 'Request ID: 1234' every time

Solution

1. Step 1: Analyze middleware behavior

   The middleware assigns a new UUID to req.id and logs it before calling next().

2. Step 2: Check route handler response

   The route sends back the same req.id value, so the response matches the logged ID.

3. Final Answer:

   Logs a unique UUID string and responds with the same ID -> Option B

4. Quick Check:

   UUID assigned and logged = Logs a unique UUID string and responds with the same ID [OK]

Hint: Middleware sets req.id before route uses it [OK]

Common Mistakes:

• Assuming req.id is undefined in route
• Thinking the ID is fixed or static
• Expecting an error due to missing ID

4. Identify the error in this Express middleware that tries to add a request ID:

app.use((req, res, next) => {
  req.id = uuidv4;
  next();
});

medium

A. req.id should be assigned to res.id

B. Middleware is missing the next parameter

C. next() is called before assigning req.id

D. uuidv4 is assigned without calling it as a function

Solution

1. Step 1: Check uuidv4 usage

   uuidv4 is a function and must be called with parentheses to generate an ID.

2. Step 2: Confirm middleware parameters and flow

   Middleware has correct parameters and calls next() after assignment, so no issue there.

3. Final Answer:

   uuidv4 is assigned without calling it as a function -> Option D

4. Quick Check:

   Function call missing parentheses = uuidv4 is assigned without calling it as a function [OK]

Hint: Call uuidv4() with () to get ID, not just uuidv4 [OK]

Common Mistakes:

• Forgetting parentheses on function calls
• Mixing req and res objects
• Calling next() too early

5. You want to add a request ID to each request and include it in all logs and the response header. Which approach correctly achieves this in Express?

hard

A. Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers

B. Assign req.id in each route handler separately without middleware

C. Generate a random number in middleware but do not pass it to response headers

D. Use middleware to assign req.id but never call next() to stop processing

Solution

1. Step 1: Assign request ID in middleware

   Middleware is the right place to assign req.id once per request using uuidv4().

2. Step 2: Add request ID to response headers and logs

   Setting res.set('X-Request-ID', req.id) sends the ID to clients; logging req.id in handlers tracks requests.

3. Final Answer:

   Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers -> Option A

4. Quick Check:

   Middleware + header + logging = Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers [OK]

Hint: Assign ID once in middleware, add header, log everywhere [OK]

Common Mistakes:

• Assigning ID in every route instead of middleware
• Not adding request ID to response headers
• Forgetting to call next() in middleware