Merge pull request #213 from 3scale/warn-host-clashes

[config] print warning when multiple services share host

Author: mikz

apicast/src/configuration_store.lua

@@ -3,9 +3,13 @@ local ipairs = ipairs
 local pairs = pairs
 local tostring = tostring
 local insert = table.insert
+local next = next
+
+local util = require 'util'
 
 local _M = {
-  _VERSION = '0.1'
+  _VERSION = '0.1',
+  path_routing = util.env_enabled('APICAST_PATH_ROUTING_ENABLED')
 }
 
 local mt = { __index = _M }
@@ -81,9 +85,15 @@ function _M.add(self, service)
     local index = hosts[host] or {}
     local id = tostring(service.id)
 
+    local exists = not _M.path_routing and next(index)
+
     index[id] = service
     all[id] = service
     hosts[host] = index
+
+    if exists then
+      ngx.log(ngx.WARN, 'host ', host, ' for service ', id, ' already defined by service ', exists)
+    end
   end
 end
 

apicast/src/provider.lua

@@ -151,7 +151,7 @@ local function find_service_cascade(host)
   return find_service_strict(host)
 end
 
-if util.env_enabled('APICAST_PATH_ROUTING_ENABLED') then
+if configuration_store.path_routing then
   ngx.log(ngx.WARN, 'apicast experimental path routing enabled')
   _M.find_service = find_service_cascade
 else

t/003-apicast.t

@@ -491,3 +491,28 @@ GET /test?user_key=foo
 --- response_body
 api response
 --- error_code: 200
+
+=== TEST 11: print warning on duplicate service hosts
+So when booting it can be immediately known that some of them won't work.
+--- http_config
+  lua_package_path "$TEST_NGINX_LUA_PATH";
+--- config
+location /t {
+  content_by_lua_block {
+    require('provider').configure({
+      services = {
+        { id = 1, proxy = { hosts = { 'foo', 'bar' } } },
+        { id = 2, proxy = { hosts = { 'foo', 'daz' } } },
+      }
+    })
+    ngx.say('all ok')
+  }
+}
+--- request
+GET /t
+--- response_body
+all ok
+--- log_level: warn
+--- error_code: 200
+--- error_log
+host foo for service 2 already defined by service 1