fix(functionality): Corrected a minor bug

Author: prog110

src/interceptor-service.ts

@@ -223,27 +223,27 @@ export class InterceptorService extends Http {
   private runBeforeInterceptors(params: InterceptorRequest): Observable<InterceptorRequest> {
     let request$: Observable<InterceptorRequest> = Observable.of(params);
 
-    for (let i = 0; i < this.interceptors.length; i++) {
-      const interceptor: Interceptor = this.interceptors[i];
+    for (let index = 0; index < this.interceptors.length; index++) {
+      const interceptor: Interceptor = this.interceptors[index];
       if (!interceptor.beforeRequest) {
         continue;
       }
 
       request$ = request$
-        .flatMap<InterceptorRequest, InterceptorRequest>((request: InterceptorRequest, index: number) => {
+        .flatMap<InterceptorRequest, InterceptorRequest>((request: InterceptorRequest, currentInterceptorIndex: number) => {
           const requestInternalBuilder = InterceptorRequestBuilderInternal.new(request);
 
           if (requestInternalBuilder.getErr() || requestInternalBuilder.getAlreadyShortCircuited()) {
             return Observable.of(request);
           } else if (requestInternalBuilder.getShortCircuitAtCurrentStep()) {
             const requestBuilder = InterceptorRequestBuilderInternal.new(request)
               .shortCircuitAtCurrentStep(false)
-              .shortCircuitTriggeredBy(this.interceptors.length - 1) // since the last interceptor in the chain asked for short circuiting
+              .shortCircuitTriggeredBy(currentInterceptorIndex - 1) // since the last interceptor requested for short circuit
               .alreadyShortCircuited(true);
             return Observable.of(requestBuilder.build());
           }
 
-          const processedRequest = interceptor.beforeRequest(request, index);
+          const processedRequest = interceptor.beforeRequest(request, currentInterceptorIndex);
           let processedRequest$: Observable<InterceptorRequest>;
 
           if (!processedRequest) { // if no request is returned; just proceed with the original request
@@ -257,7 +257,7 @@ export class InterceptorService extends Http {
             .catch((err: any, caught: Observable<InterceptorRequest>) => {
               const responseBuilder = InterceptorRequestBuilderInternal.new(request)
                 .err(err)
-                .errEncounteredAt(i);
+                .errEncounteredAt(currentInterceptorIndex);
               return Observable.of(responseBuilder.build());
             });
         });
@@ -296,9 +296,9 @@ export class InterceptorService extends Http {
             if (interceptor.onForceCompleteOrForceReturn !== undefined) {
               interceptor.onForceCompleteOrForceReturn(transformedResponseWrapper, index);
             }
-            if (index === 0) {
+            if (index === 0) { // complete the observable, since this is the first interceptor (last in the response chain)
               return Observable.empty();
-            } else {
+            } else { // let `onForceCompleteOrForceReturn` on the interceptors be run
               return Observable.of(transformedResponseWrapper);
             }
           } else if (transformedResponseWrapper.forceReturnResponse) {
@@ -308,14 +308,11 @@ export class InterceptorService extends Http {
             return Observable.of(transformedResponseWrapper);
           }
 
-          let processedResponse: void | InterceptorResponseWrapper | Observable<InterceptorResponseWrapper>;
-
-          const invokeErrHandler = transformedResponseWrapper.err && !transformedResponseWrapper.response;
-          const invokeShortCircuitHandler = transformedResponseWrapper.isShortCircuited() && !transformedResponseWrapper.response;
+          let processedResponse;
 
-          if (invokeErrHandler) {
-            processedResponse = interceptor.onErr(transformedResponseWrapper);
-          } else if (invokeShortCircuitHandler) {
+          if (transformedResponseWrapper.err) {
+            processedResponse = interceptor.onErr(transformedResponseWrapper, index);
+          } else if (transformedResponseWrapper.isShortCircuited()) {
             processedResponse = interceptor.onShortCircuit(transformedResponseWrapper, index);
           } else {
             processedResponse = interceptor.onResponse(transformedResponseWrapper, index);
@@ -334,7 +331,6 @@ export class InterceptorService extends Http {
           return procesedResponseWrapper$
             .catch((err: any, __: Observable<InterceptorResponseWrapper>) => {
               const responseBuilder = InterceptorResponseWrapperBuilderInternal.newInternal(index, transformedResponseWrapper)
-                .response(undefined)
                 .err(err)
                 .errEncounteredAt(index)
                 .errEncounteredInRequestCycle(false);

src/interceptor.ts

@@ -27,7 +27,7 @@ export interface Interceptor {
    *
    * Gives the ability to transform the request
    */
-  beforeRequest?(request: InterceptorRequest, interceptorStep?: number): Observable<InterceptorRequest> | InterceptorRequest | void;
+  beforeRequest?(request: InterceptorRequest, interceptorStep: number): Observable<InterceptorRequest> | InterceptorRequest | void;
 
   /**
    * Invoked once for each of the interceptors in the chain; in the reverse order of chain,\
@@ -48,7 +48,7 @@ export interface Interceptor {
    *  by looking at the `responseGeneratedByShortCircuitHandler` & `responseGeneratedByErrHandler` flags
    */
   onResponse?(response: InterceptorResponseWrapper,
-    interceptorStep?: number): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
+    interceptorStep: number): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
 
   /**
    * Invoked once for each of the interceptors in the chain; in the reverse order of chain,\
@@ -61,7 +61,7 @@ export interface Interceptor {
    * If no `onShortCircuit(..)` handlers before this handler returns any response, an error will be thrown back to the subscriber
    */
   onShortCircuit?(response: InterceptorResponseWrapper,
-    interceptorStep?: number): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
+    interceptorStep: number): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
 
   /**
    * Invoked when the flow encounters any error along the interceptor chain.
@@ -72,14 +72,14 @@ export interface Interceptor {
    *  & the final result would be sent to the subscriber via next(..) callback
    * If no `onErr(..)` handlers before this handler returns any response, the error will be thrown back to the subscriber
    */
-  onErr?(err: any): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
+  onErr?(err: any, interceptorStep: number): Observable<InterceptorResponseWrapper> | InterceptorResponseWrapper | void;
 
   /**
    * Invoked when any one in the interceptor chain forces request completion/return response/error
    * Use this method to perform opeations that should be performed irrespective of what the interceptors in the chain want
    * such as stopping progress bar/logging
    */
-  onForceCompleteOrForceReturn?(response?: InterceptorResponseWrapper,
-    interceptorStep?: number): void;
+  onForceCompleteOrForceReturn?(response: InterceptorResponseWrapper,
+    interceptorStep: number): void;
 
 }