Customize Auth Guard for Guest Users in SAP Spartacus Composable Store

Customizing Auth Guard for Guest Users in SAP Spartacus Composable Store

In SAP Spartacus, the AuthGuard is used to protect routes that require authentication. However, out-of-the-box, it does not support guest users. This article will guide you through the process of customizing the AuthGuard to support guest users in a SAP Spartacus Composable Store.

Prerequisites

To follow along with this article, you should have a basic understanding of Angular and SAP Spartacus. You should also have a SAP Spartacus project set up and running.

Key Concepts

The AuthGuard in SAP Spartacus is responsible for protecting routes that require authentication. It does this by checking if the user is authenticated and if they have the necessary permissions to access the route. However, it does not support guest users out-of-the-box. To support guest users, we need to customize the AuthGuard.

Customizing Auth Guard for Guest Users

To customize the AuthGuard to support guest users, we need to create a new guard that extends the AuthGuard and overrides the canActivate method. In the canActivate method, we need to check if the user is a guest user and if the route they are trying to access is allowed for guest users.

import { AuthGuard } from '@spartacus/core';
import { Injectable } from '@angular/core';
import { RouterStateSnapshot, ActivatedRouteSnapshot } from '@angular/router';
import { Observable } from 'rxjs';

@Injectable()
export class CustomAuthGuard extends AuthGuard {
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable | Promise | boolean {
const isGuestUser = this.user.isGuest();
if (isGuestUser && this.isRouteAllowedForGuestUsers(route)) {
return true;
}

return super.canActivate(route, state);
}

isRouteAllowedForGuestUsers(route: ActivatedRouteSnapshot): boolean {
// Add your logic here to determine if the route is allowed for guest users
// For example, you can check the route configuration or use a permission system
return true;
}
}

In the code above, we first check if the user is a guest user using the isGuest() method of the user service. If the user is a guest user and the route is allowed for guest users, we return true to allow the user to access the route. If the user is not a guest user or the route is not allowed for guest users, we call the canActivate method of the parent AuthGuard to check if the user is authenticated and has the necessary permissions to access the route.

Applications

Customizing the AuthGuard to support guest users can be useful in a variety of scenarios. For example, you may want to allow guest users to access certain routes, such as the homepage or a product page, without requiring them to log in. By customizing the AuthGuard, you can easily achieve this.

Significance

Customizing the AuthGuard to support guest users is an important aspect of building a SAP Spartacus Composable Store that caters to both authenticated and guest users. It allows you to provide a seamless user experience for guest users while still protecting sensitive routes that require authentication.

• The AuthGuard in SAP Spartacus does not support guest users out-of-the-box.
• To support guest users, we need to create a new guard that extends the AuthGuard and overrides the canActivate method.
• In the canActivate method, we need to check if the user is a guest user and if the route they are trying to access is allowed for guest users.
• Customizing the AuthGuard to support guest users can be useful in a variety of scenarios, such as allowing guest users to access certain routes without requiring them to log in.

References

• SAP Spartacus Authentication Documentation
• Angular AuthGuard Documentation