feat(rpt-interceptor): add RPT refresh logic to auth interceptor & cl…

…eanup code (#129)

src/app/auth/authentication.service.spec.ts

@@ -9,14 +9,14 @@ import { AuthInterceptor } from '../shared/auth.interceptor';
 import { SSO_API_URL } from '../shared/sso-api';
 import { AUTH_API_URL } from '../shared/auth-api';
 import { REALM } from '../shared/realm-token';
+import { WIT_API_URL } from '../shared/wit-api';
 
 describe('Service: Authentication service', () => {
 
-  const authUrl: string = 'http://example.com/';
+  const authUrl: string = 'http://auth.example.com/';
   let authenticationService: AuthenticationService;
   let broadcaster: Broadcaster;
   let httpClient: HttpClient;
-  let httpClientTestingModule: HttpClientTestingModule;
   let httpTestingController: HttpTestingController;
 
   beforeEach(() => {
@@ -31,18 +31,10 @@ describe('Service: Authentication service', () => {
           useClass: AuthInterceptor,
           multi: true
         },
-        {
-          provide: AUTH_API_URL,
-          useValue: 'http://example.com/'
-        },
-        {
-          provide: REALM,
-          useValue: 'fabric8'
-        },
-        {
-          provide: SSO_API_URL,
-          useValue: 'http://example.com/auth'
-        },
+        { provide: REALM, useValue: 'fabric8' },
+        { provide: AUTH_API_URL, useValue: 'http://auth.example.com/' },
+        { provide: SSO_API_URL, useValue: 'http://sso.example.com/auth' },
+        { provide: WIT_API_URL, useValue: 'http://wit.example.com'},
         Broadcaster
       ]
     });

src/app/auth/authentication.service.ts

@@ -9,7 +9,6 @@ import { AUTH_API_URL } from '../shared/auth-api';
 import { SSO_API_URL } from '../shared/sso-api';
 import { REALM } from '../shared/realm-token';
 import { Token } from '../user/token';
-import { isAuthenticationError } from '../shared/isAuthenticationError';
 import { ConnectableObservable } from 'rxjs/internal/observable/ConnectableObservable';
 
 export interface ProcessTokenResponse {
@@ -100,8 +99,7 @@ export class AuthenticationService {
     let tokenUrl = this.apiUrl + `token?force_pull=true&for=` + encodeURIComponent(cluster);
     const httpOptions = {
       headers: new HttpHeaders({
-        'Content-Type':  'application/json',
-        'Authorization': `Bearer ${this.getToken()}`
+        'Content-Type':  'application/json'
       })
     };
     return this.http.get(tokenUrl, httpOptions)

src/app/shared/auth.interceptor.spec.ts

@@ -6,10 +6,15 @@ import {
 import { TestBed } from '@angular/core/testing';
 import { Broadcaster } from 'ngx-base';
 import { AuthInterceptor } from './auth.interceptor';
+import { WIT_API_URL } from './wit-api';
+import { AUTH_API_URL } from './auth-api';
+import { SSO_API_URL } from './sso-api';
 
 describe(`AuthHttpInterceptor`, () => {
-  const testUrl: string = 'http://localhost/test';
+  const testUrl: string = 'http://auth.example.com/test';
+  const otherUrl: string = 'http://other.example.com/test';
   const testToken: string = 'test_token';
+  const rptToken = 'new_token_with_rpt_data';
 
   let httpMock: HttpTestingController;
   let httpClient: HttpClient;
@@ -24,16 +29,17 @@ describe(`AuthHttpInterceptor`, () => {
           useClass: AuthInterceptor,
           multi: true
         },
+        { provide: WIT_API_URL, useValue: 'http://wit.example.com'},
+        { provide: AUTH_API_URL, useValue: 'http://auth.example.com'},
+        { provide: SSO_API_URL, useValue: 'http://sso.example.com'},
         Broadcaster
       ]
     });
     httpMock = TestBed.get(HttpTestingController);
     httpClient = TestBed.get(HttpClient);
     broadcaster = TestBed.get(Broadcaster);
 
-    spyOn(localStorage, 'getItem').and.callFake( (key: string): string => {
-      return key === 'auth_token' ? testToken : null;
-    });
+    localStorage.setItem('auth_token', testToken);
   });
   afterEach(() => {
     httpMock.verify();
@@ -44,8 +50,39 @@ describe(`AuthHttpInterceptor`, () => {
 
     const req = httpMock.expectOne(testUrl);
 
+    expect(req.request.headers.has('Authorization')).toBeTruthy();
+    expect(req.request.headers.get('Authorization')).toBe(`Bearer ${testToken}`);
+  });
+
+  it('should not intercept request if the URL is not valid auth endpoint', () => {
+    httpClient.get(otherUrl).subscribe(() => {});
+
+    const req = httpMock.expectOne(otherUrl);
+
+    // should not add authorization header
+    expect(req.request.headers.has('Authorization')).toBeFalsy();
+  });
+
+  it('should update auth_token if there is a new RPT token in response header', () => {
+    httpClient.get(testUrl, { observe: 'response' }).subscribe(res => {
+      expect(res.headers.has('Authorization')).toBeTruthy();
+      expect(res.headers.get('Authorization')).toBe(`Bearer ${rptToken}`);
+    });
+
+    const req = httpMock.expectOne(testUrl);
+
+    // mock response
+    req.flush(
+      { data: 'mock-data' },
+      { headers: { 'Authorization': `Bearer ${rptToken}` } }
+    );
+
+    // check if request sends proper auth headers
     expect(req.request.headers.has('Authorization'));
     expect(req.request.headers.get('Authorization')).toBe(`Bearer ${testToken}`);
+
+    // check if localStorage is updated with new RPT token
+    expect(localStorage.getItem('auth_token')).toBe(rptToken);
   });
 
   it('should broadcast authenticationError event on 401 with code jwt_security_error', () => {

src/app/shared/auth.interceptor.ts

@@ -13,17 +13,26 @@ import { tap } from 'rxjs/operators';
 
 import { Broadcaster } from 'ngx-base';
 
-import { isAuthenticationError } from './isAuthenticationError';
+import { WIT_API_URL } from './wit-api';
+import { AUTH_API_URL } from './auth-api';
+import { SSO_API_URL } from './sso-api';
 
 @Injectable()
 export class AuthInterceptor implements HttpInterceptor {
 
-  constructor(@Inject(forwardRef(() => Broadcaster)) private broadcaster: Broadcaster) {
-  }
+  constructor(
+    @Inject(forwardRef(() => Broadcaster)) private broadcaster: Broadcaster,
+    @Inject(WIT_API_URL) private witApiUrl: string,
+    @Inject(AUTH_API_URL) private authApiUrl: string,
+    @Inject(SSO_API_URL) private ssoUrl: string
+  ) {}
 
   intercept(request: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
+    if (!this.isAuthUrl(request.url)) {
+      return next.handle(request);
+    }
+
     let token = localStorage.getItem('auth_token');
-    let ok: string;
     if (token !== null) {
       request = request.clone({
         setHeaders: {
@@ -35,20 +44,45 @@ export class AuthInterceptor implements HttpInterceptor {
       .pipe(
         tap(
           // Succeeds when there is a response; ignore other events
-          event => ok = event instanceof HttpResponse ? 'succeeded' : '',
+          event => event instanceof HttpResponse ? this.refreshRPT(event) : '',
           // Operation failed; error is an HttpErrorResponse
-          error => {
-            if (error instanceof HttpErrorResponse) {
-              const res: HttpErrorResponse = error;
-              if (res.status === 403 || isAuthenticationError(res)) {
-                this.broadcaster.broadcast('authenticationError', res);
-              } else if (res.status === 500) {
-                this.broadcaster.broadcast('communicationError', res);
-              }
-            }
-            return throwError(error);
-          }
+          error => error instanceof HttpErrorResponse ? this.catchError(error) : throwError(error)
         )
       );
   }
+
+  private refreshRPT(res: HttpResponse<any>) {
+    if (res.headers.has('Authorization')) {
+      const token = localStorage.getItem('auth_token');
+      const newToken = res.headers.get('Authorization').replace('Bearer ', '');
+      if (token !== newToken) {
+        localStorage.setItem('auth_token', newToken);
+      }
+    }
+  }
+
+  private catchError(res: HttpErrorResponse) {
+    if (res.status === 403 || this.isAuthenticationError(res)) {
+      this.broadcaster.broadcast('authenticationError', res);
+    } else if (res.status === 500) {
+      this.broadcaster.broadcast('communicationError', res);
+    }
+  }
+
+  private isAuthenticationError(res: HttpErrorResponse): boolean {
+    if (res.status === 401) {
+      const json: any = res.error;
+      const hasErrors: boolean = json && Array.isArray(json.errors);
+      const isJwtError: boolean = hasErrors &&
+        json.errors.filter((e: any) => e.code === 'jwt_security_error').length >= 1;
+      const authHeader = res.headers.get('www-authenticate');
+      const isLoginHeader = authHeader && authHeader.toLowerCase().includes('login');
+      return isJwtError || isLoginHeader;
+    }
+    return false;
+  }
+
+  private isAuthUrl(url: string) {
+    return url.startsWith(this.witApiUrl) || url.startsWith(this.authApiUrl) || url.startsWith(this.ssoUrl);
+  }
 }

src/app/shared/wit-api.ts

@@ -0,0 +1,3 @@
+import { InjectionToken } from '@angular/core';
+
+export let WIT_API_URL = new InjectionToken<string>('fabric8.wit.api.url');

src/app/user/user.service.spec.ts

@@ -1,11 +1,14 @@
-import { HttpHeaders } from '@angular/common/http';
+import { HttpHeaders, HTTP_INTERCEPTORS } from '@angular/common/http';
 import { HttpClientTestingModule, HttpTestingController} from '@angular/common/http/testing';
 import { TestBed } from '@angular/core/testing';
 
 import { Broadcaster, Logger } from 'ngx-base';
 
 import { AUTH_API_URL } from '../shared/auth-api';
 import { UserService } from './user.service';
+import { AuthInterceptor } from '../shared/auth.interceptor';
+import { SSO_API_URL } from '../shared/sso-api';
+import { WIT_API_URL } from '../shared/wit-api';
 
 
 describe('Service: User service', () => {
@@ -20,9 +23,13 @@ describe('Service: User service', () => {
       providers: [
         UserService,
         {
-          provide: AUTH_API_URL,
-          useValue: 'http://example.com/'
+          provide: HTTP_INTERCEPTORS,
+          useClass: AuthInterceptor,
+          multi: true
         },
+        { provide: AUTH_API_URL, useValue: 'http://auth.example.com/' },
+        { provide: SSO_API_URL, useValue: 'http://sso.example.com/auth' },
+        { provide: WIT_API_URL, useValue: 'http://wit.example.com'},
         Broadcaster,
         Logger
       ]