Merge pull request #29 from jsnbuchanan/master

Add unique request part names to Content-Disposition header

Author: jonsamwell

README.md

@@ -170,6 +170,28 @@ For instance java servlet <= 3.1 parses multipart requests looking for the Conte
 
 See notes on running this with java servlet <= 3.1
 
+####uniqueRequestName
+
+An optional parameter to set a unique parameter name on the Content-Disposition header.
+This requires the use of `batchPartRequestHeaders` sending in a Content-Disposition header.  Sample configuration:
+
+```language-javascript
+  {
+    ...
+    batchPartRequestHeaders: {'Content-Disposition': 'form-data' },
+    uniqueRequestName: "batchRequest"
+    ...
+  }
+```
+
+Some backend servers may require that each part be named in this manner.
+If the configuration above is used, then each part will have a header like this:
+```Content-Disposition: form-data; name=batchRequest0```
+
+If a Content-Disposition header is not added in the `batchPartRequestHeaders` then this parameter
+is silently ignored.
+
+
 ####sendCookies
 False by default to reduce request size.  If this is set to true cookies available on the document.cookie property will be set
 in each segment of a batch request.  Note that only non HTTPOnly cookies will be sent as HTTPOnly cookies cannot be access by JavaScript

src/providers/httpBatchConfig.js

