Dependency injection in Express

Introduction

Dependency injection helps you organize your code by giving parts what they need instead of making them find it themselves. This makes your app easier to manage and test.

When you want to share a database connection across different routes without creating it multiple times.

When you want to swap out a service (like a logger or email sender) easily for testing or different environments.

When you want to keep your route handlers simple and focused on their job, not on creating dependencies.

When you want to write unit tests for your routes by providing fake or mock services.

When your app grows and you want to avoid tightly coupling parts of your code.

Syntax

Express

function createRouter(dependency) {
  const router = require('express').Router();
  router.get('/', (req, res) => {
    const data = dependency.getData();
    res.send(data);
  });
  return router;
}

const myDependency = {
  getData: () => 'Hello from dependency!'
};

const app = require('express')();
app.use('/path', createRouter(myDependency));

You create functions that accept dependencies as parameters.

Then you pass the actual dependencies when you use those functions.

Examples

This example shows injecting a logger service into a router.

Express

function createLogger() {
  return {
    log: (msg) => console.log('LOG:', msg)
  };
}

function createRouter(logger) {
  const router = require('express').Router();
  router.get('/', (req, res) => {
    logger.log('Route accessed');
    res.send('Check console for log');
  });
  return router;
}

const logger = createLogger();
const app = require('express')();
app.use('/', createRouter(logger));

This example injects a database object into a user service used by a route.

Express

function createUserService(db) {
  return {
    getUser: (id) => db.findUserById(id)
  };
}

const fakeDb = {
  findUserById: (id) => ({ id, name: 'Test User' })
};

const userService = createUserService(fakeDb);

const app = require('express')();
app.get('/user/:id', (req, res) => {
  const user = userService.getUser(req.params.id);
  res.json(user);
});

Sample Program

This program creates a message service and injects it into a router. The router uses the service to send a message when you visit /message.

Express

const express = require('express');

// Dependency: simple message service
function createMessageService() {
  return {
    getMessage: () => 'Hello from the message service!'
  };
}

// Router factory that injects the message service
function createMessageRouter(messageService) {
  const router = express.Router();
  router.get('/', (req, res) => {
    const message = messageService.getMessage();
    res.send(message);
  });
  return router;
}

const app = express();
const messageService = createMessageService();
app.use('/message', createMessageRouter(messageService));

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000/message');
});

Important Notes

Dependency injection helps keep your code clean and easy to test.

Always inject dependencies instead of requiring them inside modules to improve flexibility.

Use this pattern especially when your app grows bigger and has many parts.

Summary

Dependency injection means giving parts of your app what they need instead of making them find it.

It helps keep code organized, testable, and flexible.

In Express, you can inject dependencies by passing them to router or service factory functions.

Practice

1. What is the main purpose of dependency injection in an Express app?

easy

A. To provide parts of the app with the resources they need without hardcoding them

B. To make the app run faster by caching data

C. To automatically generate routes based on file names

D. To handle errors globally in the app

Solution

1. Step 1: Understand dependency injection concept

   Dependency injection means giving parts of your app what they need instead of making them find it themselves.

2. Step 2: Identify the purpose in Express

   In Express, this helps keep code organized and flexible by passing dependencies explicitly.

3. Final Answer:

   To provide parts of the app with the resources they need without hardcoding them -> Option A

4. Quick Check:

   Dependency injection = Provide needed resources [OK]

Hint: Think: "Give what is needed, don't make it find" [OK]

Common Mistakes:

• Confusing dependency injection with caching
• Thinking it auto-generates routes
• Mixing it with error handling

2. Which of the following is the correct way to inject a service into an Express router?

easy

A. const router = express.Router(); router.use(service);

B. const router = express.Router(service);

C. function createRouter(service) { const router = express.Router(); router.service = service; return router; }

D. const router = express.Router(); router.service = service();

Solution

1. Step 1: Check how to pass dependencies in Express

   Express.Router() does not accept parameters directly, so passing service as argument is invalid.

2. Step 2: Use a factory function to inject service

   Creating a function that takes service and returns a router with service attached is the correct pattern.

3. Final Answer:

   function createRouter(service) { const router = express.Router(); router.service = service; return router; } -> Option C

4. Quick Check:

   Inject by factory function = function createRouter(service) { const router = express.Router(); router.service = service; return router; } [OK]

Hint: Use a function to pass dependencies, not Router constructor [OK]

Common Mistakes:

• Passing service directly to express.Router()
• Calling service as a middleware incorrectly
• Assigning service without a factory function

3. Consider this code snippet:

function createService() {
  return { getName: () => 'MyService' };
}

function createRouter(service) {
  const router = require('express').Router();
  router.get('/name', (req, res) => {
    res.send(service.getName());
  });
  return router;
}

const service = createService();
const router = createRouter(service);

// What happens when a GET request is made to '/name'?

medium

A. The server will crash due to missing middleware

B. The response will be undefined

C. There will be a runtime error because service is not defined

D. The response will be 'MyService'

Solution

1. Step 1: Analyze service creation

   The createService function returns an object with getName method returning 'MyService'.

2. Step 2: Analyze router handler

   The router uses the injected service and calls getName to send the response on '/name' route.

3. Final Answer:

   The response will be 'MyService' -> Option D

4. Quick Check:

   Injected service method returns 'MyService' [OK]

Hint: Injected service methods run as expected in route handlers [OK]

Common Mistakes:

• Assuming service is undefined inside handler
• Thinking service causes runtime error
• Confusing middleware with service injection

4. You have this code snippet:

function createRouter(service) {
  const router = require('express').Router();
  router.get('/data', (req, res) => {
    res.send(service.getData());
  });
  return router;
}

const router = createRouter();

What is the main issue here?

medium

A. The router is missing the service argument, causing service to be undefined

B. The router should be created with express() instead of express.Router()

C. The getData method is not defined on the router

D. The route path '/data' is invalid in Express

Solution

1. Step 1: Check function call for createRouter

   The createRouter function expects a service argument, but none is passed, so service is undefined.

2. Step 2: Understand impact on route handler

   Calling service.getData() will cause a runtime error because service is undefined.

3. Final Answer:

   The router is missing the service argument, causing service to be undefined -> Option A

4. Quick Check:

   Missing dependency argument = undefined service [OK]

Hint: Always pass dependencies when calling factory functions [OK]

Common Mistakes:

• Thinking express() should replace express.Router() here
• Confusing method definition with dependency injection
• Assuming route path is invalid

5. You want to inject a database client into multiple routers in your Express app. Which approach best supports this using dependency injection?

hard

A. Use a global variable for the database client and import it in each router file

B. Create a factory function for each router that accepts the database client and returns a configured router

C. Attach the database client directly to the Express app instance and access it via req.app

D. Create middleware that initializes the database client on every request

Solution

1. Step 1: Understand dependency injection best practice

   Injecting dependencies via factory functions keeps routers independent and testable.

2. Step 2: Evaluate options for injecting database client

   Factory functions allow passing the client explicitly to each router, avoiding globals and repeated initialization.

3. Final Answer:

   Create a factory function for each router that accepts the database client and returns a configured router -> Option B

4. Quick Check:

   Factory functions for injection = Create a factory function for each router that accepts the database client and returns a configured router [OK]

Hint: Use factory functions to pass shared resources cleanly [OK]

Common Mistakes:

• Using global variables which reduce testability
• Attaching client to app instance instead of injecting
• Initializing client on every request causing overhead