feat(httpClient): add basePath option for gateways with custom url patterns

fixes #38

Author: Benedikt Rötsch

lib/create-http-client.js

@@ -41,7 +41,8 @@ export default function createHttpClient (axios, options) {
     httpAgent: false,
     httpsAgent: false,
     timeout: 30000,
-    proxy: false
+    proxy: false,
+    basePath: ''
   }
   const config = Object.assign({}, defaultConfig, options)
 
@@ -65,7 +66,13 @@ export default function createHttpClient (axios, options) {
       hostname = parsed[0]
     }
   }
-  const baseURL = `${protocol}://${hostname}:${port}/spaces/${space}`
+
+  // Ensure that basePath does start but not end with a slash
+  if (config.basePath) {
+    config.basePath = `/${config.basePath.split('/').filter(Boolean).join('/')}`
+  }
+
+  const baseURL = `${protocol}://${hostname}:${port}${config.basePath}/spaces/${space}`
 
   config.headers['Authorization'] = 'Bearer ' + config.accessToken
 

test/unit/create-http-client-test.js

@@ -16,6 +16,7 @@ function teardown () {
   createHttpClientRewireApi.__ResetDependency__('rateLimit')
   mock.reset()
   axios.create.restore()
+  logHandlerStub.resetHistory()
 }
 
 test('Calls axios with expected default URL', t => {
@@ -97,3 +98,31 @@ test('Fails with missing access token', t => {
     t.end()
   }
 })
+
+test('Calls axios based on passed hostname with basePath', t => {
+  setup()
+  createHttpClient(axios, {
+    accessToken: 'clientAccessToken',
+    host: 'some.random.example.com',
+    basePath: '/foo/bar'
+  })
+
+  t.equals(axios.create.args[0][0].baseURL, 'https://some.random.example.com:443/foo/bar/spaces/')
+  t.equals(logHandlerStub.callCount, 0, 'does not log anything')
+  teardown()
+  t.end()
+})
+
+test('Calls axios based on passed hostname with invalid basePath and fixes the invalid one', t => {
+  setup()
+  createHttpClient(axios, {
+    accessToken: 'clientAccessToken',
+    host: 'some.random.example.com',
+    basePath: 'foo/bar'
+  })
+
+  t.equals(axios.create.args[0][0].baseURL, 'https://some.random.example.com:443/foo/bar/spaces/')
+  t.equals(logHandlerStub.callCount, 0, 'does not log anything')
+  teardown()
+  t.end()
+})