Guard interface (canActivate) in NestJS - Mini Project: Build & Apply

Create a Simple Guard Using canActivate in NestJS

📖 Scenario: You are building a NestJS backend for a small app. You want to protect a route so only users with a specific role can access it.

🎯 Goal: Build a guard using the canActivate method that allows access only if the user role is admin.

📋 What You'll Learn

Create a guard class named RolesGuard that implements CanActivate

Add a canActivate method that checks if the user role is admin

Use the ExecutionContext to get the request object

Return true if the role is admin, otherwise false

Apply the guard to a sample controller route

💡 Why This Matters

🌍 Real World

Guards are used in real NestJS apps to protect routes and APIs based on user roles or permissions.

💼 Career

Understanding guards and canActivate is essential for backend developers working with NestJS to build secure applications.

1

Create the RolesGuard class implementing CanActivate

Create a class called RolesGuard that implements the CanActivate interface from @nestjs/common.

NestJS

import { CanActivate } from '@nestjs/common';

// Your code here

Hint

Remember to import CanActivate and ExecutionContext from @nestjs/common.

2

Extract the user role from the request object

Inside the canActivate method, use context.switchToHttp().getRequest() to get the request object. Then create a variable called userRole that gets the role property from request.user.

NestJS

import { CanActivate, ExecutionContext } from '@nestjs/common';

export class RolesGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    const request = context.switchToHttp().getRequest();
    // Your code here
    return false;
  }
}

Hint

Use context.switchToHttp().getRequest() to get the request, then access user.role.

3

Check if the user role is 'admin' and return true or false

Update the canActivate method to return true if userRole equals 'admin'. Otherwise, return false.

NestJS

import { CanActivate, ExecutionContext } from '@nestjs/common';

export class RolesGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    const request = context.switchToHttp().getRequest();
    const userRole = request.user.role;
    // Your code here
  }
}

Hint

Use a simple comparison to check if userRole is 'admin'.

4

Apply the RolesGuard to a controller route

Create a controller class called AppController with a method getAdminData decorated with @Get('admin'). Apply the RolesGuard to this method using @UseGuards(RolesGuard). The method should return the string 'Admin data'.

NestJS

import { CanActivate, ExecutionContext, Controller, Get, UseGuards } from '@nestjs/common';

export class RolesGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    const request = context.switchToHttp().getRequest();
    const userRole = request.user.role;
    return userRole === 'admin';
  }
}

// Your code here

Hint

Import Controller, Get, and UseGuards from @nestjs/common. Decorate the method and class properly.

Practice

1. What is the main purpose of the canActivate method in a NestJS guard?

easy

A. To format the response data

B. To handle database connections

C. To decide if a request should be allowed or denied access

D. To log user activity

Solution

1. Step 1: Understand the role of guards in NestJS

   Guards are used to control access to routes by allowing or denying requests.

2. Step 2: Identify the function of canActivate

   The canActivate method returns true or false to allow or deny access.

3. Final Answer:

   To decide if a request should be allowed or denied access -> Option C

4. Quick Check:

   Guard access control = canActivate returns true/false [OK]

Hint: Remember: canActivate returns true to allow access [OK]

Common Mistakes:

• Confusing canActivate with response formatting
• Thinking canActivate handles database logic
• Assuming canActivate logs user actions

2. Which of the following is the correct syntax to implement a guard class with canActivate in NestJS?

easy

A. class MyGuard { canActivate(context) { return true; } }

B. function MyGuard() { canActivate() { return true; } }

C. const MyGuard = () => { canActivate() { return true; } }

D. class MyGuard implements CanActivate { canActivate(context: ExecutionContext): boolean { return true; } }

Solution

1. Step 1: Recognize the NestJS guard pattern

   Guards are classes that implement the CanActivate interface.

2. Step 2: Check the method signature and class syntax

   The method must be named canActivate and accept an ExecutionContext parameter, returning a boolean.

3. Final Answer:

   class MyGuard implements CanActivate { canActivate(context: ExecutionContext): boolean { return true; } } -> Option D

4. Quick Check:

   Guard class implements CanActivate with canActivate method [OK]

Hint: Use class with implements CanActivate and proper method signature [OK]

Common Mistakes:

• Using function instead of class
• Missing implements CanActivate
• Incorrect method parameters or return type

3. Given this guard code, what will be the result when a request is made?

class AlwaysDenyGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    return false;
  }
}

medium

A. The request is denied access

B. The request is allowed to proceed

C. A runtime error occurs

D. The guard is ignored and request proceeds

Solution

1. Step 1: Analyze the canActivate return value

   The method always returns false, meaning access is denied.

2. Step 2: Understand guard effect on request

   When canActivate returns false, NestJS blocks the request from continuing.

3. Final Answer:

   The request is denied access -> Option A

4. Quick Check:

   canActivate false = deny request [OK]

Hint: False return in canActivate means deny access [OK]

Common Mistakes:

• Assuming false allows access
• Thinking guard causes error on false
• Believing guard is skipped if false

4. Identify the error in this guard implementation:

class MyGuard implements CanActivate {
  canActivate() {
    return true;
  }
}

medium

A. Incorrect return type for canActivate

B. Missing parameter in canActivate method

C. Class does not implement CanActivate interface

D. canActivate method should be async

Solution

1. Step 1: Check method signature requirements

   The canActivate method must accept a parameter of type ExecutionContext.

2. Step 2: Compare with given code

   The method has no parameters, which breaks the interface contract.

3. Final Answer:

   Missing parameter in canActivate method -> Option B

4. Quick Check:

   canActivate needs ExecutionContext parameter [OK]

Hint: canActivate always needs ExecutionContext parameter [OK]

Common Mistakes:

• Omitting method parameters
• Assuming async is required
• Ignoring interface implementation rules

5. You want to create a guard that only allows access if the user role is 'admin'. Which of these canActivate implementations correctly checks the role from the request object?

hard

A. canActivate(context: ExecutionContext): boolean {
const request = context.switchToHttp().getRequest();
return request.user?.role === 'admin';
}

B. canActivate(context: ExecutionContext): boolean {
const user = context.getUser();
return user.role === 'admin';
}

C. canActivate(context: ExecutionContext): boolean {
const request = context.getRequest();
return request.user.role === 'admin';
}

D. canActivate(context: ExecutionContext): boolean {
const req = context.switchToHttp().getRequest();
return req.user.role == 'admin';
}

Solution

1. Step 1: Access the HTTP request correctly

   Use context.switchToHttp().getRequest() to get the request object.

2. Step 2: Safely check the user role

   Use optional chaining request.user?.role to avoid errors if user is undefined.

3. Final Answer:

   canActivate(context: ExecutionContext): boolean { const request = context.switchToHttp().getRequest(); return request.user?.role === 'admin'; } -> Option A

4. Quick Check:

   Use switchToHttp and optional chaining for safe role check [OK]

Hint: Use switchToHttp().getRequest() and optional chaining for safety [OK]

Common Mistakes:

• Using context.getUser() which does not exist
• Calling context.getRequest() directly without switchToHttp()
• Not using optional chaining causing runtime errors