test: http-loader: added tests that check if interceptor is used or not

Author: CodeAndWeb

projects/http-loader/src/lib/http-loader-backend.spec.ts

@@ -1,8 +1,15 @@
-import {HttpBackend, HttpClient, provideHttpClient} from "@angular/common/http";
+import {
+  HTTP_INTERCEPTORS,
+  HttpBackend,
+  HttpClient,
+  provideHttpClient,
+  withInterceptorsFromDi
+} from "@angular/common/http";
 import {HttpTestingController, provideHttpClientTesting} from "@angular/common/http/testing";
 import {TestBed} from "@angular/core/testing";
 import {TranslateLoader, provideTranslateService, TranslateService, Translation} from "@ngx-translate/core";
 import {TranslateHttpLoader} from "../public-api";
+import {MarkerInterceptor} from "../test-helper/marker-interceptor";
 
 describe('TranslateLoader (HttpBackend)', () => {
   let translate: TranslateService;
@@ -11,34 +18,38 @@ describe('TranslateLoader (HttpBackend)', () => {
   beforeEach(() => {
     TestBed.configureTestingModule({
       providers: [
-        TranslateService,
-        provideHttpClient(),
+        MarkerInterceptor,
+        {
+          provide: HTTP_INTERCEPTORS,
+          useExisting: MarkerInterceptor,
+          multi: true
+        },
+        provideHttpClient(
+          withInterceptorsFromDi()
+        ),
         provideHttpClientTesting(),
-        /*
-        provideTranslateService({
-            loader: {
-              provide: TranslateLoader,
-              useFactory: (httpClient: HttpClient) => new TranslateHttpLoader(httpClient),
-              deps: [HttpClient]
-            }
-          }
-        )
-         */
+        TranslateService,
         provideTranslateService({
-            loader: {
-              provide: TranslateLoader,
-              useFactory: (backend: HttpBackend) => TranslateHttpLoader.withHttpBackend(backend),
-              deps: [HttpBackend]
-            }
+          loader: {
+            provide: TranslateLoader,
+            useFactory: (httpBackend: HttpBackend) =>
+              TranslateHttpLoader.withHttpBackend(httpBackend, '/assets/i18n/', '.json'),
+            deps: [HttpBackend],
           }
-        )
-
+        }),
       ]
     });
+
     translate = TestBed.inject(TranslateService);
     http = TestBed.inject(HttpTestingController);
   });
 
+
+  afterEach(() => {
+    http.verify();
+  });
+
+
   it('should be able to provide TranslateHttpLoader', () => {
     expect(TranslateHttpLoader).toBeDefined();
     expect(translate.currentLoader).toBeDefined();
@@ -65,6 +76,15 @@ describe('TranslateLoader (HttpBackend)', () => {
     });
   });
 
+  it('should trigger MarkerInterceptor when loading translations', () => {
+    translate.use('en').subscribe();
+
+    const req = http.expectOne('/assets/i18n/en.json');
+    req.flush({ HELLO: 'Hello' });
+
+    expect(req.request.headers.get('X-Test-Header')).toBeNull()
+  });
+
   it('should be able to reload a lang', () => {
     translate.use('en');
 
@@ -95,7 +115,6 @@ describe('TranslateLoader (HttpBackend)', () => {
 
       // reset the lang as if it was never initiated
       translate.resetLang('en');
-
       expect(translate.instant('TEST') as string).toEqual('TEST');
 
       // use set timeout because no request is really made and we need to trigger zone to resolve the observable

projects/http-loader/src/lib/http-loader.spec.ts

@@ -1,8 +1,16 @@
-import {HttpClient, provideHttpClient} from "@angular/common/http";
+import {
+  HTTP_INTERCEPTORS,
+  HttpBackend,
+  HttpClient,
+  provideHttpClient,
+  withInterceptors,
+  withInterceptorsFromDi
+} from "@angular/common/http";
 import {HttpTestingController, provideHttpClientTesting} from "@angular/common/http/testing";
 import {TestBed} from "@angular/core/testing";
 import {TranslateLoader, provideTranslateService, TranslateService, Translation} from "@ngx-translate/core";
 import {TranslateHttpLoader} from "../public-api";
+import {MarkerInterceptor} from "../test-helper/marker-interceptor";
 
 describe('TranslateLoader (HttpClient)', () => {
   let translate: TranslateService;
@@ -11,23 +19,38 @@ describe('TranslateLoader (HttpClient)', () => {
   beforeEach(() => {
     TestBed.configureTestingModule({
       providers: [
-        TranslateService,
-        provideHttpClient(),
+        MarkerInterceptor,
+        {
+          provide: HTTP_INTERCEPTORS,
+          useExisting: MarkerInterceptor,
+          multi: true
+        },
+        provideHttpClient(
+          withInterceptorsFromDi()
+        ),
         provideHttpClientTesting(),
+        TranslateService,
         provideTranslateService({
-            loader: {
-              provide: TranslateLoader,
-              useFactory: (httpClient: HttpClient) => new TranslateHttpLoader(httpClient),
-              deps: [HttpClient]
-            }
+          loader: {
+            provide: TranslateLoader,
+            useFactory: (client: HttpClient) =>
+              new TranslateHttpLoader(client, '/assets/i18n/', '.json'),
+            deps: [HttpClient],
           }
-        )
+        }),
       ]
     });
+
     translate = TestBed.inject(TranslateService);
     http = TestBed.inject(HttpTestingController);
   });
 
+
+  afterEach(() => {
+    http.verify();
+  });
+
+
   it('should be able to provide TranslateHttpLoader', () => {
     expect(TranslateHttpLoader).toBeDefined();
     expect(translate.currentLoader).toBeDefined();
@@ -54,6 +77,15 @@ describe('TranslateLoader (HttpClient)', () => {
     });
   });
 
+  it('should trigger MarkerInterceptor when loading translations', () => {
+    translate.use('en').subscribe();
+
+    const req = http.expectOne('/assets/i18n/en.json');
+    req.flush({ HELLO: 'Hello' });
+
+    expect(req.request.headers.get('X-Test-Header')).toBe('marker');
+  });
+
   it('should be able to reload a lang', () => {
     translate.use('en');
 
@@ -100,4 +132,6 @@ describe('TranslateLoader (HttpClient)', () => {
     // mock response after the xhr request, otherwise it will be undefined
     http.expectOne('/assets/i18n/en.json').flush({"TEST": "This is a test"});
   });
+
+
 });

projects/http-loader/src/lib/http-loader.ts

@@ -6,15 +6,23 @@ import {Observable} from 'rxjs';
 @Injectable()
 export class TranslateHttpLoader implements TranslateLoader {
 
+  static readonly defaultPrefix = "/assets/i18n/";
+  static readonly defaultSuffix = ".json";
+
   constructor(
     private http: HttpClient,
-    @Inject(String) public prefix = "/assets/i18n/",
-    @Inject(String) public suffix = ".json"
+    @Inject(String) public prefix = TranslateHttpLoader.defaultPrefix,
+    @Inject(String) public suffix = TranslateHttpLoader.defaultSuffix
   )
   {}
 
-  public static withHttpBackend(backend: HttpBackend): TranslateHttpLoader {
-    return new TranslateHttpLoader(new HttpClient(backend));
+  public static withHttpBackend(
+    backend: HttpBackend,
+    prefix: string = TranslateHttpLoader.defaultPrefix,
+    suffix: string = TranslateHttpLoader.defaultSuffix
+  ): TranslateHttpLoader
+  {
+    return new TranslateHttpLoader(new HttpClient(backend), prefix, suffix);
   }
 
   /**

projects/http-loader/src/test-helper/marker-interceptor.ts

@@ -0,0 +1,22 @@
+import { Injectable } from '@angular/core';
+import {
+    HttpEvent, HttpInterceptor, HttpHandler, HttpRequest
+} from '@angular/common/http';
+import { Observable } from 'rxjs';
+
+@Injectable()
+export class MarkerInterceptor implements HttpInterceptor {
+    triggered = false;
+
+    intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
+        this.triggered = true;
+
+        const modified = req.clone({
+            setHeaders: {
+                'X-Test-Header': 'marker'
+            }
+        });
+
+        return next.handle(modified);
+    }
+}