@@ -8,7 +8,8 @@ function HttpBatchConfigFn() {
       ignoredVerbs: ['head'],
       sendCookies: false,
       enabled: true,
-      adapter: defaultBatchAdapter
+      adapter: defaultBatchAdapter,
+      uniqueRequestName: null
     };
 
   /**

src/services/adapters/httpAdapter.js

@@ -8,7 +8,9 @@ function HttpBatchAdapter($document, $window, httpBatchConfig) {
       singleSpace: ' ',
       forwardSlash: '/',
       doubleDash: '--',
-      colon: ':'
+      colon: ':',
+      semiColon: ';',
+      requestName: 'name='
     };
 
   self.key = 'httpBatchAdapter';
@@ -47,7 +49,13 @@ function HttpBatchAdapter($document, $window, httpBatchConfig) {
       batchBody.push(constants.doubleDash + boundary);
       if (config.batchPartRequestHeaders) {
         for (header in config.batchPartRequestHeaders) {
-          batchBody.push(header + constants.colon + constants.singleSpace + config.batchPartRequestHeaders[header]);
+          if (config.batchPartRequestHeaders.hasOwnProperty(header)) {
+            var currHeader = header + constants.colon + constants.singleSpace + config.batchPartRequestHeaders[header];
+            if (header.toLowerCase() === "content-disposition" && config.uniqueRequestName !== null && config.uniqueRequestName !== undefined) {
+              currHeader += constants.semiColon + constants.singleSpace + constants.requestName + config.uniqueRequestName + i;
+            }
+            batchBody.push(currHeader);
+          }
         }
       }
 
@@ -170,7 +178,8 @@ function HttpBatchAdapter($document, $window, httpBatchConfig) {
   function findResponseBoundary(contentType) {
     var boundaryText = 'boundary=',
       startIndex = contentType.indexOf(boundaryText),
-      boundary = contentType.substring(startIndex + boundaryText.length);
+      endIndex = contentType.indexOf(';', startIndex),
+      boundary = contentType.substring(startIndex + boundaryText.length, endIndex > 0 ? endIndex : contentType.length);
 
     // the boundary might be quoted so remove the quotes
     boundary = boundary.replace(/"/g, constants.emptyString);

tests/providers/httpBatchConfig.spec.js

@@ -52,7 +52,8 @@
             batchEndpointUrl: batchEndpointUrl,
             enabled: true,
             sendCookies: false,
-            adapter: 'httpBatchAdapter'
+            adapter: 'httpBatchAdapter',
+            uniqueRequestName: null
           });
         });
 
@@ -71,7 +72,8 @@
             batchEndpointUrl: batchEndpointUrl,
             enabled: true,
             sendCookies: false,
-            adapter: 'httpBatchAdapter'
+            adapter: 'httpBatchAdapter',
+            uniqueRequestName: null
           });
         });
 

tests/services/adapters/httpAdapter.spec.js

@@ -120,6 +120,60 @@
             'GET api/some-method?params=123 HTTP/1.1\r\nHost: localhost:9876\r\n\r\n\r\n--boundary123--');
         });
 
+        it('should build the correct request that includes custom headers and a unique request name', function () {
+          var rawRequest = {
+              url: 'api/some-method?params=123',
+              method: 'GET'
+            },
+            config = {
+              batchEndpointUrl: 'batchEndpointUrl',
+              batchRequestHeaders: {
+                'Content-disposition': 'form-data'
+              },
+              batchPartRequestHeaders: {
+                'Content-disposition': 'form-data'
+              },
+              uniqueRequestName: "veryUniqueRequestName"
+            };
+
+          var result = httpAdapter.buildRequest([rawRequest], config);
+
+          expect(result.method).to.equal('POST');
+          expect(result.url).to.equal(config.batchEndpointUrl);
+          expect(result.cache).to.equal(false);
+          expect(result.headers['Content-Type']).to.equal('multipart/mixed; boundary=boundary123');
+          expect(result.headers['Content-disposition']).to.equal('form-data');
+          expect(result.data).to.equal('--boundary123\r\nContent-disposition: form-data; name=veryUniqueRequestName0\r\nContent-Type: application/http; msgtype=request\r\n\r\n' +
+            'GET api/some-method?params=123 HTTP/1.1\r\nHost: localhost:9876\r\n\r\n\r\n--boundary123--');
+        });
+
+        it('should ignore unique request name if content disposition is not sent', function () {
+          var rawRequest = {
+              url: 'api/some-method?params=123',
+              method: 'GET'
+            },
+            config = {
+              batchEndpointUrl: 'batchEndpointUrl',
+              batchRequestHeaders: {
+                'Custom-Header': 'sweet'
+              },
+              batchPartRequestHeaders: {
+                'Custom-Header': 'sweet'
+              },
+              uniqueRequestName: "veryUniqueRequestName"
+            };
+
+          var result = httpAdapter.buildRequest([rawRequest], config);
+
+          expect(result.method).to.equal('POST');
+          expect(result.url).to.equal(config.batchEndpointUrl);
+          expect(result.cache).to.equal(false);
+          expect(result.headers['Content-Type']).to.equal('multipart/mixed; boundary=boundary123');
+          expect(result.headers['Custom-Header']).to.equal('sweet');
+          expect(result.data).to.equal('--boundary123\r\nCustom-Header: sweet\r\nContent-Type: application/http; msgtype=request\r\n\r\n' +
+            'GET api/some-method?params=123 HTTP/1.1\r\nHost: localhost:9876\r\n\r\n\r\n--boundary123--');
+        });
+
         it('should build the correct request that includes uri ecoding the urls', function () {
           var rawRequest = {
               url: 'api/some method?params=123',
@@ -181,6 +235,40 @@
           expect(results[0].data[1].Id).to.equal(2);
           expect(results[0].data[2].Id).to.equal(3);
         });
+
+        it('should parse a single response with extra data on the Content-Type header', function () {
+          var rawRequest = {
+              url: 'api/some-method?params=123',
+              method: 'GET'
+            },
+            config = {
+              batchEndpointUrl: 'batchEndpointUrl'
+            },
+            responseData = '--boundary123\r\nContent-Type: application/http; msgtype=response\r\n\r\n' +
+            'HTTP/1.1 200 OK\r\nContent-Type: application/json; charset=utf-8\r\n\r\n' +
+            '[{"Name":"Product 1","Id":1,"StockQuantity":100},{"Name":"Product 2","Id":2,"StockQuantity":2},{"Name":"Product 3","Id":3,"StockQuantity":32432}]' +
+            '\r\n--boundary123--\r\n',
+            response = {
+              data: responseData,
+              headers: function () {
+                return {
+                  'content-type': 'multipart/mixed; boundary="boundary123"; charset=UTF-8'
+                };
+              }
+            };
+
+          var results = httpAdapter.parseResponse([rawRequest], response, config);
+
+          expect(results.length).to.equal(1);
+          expect(results[0].request).to.deep.equal(rawRequest);
+          expect(results[0].statusCode).to.equal(200);
+          expect(results[0].statusText).to.equal('OK');
+          expect(results[0].headers['Content-Type']).to.equal('json; charset=utf-8');
+          expect(results[0].data.length).to.equal(3);
+          expect(results[0].data[0].Id).to.equal(1);
+          expect(results[0].data[1].Id).to.equal(2);
+          expect(results[0].data[2].Id).to.equal(3);
+        });
       });
 
       describe('canBatchRequest', function () {