feat($http): provide a config object as an argument to header functions

pkozlowski-opensource · pkozlowski-opensource · commit d435464c51d3 · 2015-01-20T19:42:59.000+01:00
Closes angular#7235 Closes angular#10622
diff --git a/src/ng/http.js b/src/ng/http.js
@@ -615,7 +615,7 @@ function $HttpProvider() {
      *    - **data** – `{string|Object}` – Data to be sent as the request message data.
      *    - **headers** – `{Object}` – Map of strings or functions which return strings representing
      *      HTTP headers to send to the server. If the return value of a function is null, the
-     *      header will not be sent.
+     *      header will not be sent. Functions accept a config object as an argument.
      *    - **xsrfHeaderName** – `{string}` – Name of HTTP header to populate with the XSRF token.
      *    - **xsrfCookieName** – `{string}` – Name of cookie containing the XSRF token.
      *    - **transformRequest** –
@@ -834,12 +834,12 @@ function $HttpProvider() {
           : $q.reject(resp);
       }
 
-      function executeHeaderFns(headers) {
+      function executeHeaderFns(headers, config) {
         var headerContent, processedHeaders = {};
 
         forEach(headers, function(headerFn, header) {
           if (isFunction(headerFn)) {
-            headerContent = headerFn();
+            headerContent = headerFn(config);
             if (headerContent != null) {
               processedHeaders[header] = headerContent;
             }
@@ -873,7 +873,7 @@ function $HttpProvider() {
         }
 
         // execute if header value is a function for merged headers
-        return executeHeaderFns(reqHeaders);
+        return executeHeaderFns(reqHeaders, shallowCopy(config));
       }
     }
 
diff --git a/test/ng/httpSpec.js b/test/ng/httpSpec.js
@@ -781,6 +781,34 @@ describe('$http', function() {
         $httpBackend.flush();
       });
 
+      it('should expose a config object to header functions', function() {
+        var config = {
+          foo: 'Rewritten',
+          headers: {'Accept': function(config) {
+            return config.foo;
+          }}
+        };
+
+        $httpBackend.expect('GET', '/url', undefined, {Accept: 'Rewritten'}).respond('');
+        $http.get('/url', config);
+        $httpBackend.flush();
+      });
+
+      it('should not allow modifications to a config object in header functions', function() {
+        var config = {
+          headers: {'Accept': function(config) {
+            config.foo = 'bar';
+            return 'Rewritten';
+          }}
+        };
+
+        $httpBackend.expect('GET', '/url', undefined, {Accept: 'Rewritten'}).respond('');
+        $http.get('/url', config);
+        $httpBackend.flush();
+
+        expect(config.foo).toBeUndefined();
+      });
+
       it('should check the cache before checking the XSRF cookie', inject(function($browser, $cacheFactory) {
         var testCache = $cacheFactory('testCache'),
             executionOrder = [];

Original file line number	Diff line number	Diff line change
`@@ -615,7 +615,7 @@ function $HttpProvider() {`
`615`	`615`	* - data – `{string\|Object}` – Data to be sent as the request message data.
`616`	`616`	* - headers – `{Object}` – Map of strings or functions which return strings representing
`617`	`617`	`* HTTP headers to send to the server. If the return value of a function is null, the`
`618`		`- * header will not be sent.`
	`618`	`+ * header will not be sent. Functions accept a config object as an argument.`
`619`	`619`	* - xsrfHeaderName – `{string}` – Name of HTTP header to populate with the XSRF token.
`620`	`620`	* - xsrfCookieName – `{string}` – Name of cookie containing the XSRF token.
`621`	`621`	`* - transformRequest –`
`@@ -834,12 +834,12 @@ function $HttpProvider() {`
`834`	`834`	`: $q.reject(resp);`
`835`	`835`	`}`
`836`	`836`
`837`		`- function executeHeaderFns(headers) {`
	`837`	`+ function executeHeaderFns(headers, config) {`
`838`	`838`	`var headerContent, processedHeaders = {};`
`839`	`839`
`840`	`840`	`forEach(headers, function(headerFn, header) {`
`841`	`841`	`if (isFunction(headerFn)) {`
`842`		`- headerContent = headerFn();`
	`842`	`+ headerContent = headerFn(config);`
`843`	`843`	`if (headerContent != null) {`
`844`	`844`	`processedHeaders[header] = headerContent;`
`845`	`845`	`}`
`@@ -873,7 +873,7 @@ function $HttpProvider() {`
`873`	`873`	`}`
`874`	`874`
`875`	`875`	`// execute if header value is a function for merged headers`
`876`		`- return executeHeaderFns(reqHeaders);`
	`876`	`+ return executeHeaderFns(reqHeaders, shallowCopy(config));`
`877`	`877`	`}`
`878`	`878`	`}`
`879`	`879`