Merge pull request #1743 from Volune/feature-proxies-changeorigin

Feature(proxy): Allow to configure changeOrigin option of http-proxy
karma-runner · Dec 3, 2015 · e8fdf38 · e8fdf38
2 parents 1d8ca12 + f329e96
commit e8fdf38
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/docs/config/01-configuration-file.md b/docs/config/01-configuration-file.md
@@ -384,11 +384,21 @@ Note: Using `'https:'` requires you to specify `httpsServerOptions`.
 
 **Description:** A map of path-proxy pairs.
 
+The proxy can be specified directly by the target url or path, or with an object to configure more options. The available options are:
+
+- `target` The target url or path (mandatory)
+- `changeOrigin` Whether or not the proxy should override the Host header using the host from the target (default `false`)
+
 **Example:**
 ```javascript
 proxies: {
-'/static': 'http://gstatic.com',
-'/web': 'http://localhost:9000'
+  '/static': 'http://gstatic.com',
+  '/web': 'http://localhost:9000',
+  '/img/': '/base/test/images/',
+  '/proxyfied': {
+    'target': 'http://myserver.localhost',
+    'changeOrigin': true
+  }
 },
 ```
 

diff --git a/lib/middleware/proxy.js b/lib/middleware/proxy.js
@@ -13,7 +13,11 @@ var parseProxyConfig = function (proxies, config) {
     return []
   }
 
-  return _.sortBy(_.map(proxies, function (proxyUrl, proxyPath) {
+  return _.sortBy(_.map(proxies, function (proxyConfiguration, proxyPath) {
+    if (typeof proxyConfiguration === 'string') {
+      proxyConfiguration = {target: proxyConfiguration}
+    }
+    var proxyUrl = proxyConfiguration.target
     var proxyDetails = url.parse(proxyUrl)
     var pathname = proxyDetails.pathname
 
@@ -40,6 +44,7 @@ var parseProxyConfig = function (proxies, config) {
       (proxyDetails.protocol === 'https:' ? '443' : '80')
     var https = proxyDetails.protocol === 'https:'
 
+    var changeOrigin = 'changeOrigin' in proxyConfiguration ? proxyConfiguration.changeOrigin : false
     var proxy = httpProxy.createProxyServer({
       target: {
         host: hostname,
@@ -48,6 +53,7 @@ var parseProxyConfig = function (proxies, config) {
         protocol: protocol
       },
       xfwd: true,
+      changeOrigin: changeOrigin,
       secure: config.proxyValidateSSL
     })
 

diff --git a/test/unit/middleware/proxy.spec.js b/test/unit/middleware/proxy.spec.js
@@ -152,7 +152,7 @@ describe('middleware.proxy', () => {
     expect(parsedProxyConfig[0].proxy).to.exist
   })
 
-  it('should set defualt http port', () => {
+  it('should set default http port', () => {
     var proxy = {'/base/': 'http://localhost/'}
     var parsedProxyConfig = m.parseProxyConfig(proxy, {})
     expect(parsedProxyConfig).to.have.length(1)
@@ -291,6 +291,22 @@ describe('middleware.proxy', () => {
     expect(parsedProxyConfig[1].proxy).to.exist
   })
 
+  it('should accept object for proxy config', () => {
+    var proxy = {
+      '/base/': {target: 'http://localhost:8000/'}
+    }
+    var parsedProxyConfig = m.parseProxyConfig(proxy, {})
+    expect(parsedProxyConfig).to.have.length(1)
+    expect(parsedProxyConfig[0]).to.containSubset({
+      host: 'localhost',
+      port: '8000',
+      baseUrl: '/',
+      path: '/base/',
+      https: false
+    })
+    expect(parsedProxyConfig[0].proxy).to.exist
+  })
+
   it('should handle empty proxy config', () => {
     expect(m.parseProxyConfig({})).to.deep.equal([])
   })