Skip to main content

An Overview On Angular Interceptor

In Angular application, the Http request and response can be inspected and transform using the Interceptors. An application can configure multiple interceptors if needed. Each interceptor gets invoked for every Http request.

Interceptor Flow:

The Interceptors moto is to intercepts and handles an 'HttpRequest' or 'HttpResponse'

Most interceptors transform the outgoing request before passing it to the next interceptor in the chain, by calling 'next.handle(request)'. An interceptor may transform the response event stream as well, by applying addition RXJS operators on the stream returned by 'next.handle()'

More rarely, an interceptor may handle the request entirely and compose a new event stream instead of invoking 'next.handle()'. This is acceptable behavior, but keep in mind that further interceptors will be skipped entirely.

It is also rare but valid for an interceptor to return multiple responses on the event stream for a single request.


  • Let's suppose consider we have 2 interceptors in our application. Once the application starts to call an API, our Http request enters the 1st interceptor there we will implement the most common logics like adding a custom header, adding access token, etc.
  • After that 'next.handle()'(next is HttpRequest Handler) will pass our Http request to the 2nd interceptor, then our Http request executes the logic in 2nd interceptor like the 1st one. 
  • In 2nd interceptor 'next.handle()' method executes since it is last interceptor request will be sent to the API. 
  • Now API response first will be captured by 2nd interceptor, here we can implement some common logics like filtering response or retry call for API if it fails, etc. after that Http response will enter to 1st interceptor will be processed similar way as in 2nd interceptor. 
  • Finally, the response will be captured by services  and the components

Create A Sample Angular App:

Let's understand interceptor features by implementing it in a sample angular application.

Command To Install Angular CLI:(If not installed on your system previously)

npm install -g @angular/cli
Angular CLI Command To Create Angular App:

ng new your_project_name
Command To Run App:

ng serve
Let's create a service that triggers an Http get request.
src/app/app.service.ts:
import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';

@Injectable()
export class AppService {
  constructor(private httpClient: HttpClient) {}

  get(){
      this.httpClient.get("http://test.com/api")
      .subscribe(
          (response) => {console.log('success')},
          (error) => {console.log('fails')}
      )
  }
}
Here created a test angular service it helps to understand interceptors better way. The API used here is a dummy one.

Now inject the HttpClient and our service in the AppModule file.
src/app/app.module.ts:
import { HttpClientModule } from '@angular/common/http';

import { AppService } from './app.service';
// some code hidden for better display
@NgModule({
  imports: [HttpClientModule],
  providers: [AppService]
})
export class AppModule {}
  • (Line: 7) HttpClientModule imported which is available at '@angular/common/http'
  • (Line: 8) imported our 'AppService'
Now, let's add a button that triggers our dummy API.
src/app/app.component.ts:
import { Component } from '@angular/core';

import { AppService } from './app.service';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {
  title = 'demo-interceptor';

  constructor(private appSerive:AppService){

  }
  triggerService(){
    this.appSerive.get();
  }
}
  • Injected our 'AppService' into our component.
src/app/app.component.html:
<div>
  <input type="button" value="Trigger Service" (click)="triggerService()">
</div>

Create A Test1Interceptor:

Let's create our first interceptor which is a dummy one does nothing with 2 console logs to track execution.
src/app/test1.interceptor.ts:
import { Injectable } from '@angular/core';
import {
  HttpInterceptor,
  HttpRequest,
  HttpHandler,
  HttpEvent,
} from '@angular/common/http';
import { Observable } from 'rxjs';

@Injectable()
export class Test1Interceptor implements HttpInterceptor {
  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    console.log('here request can modify -- Interceptor 1')
    var handle = next.handle(req);
    console.log('here response can modify -- Interceptor 1')
    return handle;
  }
}
  • (Line: 11) HttpInterceptor is an interface that needs to be implemented by our interceptor class. The 'HttpInterceptor' interface loads from '@angular/common/http'
  • (Line: 12) 'intercept()' is an abstract method from 'HttpInterceptor' that we need to implement for identifying and handling an Http request. The 'req' parameter of type 'HttpRequest<any>' is for outgoing request object to handle. The 'next' parameter of type 'Http' is to trigger the next interceptor in the flow of the chain or the backend(API). If no interceptor remains in the chain, then returns an observable of the event stream.
  • (Line: 13&15) console log to understand interceptor execution.

Import Provider In AppModule:

To use the same instance of 'HttpInterceptor' for the entire application, import the 'HttpClientModule' only in our 'AppModule', and add the interceptors to the root application injector. If we import 'HttpClientModule' multiple times across different modules(for example, in lazy loading modules), each import creates a new copy of the 'HttpClientModule', which overwrites the interceptor provided in the root module.
src/app/app.module.ts:
import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http';
import { Test1Interceptor } from './test1.interceptor';

@NgModule({
  imports: [HttpClientModule],
  providers: [
    {
      provide: HTTP_INTERCEPTORS,
      useClass: Test1Interceptor,
      multi: true,
    }
  ],
  bootstrap: [AppComponent],
})
export class AppModule {}
  • (Line: 8) The 'HTTP_INTERCEPTORS' is a multi-provider token that represents the array of registered 'HttpInterceptor' objects.
  • (Line: 9) assign our interceptor class.
  • (Line: 10) 'multi' is required to set true, which allows us to have multiple interceptors in our application all will be injected with the help of multi-provider token 'HTTP_INTERCEPTORS'.

