Adding a flag to disable automatic inclusion of the x-requested-with …

…header, issue dojo#328
rorticus · Jul 31, 2017 · bbf0f44 · bbf0f44
1 parent 806b22c
commit bbf0f44
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/request/providers/xhr.ts b/src/request/providers/xhr.ts
@@ -18,6 +18,7 @@ import SubscriptionPool from '../SubscriptionPool';
  */
 export interface XhrRequestOptions extends RequestOptions {
 	blockMainThread?: boolean;
+	includeRequestedWithHeader?: boolean;
 }
 
 interface RequestData {
@@ -270,6 +271,7 @@ export default function xhr(url: string, options: XhrRequestOptions = {}): Uploa
 
 	let hasContentTypeHeader = false;
 	let hasRequestedWithHeader = false;
+	const { includeRequestedWithHeader = true } = options;
 
 	if (options.headers) {
 		const requestHeaders = new Headers(options.headers);
@@ -282,7 +284,7 @@ export default function xhr(url: string, options: XhrRequestOptions = {}): Uploa
 		});
 	}
 
-	if (!hasRequestedWithHeader) {
+	if (!hasRequestedWithHeader && includeRequestedWithHeader) {
 		request.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
 	}
 

diff --git a/tests/unit/request/xhr.ts b/tests/unit/request/xhr.ts
@@ -403,6 +403,18 @@ registerSuite({
 						}
 					});
 				});
+			},
+
+			'X-Requested-With headers can be disabled'(this: any) {
+				if (!echoServerAvailable) {
+					this.skip('No echo server available');
+				}
+				const options = {includeRequestedWithHeader: false};
+				return xhrRequest('/__echo/default', options).then(function (response: any) {
+					return response.json().then((data: any) => {
+						assert.isUndefined(data.headers['x-requested-with']);
+					});
+				});
 			}
 		}
 	},