fixed service version configuration via environment variable

Author: samugi

CHANGELOG.md

@@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Fix to avoid uninitialized variables when request URI is too large [PR #1340](https://github.com/3scale/APIcast/pull/1340) [THREESCALE-7906](https://issues.redhat.com/browse/THREESCALE-7906)
 - Fixed issue where request path is stripped for proxied https requests [PR #1342](https://github.com/3scale/APIcast/pull/1342) [THREESCALE-8426](https://issues.redhat.com/browse/THREESCALE-8426)
 - Bumped liquid-lua to version 0.2.0-2 [PR #1369](https://github.com/3scale/APIcast/pull/1369) - includes: [THREESCALE-8483](https://issues.redhat.com/browse/THREESCALE-8483) and [THREESCALE-8484](https://issues.redhat.com/browse/THREESCALE-8484)
+- New /admin/api/account/proxy_configs endpoint for configuration loading [PR #1352](https://github.com/3scale/APIcast/pull/1352) [THREESCALE-8508](https://issues.redhat.com/browse/THREESCALE-8508)
 
 ### Added
 

gateway/src/apicast/configuration_loader/remote_v2.lua

@@ -137,6 +137,19 @@ local function parse_resp_body(self, resp_body)
   return cjson.encode(config)
 end
 
+local function use_service_version(portal_endpoint_has_path)
+  local vars = resty_env.list()
+  for n, v in pairs(vars) do
+    if match(n, "APICAST_SERVICE_\\d+_CONFIGURATION_VERSION") and v and v ~= ''
+      and portal_endpoint_has_path then
+        ngx.log(ngx.INFO, "APICAST_SERVICE_${ID}_CONFIGURATION_VERSION is configured: ",
+          "services will be loaded individually")
+        return true
+    end
+  end
+  return false
+end
+
 -- When the APICAST_LOAD_SERVICES_WHEN_NEEDED is enabled, but the config loader
 -- is boot, APICAST_LOAD_SERVICES_WHEN_NEEDED is going to be ignored. But in
 -- that case, env refers to a host and we need to reset it to pick the env
@@ -150,12 +163,8 @@ end
 -- http://${THREESCALE_PORTAL_ENDPOINT}/<env>.json?host=host
 -- http://${THREESCALE_PORTAL_ENDPOINT}/admin/api/account/proxy_configs/<env>.json?host=host&version=version
 local function configuration_endpoint_params(env, host, portal_endpoint_path)
-  local version = resty_env.get(
-      format('APICAST_SERVICE_%s_CONFIGURATION_VERSION', service_id)
-  ) or "latest"
-
   return portal_endpoint_path and {path = env, args = {host = host}}
-    or {path = '/admin/api/account/proxy_configs/' .. env, args = {host = host, version = version} }
+    or {path = '/admin/api/account/proxy_configs/' .. env, args = {host = host, version = "latest"} }
 end
 
 function _M:index(host)
@@ -172,6 +181,13 @@ function _M:index(host)
     return nil, 'missing environment'
   end
 
+  -- Exit from index if a service version is configured because
+  -- in that case we have to retrieve the services individually
+  -- through the "old" services endpoint.
+  if use_service_version(not self.path and true) then
+    return nil, 'wrong endpoint url'
+  end
+
   local endpoint_params = configuration_endpoint_params(env, host, self.path)
   local base_url = resty_url.join(self.endpoint, endpoint_params.path .. '.json')
   local query_args = encode_args(endpoint_params.args) ~= '' and '?'..encode_args(endpoint_params.args)
@@ -211,16 +227,14 @@ function _M:call(environment)
       return ret, err
     end
 
-    if load_just_for_host then
-      return m:call(host)
-    else
-      return m:call()
-    end
+    return m:call()
+
   end
 
-  -- Everything past this point in `call()` is deprecated because
-  -- now the configuration load is handled completely by `index()`.
-  -- Service filtering is done in configuration.lua
+  -- Unless APICAST_SERVICE_${ID}_CONFIGURATION_VERSION is set,
+  -- everything past this point in `call()` is skipped because
+  -- otherwise the configuration load is handled completely by
+  -- `index()`. Service filtering is done in configuration.lua
   local http_client = self.http_client
 
   if not http_client then

spec/configuration_loader/remote_v2_spec.lua

@@ -455,6 +455,23 @@ UwIDAQAB
 
   describe(':index', function()
 
+    it('invalid status is handled', function()
+      loader = _M.new('http://example.com/', { client = test_backend })
+      env.set('THREESCALE_DEPLOYMENT_ENV', 'production')
+      env.set('APICAST_CONFIGURATION_LOADER', 'lazy')
+      test_backend.expect{ url = 'http://example.com/admin/api/account/proxy_configs/production.json?version=latest' }.
+        respond_with{ status = 512, body = nil}
+      assert.same({ nil, 'invalid status' }, { loader:index() })
+    end)
+
+    it('returns "wrong endpoint url" when service version is configured', function()
+      loader = _M.new('http://example.com/', { client = test_backend })
+      env.set('THREESCALE_DEPLOYMENT_ENV', 'production')
+      env.set('APICAST_SERVICE_2_CONFIGURATION_VERSION', 42)
+      env.set('APICAST_CONFIGURATION_LOADER', 'lazy')
+      assert.same({ nil, 'wrong endpoint url' }, { loader:index() })
+    end)
+
     it('returns configuration for all services (no path on endpoint)', function()
       loader = _M.new('http://example.com/', { client = test_backend })
       env.set('THREESCALE_DEPLOYMENT_ENV', 'production')

t/configuration-loading-lazy.t

@@ -155,3 +155,51 @@ using lazy configuration loader
 OIDC url is not valid, uri:
 --- no_error_log
 [error]
+
+=== TEST 6: load configuration with APICAST_SERVICE_${ID}_CONFIGURATION_VERSION
+--- env eval
+(
+  'APICAST_CONFIGURATION_LOADER' => 'lazy',
+  'THREESCALE_PORTAL_ENDPOINT' => "http://test:$ENV{TEST_NGINX_SERVER_PORT}",
+  'APICAST_SERVICE_2_CONFIGURATION_VERSION' => 42
+)
+--- upstream env
+    location = /admin/api/services.json {
+        echo '{ "services": [ { "service": { "id": 2 } } ] }';
+    }
+    location = /admin/api/services/2/proxy/configs/production/42.json {
+        echo '
+        {
+            "proxy_config": {
+                "content": {
+                    "id": 2,
+                    "backend_version": 1,
+                    "proxy": {
+                        "hosts": [ "localhost" ],
+                        "api_backend": "http://test:$TEST_NGINX_SERVER_PORT/",
+                        "proxy_rules": [
+                            { "pattern": "/t", "http_method": "GET", "metric_system_name": "test","delta": 1 }
+                        ]
+                    }
+                }
+            }
+        }';
+    }
+
+    location /t {
+        echo "all ok";
+    }
+
+--- backend
+    location /transactions/authrep.xml {
+      content_by_lua_block {
+        ngx.exit(200)
+      }
+    }
+--- request
+GET /t?user_key=fake
+--- error_code: 200
+--- error_log
+using lazy configuration loader
+--- no_error_log
+[error]