authGuard acc. lejdiprifti.com

bizmatch/src/app/interceptors/keycloak-bearer.interceptor.ts

@@ -1,77 +1,95 @@
-import { Injectable, inject } from '@angular/core';
-import {
-  HttpInterceptor,
-  HttpRequest,
-  HttpHandler,
-  HttpEvent,
-  HttpInterceptorFn,
-  HttpHandlerFn,
-} from '@angular/common/http';
+/**
+ * @license
+ * Copyright Mauricio Gemelli Vigolo and contributors.
+ *
+ * Use of this source code is governed by a MIT-style license that can be
+ * found in the LICENSE file at https://github.com/mauriciovigolo/keycloak-angular/blob/main/LICENSE.md
+ */
+
+import { HttpEvent, HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
+import { Injectable } from '@angular/core';
 
 import { Observable, combineLatest, from, of } from 'rxjs';
 import { mergeMap } from 'rxjs/operators';
 
-import { KeycloakService } from '../services/keycloak.service';
 import { ExcludedUrlRegex } from '../models/keycloak-options';
+import { KeycloakService } from '../services/keycloak.service';
 
-export const keycloakBearerInterceptor: HttpInterceptorFn = (req, next) => {
-  //return next(req);
-  const keycloak = inject(KeycloakService);
-  const { enableBearerInterceptor, excludedUrls } = keycloak;
-  if (!enableBearerInterceptor) {
-    return next(req);
+/**
+ * This interceptor includes the bearer by default in all HttpClient requests.
+ *
+ * If you need to exclude some URLs from adding the bearer, please, take a look
+ * at the {@link KeycloakOptions} bearerExcludedUrls property.
+ */
+@Injectable()
+export class KeycloakBearerInterceptor implements HttpInterceptor {
+  constructor(private keycloak: KeycloakService) {}
+
+  /**
+   * Calls to update the keycloak token if the request should update the token.
+   *
+   * @param req http request from @angular http module.
+   * @returns
+   * A promise boolean for the token update or noop result.
+   */
+  private async conditionallyUpdateToken(req: HttpRequest<unknown>): Promise<boolean> {
+    if (this.keycloak.shouldUpdateToken(req)) {
+      return await this.keycloak.updateToken();
+    }
+
+    return true;
   }
 
-  const shallPass: boolean =
-    !keycloak.shouldAddToken(req) ||
-    excludedUrls.findIndex((item) => isUrlExcluded(req, item)) > -1;
-  if (shallPass) {
-    return next(req);
+  /**
+   * @deprecated
+   * Checks if the url is excluded from having the Bearer Authorization
+   * header added.
+   *
+   * @param req http request from @angular http module.
+   * @param excludedUrlRegex contains the url pattern and the http methods,
+   * excluded from adding the bearer at the Http Request.
+   */
+  private isUrlExcluded({ method, url }: HttpRequest<unknown>, { urlPattern, httpMethods }: ExcludedUrlRegex): boolean {
+    const httpTest = httpMethods.length === 0 || httpMethods.join().indexOf(method.toUpperCase()) > -1;
+
+    const urlTest = urlPattern.test(url);
+
+    return httpTest && urlTest;
   }
 
-  return combineLatest([
-    from(conditionallyUpdateToken(req)),
-    of(keycloak.isLoggedIn()),
-  ]).pipe(
-    mergeMap(([_, isLoggedIn]) =>
-      isLoggedIn ? handleRequestWithTokenHeader(req, next) : next(req)
-    )
-  );
-};
+  /**
+   * Intercept implementation that checks if the request url matches the excludedUrls.
+   * If not, adds the Authorization header to the request if the user is logged in.
+   *
+   * @param req
+   * @param next
+   */
+  public intercept(req: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>> {
+    const { enableBearerInterceptor, excludedUrls } = this.keycloak;
+    if (!enableBearerInterceptor) {
+      return next.handle(req);
+    }
 
-function isUrlExcluded(
-  { method, url }: HttpRequest<unknown>,
-  { urlPattern, httpMethods }: ExcludedUrlRegex
-): boolean {
-  const httpTest =
-    httpMethods.length === 0 ||
-    httpMethods.join().indexOf(method.toUpperCase()) > -1;
+    const shallPass: boolean = !this.keycloak.shouldAddToken(req) || excludedUrls.findIndex(item => this.isUrlExcluded(req, item)) > -1;
+    if (shallPass) {
+      return next.handle(req);
+    }
 
-  const urlTest = urlPattern.test(url);
+    return combineLatest([from(this.conditionallyUpdateToken(req)), of(this.keycloak.isLoggedIn())]).pipe(mergeMap(([_, isLoggedIn]) => (isLoggedIn ? this.handleRequestWithTokenHeader(req, next) : next.handle(req))));
+  }
 
-  return httpTest && urlTest;
+  /**
+   * Adds the token of the current user to the Authorization header
+   *
+   * @param req
+   * @param next
+   */
+  private handleRequestWithTokenHeader(req: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>> {
+    return this.keycloak.addTokenToHeader(req.headers).pipe(
+      mergeMap(headersWithBearer => {
+        const kcReq = req.clone({ headers: headersWithBearer });
+        return next.handle(kcReq);
+      }),
+    );
+  }
 }
-
-function handleRequestWithTokenHeader(
-  req: HttpRequest<unknown>,
-  next: HttpHandlerFn
-): Observable<HttpEvent<unknown>> {
-  return this.keycloak.addTokenToHeader(req.headers).pipe(
-    mergeMap((headersWithBearer:string) => {
-      const kcReq = req.clone({
-        headers: req.headers.set('Authorization', headersWithBearer)
-      });//req.clone({ headers: headersWithBearer });
-      return next(kcReq);
-    })
-  );
-}
-
-async function conditionallyUpdateToken(
-  req: HttpRequest<unknown>
-): Promise<boolean> {
-  if (this.keycloak.shouldUpdateToken(req)) {
-    return await this.keycloak.updateToken();
-  }
-
-  return true;
-}