feat(filter-request): Added ability to filter specific requests by defining optional configuration parameter function

Author: jonsamwell

CHANGELOG.md

@@ -1,3 +1,11 @@
+1.0.5
+========
+Added ability to have fine grained control over the request that get batched by adding an optional canBatchRequest function on the configuration object.
+
+1.0.4
+========
+Fix to header parsing that would truncate a return header if there was a space it's value i.e. Header: Some Value
+
 1.0.3
 ========
 Build update

README.md

@@ -25,6 +25,7 @@ Working demo https://plnkr.co/edit/OgvZ09iYO64VoXHLRGQa?p=preview
   - [Send Cookies](#config-sendCookies)
   - [Unique Request Name (content-dispositon header)](#config-uniqueRequestName)
   - [Http Batching Adapter](#config-httpBatchingAdapter)
+  - [Can Batch Request](#config-canBatchRequest)
   - [On Before Send Batch Request Handler](#config-onBeforeSendBatchRequest)
 - [.Net WebApi Configuation](#config-net)
 - [Configuring for Java Servlet <= 3.1](#config-javaservlet)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-http-batcher",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Angular (2+) HTTP batching module to reduce the number of HTTP requests and increase performance",
   "scripts": {
     "build": "./node_modules/.bin/ngc -p ./src",
@@ -26,10 +26,10 @@
   "module": "./index.js",
   "types": "./index.d.ts",
   "devDependencies": {
-    "@angular/common": "^4.1.1",
-    "@angular/compiler-cli": "^4.1.1",
-    "@angular/platform-browser": "^4.1.1",
-    "@angular/platform-browser-dynamic": "^4.1.1",
+    "@angular/common": "^4.4.6",
+    "@angular/compiler-cli": "^4.4.6",
+    "@angular/platform-browser": "^4.4.6",
+    "@angular/platform-browser-dynamic": "^4.4.6",
     "@types/jasmine": "^2.5.47",
     "@types/node": "^7.0.18",
     "clean-webpack-plugin": "^0.1.16",
@@ -49,15 +49,15 @@
     "ts-loader": "^2.0.3",
     "tslint": "^5.2.0",
     "tslint-loader": "^3.5.3",
-    "typescript": "^2.3.2",
+    "typescript": "^2.3.4",
     "uglify-js": "^2.8.23",
     "webpack": "^2.5.1"
   },
   "dependencies": {
-    "@angular/compiler": "^4.1.1",
-    "@angular/core": "^4.1.1",
-    "@angular/http": "^4.1.1",
-    "rxjs": "^5.3.0",
-    "zone.js": "^0.8.9"
+    "@angular/compiler": "^4.4.6",
+    "@angular/core": "^4.4.6",
+    "@angular/http": "^4.4.6",
+    "rxjs": "^5.4.2",
+    "zone.js": "^0.8.18"
   }
 }

src/batch-configuration.ts

@@ -90,6 +90,14 @@ export interface IHttpBatchConfigurationOptions {
    */
   httpBatchingAdapter?: WellKnownHttpBatchingAdapters | IBatchHttpRequestAdapter;
 
+  /**
+   * An optional function which determines if the request can be batched
+   *
+   * @memberof IHttpBatchConfigurationOptions
+   * @type (request: Request) => boolean;
+   */
+  canBatchRequest?: (request: Request) => boolean;
+
   /**
    * Lifecycle hook to modify the batch request just before it is sent.  This can be use to add aditional
    * headers to the request. eg: "Authorisation: Bearer ..."
@@ -111,6 +119,7 @@ export class HttpBatchConfiguration {
   public uniqueRequestName: string;
   public sendCookies: boolean;
   public httpBatchingAdapter: WellKnownHttpBatchingAdapters | IBatchHttpRequestAdapter;
+  public canBatchRequest: (request: Request) => boolean;
   public onBeforeSendBatchRequest: (batchRequest: Request) => void;
 
   public constructor(options: IHttpBatchConfigurationOptions) {
@@ -124,6 +133,7 @@ export class HttpBatchConfiguration {
     this.uniqueRequestName = options.uniqueRequestName;
     this.sendCookies = options.sendCookies !== undefined ? options.sendCookies : false;
     this.httpBatchingAdapter = options.httpBatchingAdapter || WellKnownHttpBatchingAdapters.Http_MultipartMixed;
+    this.canBatchRequest = options.canBatchRequest || (() => true);
     // tslint:disable-next-line:no-empty
     this.onBeforeSendBatchRequest = options.onBeforeSendBatchRequest || (() => {});
   }

src/services/http-batcher.service.ts

@@ -38,20 +38,28 @@ export class HttpBatcher extends Http {
   public request(url: string | Request, options?: RequestOptionsArgs): Observable<Response> {
     const enpointUrl = url instanceof Request ? (url as Request).url : url;
     const configuration = this.batchingConfigurations.getConfigurationForUrl(enpointUrl);
-    if (this.canBatchRequest(configuration)) {
+    if (this.batchingEnabled(configuration)) {
       const request = url instanceof Request ?
         url as Request :
         new Request(this.mergeOptions(this._defaultOptions, options, RequestMethod.Get, url as string));
-      return this.batchRequest(request, configuration);
+      if (this.canBatchRequest(configuration, request)) {
+        return this.batchRequest(request, configuration);
+      } else {
+        return super.request(url, options);
+      }
     } else {
       return super.request(url, options);
     }
   }
 
-  protected canBatchRequest(configuration: HttpBatchConfiguration): boolean {
+  protected batchingEnabled(configuration: HttpBatchConfiguration): boolean {
     return configuration !== undefined && configuration.enabled;
   }
 
+  protected canBatchRequest(configuration: HttpBatchConfiguration, request: Request): boolean {
+    return configuration.canBatchRequest(request);
+  }
+
   protected batchRequest(request: Request, configuration: HttpBatchConfiguration): Observable<Response> {
     return new Observable<Response>((observer: Observer<Response>) => {
       const bacthRequest = {