Test Interceptors:

Now track our console logs added in our interceptor to understand the flow.

For better understanding lets add one more interceptor as below.
src/app/test2.interceptor.ts:
import { Injectable } from '@angular/core';
import {
  HttpInterceptor,
  HttpRequest,
  HttpHandler,
  HttpEvent,
} from '@angular/common/http';
import { Observable } from 'rxjs';

@Injectable()
export class Test2Interceptor implements HttpInterceptor {
  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    console.log('here request can modify -- interceptor 2')
    var handle = next.handle(req);
    console.log('here response can modify -- intereptor 2')
    return handle;
  }
}
Now inject the Test2Interceptor in AppModule like we did in previous steps.
src/app/app.module.ts:
import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http';

import { Test1Interceptor } from './test1.interceptor';
import { Test2Interceptor } from './test2.interceptor';


@NgModule({
   providers: [
    {
      provide: HTTP_INTERCEPTORS,
      useClass: Test1Interceptor,
      multi: true,
    },
    {
      provide: HTTP_INTERCEPTORS,
      useClass: Test2Interceptor,
      multi: true,
    }
  ]
})
export class AppModule {}
Now track the console log we can understand how the interceptors chain will execute in request and response.

Order Of Interceptor Execution:

The order of the interceptor's execution will be the same as they injected in the AppModule. So if we want to add or skip the interceptors dynamically then we need to add 'if' conditions inside of the interceptors either to execute or skip the transformation of Http request and Http response.

Transform Request Object:

Interceptors can be used to modify the HttpRequest object. It is not recommended to modify them directly. Even most of the HttpRequest object properties are read-only which means they immutable. But Interceptor meant for the transformation so instead of modifying the original Http request object here we will clone them and implement our transformation to the new request object. Using intercepted we can do things like URL modification(not recommended, only can be used in rare cases based on your application business), setting default headers, request caching, etc.

Let's add some custom headers in our sample interceptors for understanding.
src/app/test1.interceptor.ts:
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
	const transformedReq = req.clone({
	  headers: req.headers.set('custom-header-1', 'im Interceptor 1')
	});
	return next.handle(transformedReq);
}
  • (Line: 2) 'req.clone()' method is used to set our custom header
  • (Line: 5) newly created HttpRequest object will be delivered to other interceptors if exist or sends to API.
src/app/test2.interceptors.ts:
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    const transformedReq = req.clone({
        headers: req.headers.set('custom-header-2', 'im Interceptor 2')
    });
    return next.handle(transformedReq);
}

Transform Response Object:

In interceptors, it is possible to modify the response object but it is not all recommended to modify the response.
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {

	return next.handle(req).pipe(
	  map((response:HttpResponse<any>) => {
		 return response.clone({statusText: "hurray"})
	  })
	);
}

Interceptor Providers index.ts:

An ideal way of exposing bulk number providers is by using a separate container file like index.ts. This approach makes AppModule configurations cleaner.
src/app/interceptors/index.ts:
import { HTTP_INTERCEPTORS } from '@angular/common/http';

import { Test1Interceptor } from '../test1.interceptor';
import { Test2Interceptor } from '../test2.interceptor';

export const interceptorProviders = [
  {
    provide: HTTP_INTERCEPTORS,
    useClass: Test1Interceptor,
    multi: true,
  },
  {
    provide: HTTP_INTERCEPTORS,
    useClass: Test2Interceptor,
    multi: true,
  },
];
Now import this 'interceptorProviders' array into the AppModule
src/app/app.module.ts:
import {interceptorProviders} from './interceptor/index';

@NgModule({
  providers: [
    interceptorProviders
  ]
})
export class AppModule {}

Wrapping Up:

Hopefully, I think this article delivered some useful information on Angular Interceptors. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route.

An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below
app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaults:new { …

GraphQL API Integration In Asp.Net Core Application

Introduction:
GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data.
How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions.HTTP-POST is the only Http verb recommended by the GraphQL.The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API:The main building blocks of GraphQL API is Schemas and Types. A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc.Types likely to be called Grap…

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API.
When To Use Versioning:Any API response changes.Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production.Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types:Query String VersioningUrl Path VersioningMedia Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.
 Install-Package Microsoft.AspNetCore.Mvc.Versioning -version 4.0.0 Register API V…

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload:The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client. Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file. Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk. If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application.
Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.  Check the link to use the Visual Studio Code for .NET Core Application.
IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files from the client, then the entire …

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items.
The main building block of ion-picker as follows: PickerControllerPickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options
PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker.
Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger", "Lion", "Elephant"…

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library jQuery Validate.
In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples.
Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio.
Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as below.
PersonController.cs: us…

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form.
Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor. Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production.
Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component, name it as "UserForm.razor"
Add Route: In Blazor routing can be configured using @page  directive, and URL should b…

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism:Blazor Server is a very light-weight web development framework. In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation. Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server. Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required information or changed …

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.
Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command
npm i -g @nestjs/cli Now create a sample project by using Nest CLI command  nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".
"dependencies" contains all plugins to be installed and used them to run the application.
"devDependencies" contain all plugins to be installed and used them at the time of application development.
"scrip…

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server.
Main Response Caching Headers are like below
Cache-ControlPragmaVary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response.private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores.max-age - this directive represents a time to hold a response in the cache.no-cache - this directive represents no storing of response and always fetch the fresh response from serverno-store…