Feature request : Add possibility to filter by HTTP headers

Author: mpalourdio

src/lib/components/spinner/spinner.component.ts

@@ -34,6 +34,8 @@ export class SpinnerComponent implements OnDestroy, OnInit {
     @Input()
     public filteredMethods: string[] = [];
     @Input()
+    public filteredHeaders: string[] = [];
+    @Input()
     public debounceDelay = 0;
     @Input()
     public minDuration = 0;
@@ -68,6 +70,11 @@ export class SpinnerComponent implements OnDestroy, OnInit {
             throw new TypeError('`filteredMethods` must be an array.');
         }
         this.pendingInterceptorService.filteredMethods = this.filteredMethods;
+
+        if (!(this.filteredHeaders instanceof Array)) {
+            throw new TypeError('`filteredHeaders` must be an array.');
+        }
+        this.pendingInterceptorService.filteredHeaders = this.filteredHeaders;
     }
 
     ngOnDestroy(): void {

src/lib/services/pending-interceptor.service.ts

@@ -20,6 +20,7 @@ export class PendingInterceptorService implements HttpInterceptor {
     private _pendingRequestsStatus: ReplaySubject<boolean> = new ReplaySubject<boolean>(1);
     private _filteredUrlPatterns: RegExp[] = [];
     private _filteredMethods: string[] = [];
+    private _filteredHeaders: string[] = [];
     private _forceByPass: boolean;
 
     /** @deprecated Deprecated in favor of pendingRequestsStatus$ */
@@ -43,6 +44,10 @@ export class PendingInterceptorService implements HttpInterceptor {
         this._filteredMethods = httpMethods;
     }
 
+    set filteredHeaders(value: string[]) {
+        this._filteredHeaders = value;
+    }
+
     set forceByPass(value: boolean) {
         this._forceByPass = value;
     }
@@ -59,9 +64,16 @@ export class PendingInterceptorService implements HttpInterceptor {
         });
     }
 
+    private shouldBypassHeader(req: HttpRequest<any>): boolean {
+        return this._filteredHeaders.some(e => {
+            return req.headers.has(e);
+        });
+    }
+
     private shouldBypass(req: HttpRequest<any>): boolean {
         return this.shouldBypassUrl(req.urlWithParams)
             || this.shouldBypassMethod(req)
+            || this.shouldBypassHeader(req)
             || this._forceByPass;
     }
 

src/test/components/spinner/spinner.component.spec.ts

@@ -160,6 +160,23 @@ describe('SpinnerComponent', () => {
         }
     )));
 
+    it('should not show the spinner if the request is filtered by HTTP header', fakeAsync(inject(
+        [HttpClient, HttpTestingController], (http: HttpClient, httpMock: HttpTestingController) => {
+            component.filteredHeaders.push('header-to-filter');
+            fixture.detectChanges();
+
+            http.get('/fake', {
+                headers: {
+                    'header-to-filter': 'value'
+                }
+            }).subscribe();
+
+            tick();
+            expect(component.isSpinnerVisible).toBeFalsy();
+            httpMock.expectOne('/fake').flush({});
+        }
+    )));
+
     it('should take care of query strings in filteredUrlPatterns', fakeAsync(inject(
         [HttpClient, HttpTestingController], (http: HttpClient, httpMock: HttpTestingController) => {
             component.filteredUrlPatterns.push('bar');
@@ -219,6 +236,30 @@ describe('SpinnerComponent', () => {
         }
     )));
 
+    it('should correctly filter by HTTP header with several requests', fakeAsync(inject(
+        [HttpClient, HttpTestingController], (http: HttpClient, httpMock: HttpTestingController) => {
+            component.filteredHeaders.push('My-HeAdER');
+            fixture.detectChanges();
+
+            http.get('/12345', {
+                headers: {
+                    'my-header': 'value'
+                }
+            }).subscribe();
+            tick();
+            expect(component.isSpinnerVisible).toBeFalsy();
+            httpMock.expectOne('/12345').flush({});
+
+            http.get('/fake').subscribe();
+            tick();
+            expect(component.isSpinnerVisible).toBeTruthy();
+            httpMock.expectOne('/fake').flush({});
+
+            tick();
+            expect(component.isSpinnerVisible).toBeFalsy();
+        }
+    )));
+
     it('should throw an error if filteredUrlPatterns is not an array', () => {
         component.filteredUrlPatterns = null;
         expect(() => fixture.detectChanges()).toThrow(new Error('`filteredUrlPatterns` must be an array.'));
@@ -229,6 +270,11 @@ describe('SpinnerComponent', () => {
         expect(() => fixture.detectChanges()).toThrow(new Error('`filteredMethods` must be an array.'));
     });
 
+    it('should throw an error if filteredHeaders is not an array', () => {
+        component.filteredHeaders = null;
+        expect(() => fixture.detectChanges()).toThrow(new Error('`filteredHeaders` must be an array.'));
+    });
+
     it('should show the spinner even if the component is created after the HTTP request is performed', fakeAsync(inject(
         [HttpClient, HttpTestingController], (http: HttpClient, httpMock: HttpTestingController) => {
             http.get('/fake').subscribe();