Handling default headers to account for any header references in interceptors

Author: Carlos Atencio

example/protractor-conf.js

@@ -1,7 +1,7 @@
 var config = {
     baseUrl: 'http://localhost:8000/',
     specs: [
-      'spec/requestsMade.spec.js'
+      'spec/*.spec.js'
     ],
     mocks: {
       dir: 'mocks',

lib/httpMock.js

@@ -228,8 +228,22 @@ function mockTemplate() {
             };
         }
 
+        function addToRequestHistory(config){
+            var copy = angular.copy(config);
+
+            // This is done to maintain backwards compatability
+            // as well as providing a cleaner request history
+            if(angular.equals(copy.headers, {})){
+                delete copy.headers;
+            }
+
+            newModule.requests.push(copy);
+        }
+
         function httpMock(config){
             var prom;
+
+            config.headers = config.headers || {};
             var transformedConfig = getTransformedAndInterceptedRequestConfig(angular.copy(config));
 
             return wrapWithSuccessError($q.when(transformedConfig).then(function(resolvedConfig) {
@@ -238,7 +252,7 @@ function mockTemplate() {
                 if(expectation){
                     var deferred = $q.defer();
 
-                    newModule.requests.push(resolvedConfig);
+                    addToRequestHistory(resolvedConfig);
 
                     var delay = expectation.response.delay || 0;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "protractor-http-mock",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Mock HTTP calls in your protractor specs.",
   "main": "index.js",
   "scripts": {

tests/interceptors.test.js

@@ -63,6 +63,27 @@ describe('interceptors', function(){
 				}
 			}
 		}]);
+
+		$httpProvider.interceptors.push(['$q', function($q){
+			return {
+				request: function(config){
+					if(config.url.match(/with-headers/)){
+						config.headers['authorization'] = 'token';
+					}
+
+					return config;
+				},
+				response: function(response){
+					if(response.config.url.match(/with-headers/)){
+						response.headers['response-header'] = 'response-header';
+
+						return $q.when(response);
+					}
+
+					return response;
+				}
+			}
+		}]);
 	}]);
 
 	it('allows intercepts through service factory functions', function(done){
@@ -107,4 +128,14 @@ describe('interceptors', function(){
 			done();
 		});
 	});
+
+	it('provides default empty object headers if none are set', function(done){
+		http({
+			method: 'GET',
+			url: 'test-url.com/with-headers'
+		}).then(function(response){
+			expect(response.headers['response-header']).toBe('response-header');
+			done();
+		});
+	});
 });

tests/requests.test.js

@@ -6,20 +6,16 @@ describe('requests', function(){
 	});
 
 	it('captures and clears requests', function(done){
-		http({
-			method: 'GET',
-			url: 'test-api.com/user'
-		});
-
 		http.head('/head').then(function(){
-			expect(module.requests.length).toBeGreaterThan(1);
+			expect(module.requests.length).toBeGreaterThan(0);
 
 			var found = false;
 
 			module.requests.forEach(function(request){
 				if(request.method === 'HEAD'){
 					found = true;
 					expect(request.url).toBe('/head');
+					expect(request.headers).not.toBeDefined();
 				}
 			});
 
@@ -30,4 +26,33 @@ describe('requests', function(){
 			done();
 		});
 	});
+
+	it('captures requests with headers', function(done){
+		http({
+			method: 'get',
+			url: '/user',
+			headers: {
+				'x-auth': 'pass',
+				'gzip-pro': 'yes'
+			}
+		}).then(function(){
+			expect(module.requests.length).toBeGreaterThan(0);
+
+			var found = false;
+
+			module.requests.forEach(function(request){
+				if(request.headers){
+					found = true;
+					expect(request.url).toBe('/user');
+					expect(request.headers).toEqual({
+						'x-auth': 'pass',
+						'gzip-pro': 'yes'
+					});
+				}
+			});
+
+			expect(found).toBe(true);
+			done();
+		});
+	});
 });