WS-2092: Unify the response format in case of an error at the service level

Author: Shuai Zhang

src/lua/api-gateway/validation/validatorsHandlerErrorDecorator.lua

@@ -100,7 +100,10 @@ function ValidatorHandlerErrorDecorator:decorateResponse( response_status, respo
                 ngx.header[k] = val
             end
         end
-        ngx.say(o.message)
+        -- ngx.say(o.message)
+        -- add custom message
+        local msg = self:parseResponseMessage(o.message)
+        ngx.say(msg)
         return
     end
 
@@ -114,6 +117,29 @@ function ValidatorHandlerErrorDecorator:decorateResponse( response_status, respo
     ngx.exit( response_status )
 end
 
+--- Parse the response message and replace any variables, if found (at most 3 variables)
+-- @param message Response message
+--
+function ValidatorHandlerErrorDecorator:parseResponseMessage(message)
+    local m = message
+    local from, to, var, varName, value
+    local cnt = 0
+    while cnt < 3 do
+        from, to = ngx.re.find(m, "ngx.var.[a-zA-Z_0-9]+", "jo")
+        if(from) then
+            var = string.sub(m, from, to)
+            varName = string.sub(m, from + 8, to) -- "+ 8" jump over "ngx.var."
+            value = ngx.var[varName]
+            m = string.gsub(m, var, value)
+        else
+            break
+        end
+        cnt = cnt + 1
+    end
+    -- all variables have been replaced
+    return m
+end
+
 -- hook to overwrite the DEFAULT_RESPONSES by specifying a jsonString
 function ValidatorHandlerErrorDecorator:setUserDefinedResponsesFromJson( jsonString )
     if ( jsonString == nil or #jsonString < 2) then

test/perl/api-gateway/validation/key/api_key.t

@@ -132,6 +132,7 @@ GET /test-api-key?api_key=ab123
 --- config
         include ../../api-gateway/api_key_service.conf;
         include ../../api-gateway/default_validators.conf;
+        error_log ../test-logs/api_key_test5_error.log debug;
         location /test-api-key-5 {
             set $service_id s-123;
 

test/perl/api-gateway/validation/oauth2/oauthTokenValidator.t

@@ -109,7 +109,7 @@ GET /test-oauth-validation
 
             set $key 'cachedoauth:$authtoken_hash';
             content_by_lua '
-                local BaseValidator = require "api-gateway.core.validator"
+                local BaseValidator = require "api-gateway.validation.validator"
                 local TestValidator = BaseValidator:new()
                 local validator = TestValidator:new()
                 local res = validator:getKeyFromRedis(ngx.var.key, "token_json")

test/perl/api-gateway/validation/oauth2/userProfileValidator.t

@@ -73,7 +73,7 @@ __DATA__
             set_md5 $authtoken_hash $authtoken;
             set $key 'cachedoauth:$authtoken_hash';
             content_by_lua '
-                local BaseValidator = require "api-gateway.core.validator"
+                local BaseValidator = require "api-gateway.validation.validator"
                 local v = BaseValidator:new()
                 local k = v:getKeyFromLocalCache(ngx.var.key,"cachedUserProfiles")
                 v:exitFn(200,"Local: " .. tostring(k))
@@ -87,7 +87,7 @@ __DATA__
             set_md5 $authtoken_hash $authtoken;
             set $key 'cachedoauth:$authtoken_hash';
             content_by_lua '
-                local BaseValidator = require "api-gateway.core.validator"
+                local BaseValidator = require "api-gateway.validation.validator"
                 local v = BaseValidator:new()
                 local k = v:getKeyFromRedis(ngx.var.key,"user_json")
                 v:exitFn(200,"Redis: " .. tostring(k))
@@ -136,7 +136,7 @@ Authorization: Bearer SOME_OAUTH_PROFILE_TEST_1
 
         location /local-cache {
             content_by_lua '
-                local BaseValidator = require "api-gateway.core.validator"
+                local BaseValidator = require "api-gateway.validation.validator"
                 local v = BaseValidator:new()
                 local k = v:getKeyFromLocalCache("cachedoauth:8cd12eadb5032aa2153c8f830d01e0be","cachedUserProfiles")
                 v:exitFn(200,k)
@@ -145,7 +145,7 @@ Authorization: Bearer SOME_OAUTH_PROFILE_TEST_1
 
         location /redis-cache {
             content_by_lua '
-                local BaseValidator = require "api-gateway.core.validator"
+                local BaseValidator = require "api-gateway.validation.validator"
                 local v = BaseValidator:new()
                 local k = v:getKeyFromRedis("cachedoauth:8cd12eadb5032aa2153c8f830d01e0be","user_json")
                 v:exitFn(200,k)

test/perl/api-gateway/validation/validatorHandler.t

@@ -330,7 +330,7 @@ Content-Type: text/plain"
             "VALIDATOR_401_ERROR" : {
                 "http_status" : 503,
                 "error_code"  : 401,
-                "message"     : "{\\"error_code\\": \\"-1\\",\\"message\\":\\"custom error message\\"}",
+                "message"     : "{\\"error_code\\": \\"-1\\",\\"message\\":\\"custom error message\\", \\"requestID\\":\\"ngx.var.requestID\\", \\"another_ID\\":\\"ngx.var.another_ID\\", \\"var3\\":\\"ngx.var.var3\\", \\"var4\\":\\"ngx.var.var4\\"}",
                 "headers"     : {
                     "custom-header-1": "header-1-value",
                     "custom-header-2": "ngx.var.custom_header_2"
@@ -354,6 +354,10 @@ Content-Type: text/plain"
              set $request_validator_1   "on; path=/validator_1; order=1;";
              set $request_validator_2 "on; path=/validator_2; order=2;";
              set $custom_header_2 "this is a lua variable";
+             set $requestID "message customization finished";
+             set $another_ID "another field";
+             set $var3 "var3 value";
+             set $var4 "var4 value";
 
              access_by_lua "ngx.apiGateway.validation.validateRequest()";
              content_by_lua '
@@ -385,7 +389,7 @@ Content-Type: text/plain"
 ]
 --- response_body_like eval
 [
-'^{"error_code": "-1","message":"custom error message"}+',
+'^{"error_code": "-1","message":"custom error message", "requestID":"message customization finished", "another_ID":"another field", "var3":"var3 value", "var4":"ngx.var.var4"}+',
 '^{"error_code":"403010","message":"Oauth token is missing."}+',
 "You did not send any key"
 ]

test/resources/api-gateway/api_key_service.conf

@@ -92,7 +92,7 @@ location ~ /cache/api_key/get {
         deny all;
     }
 
-    set $key $arg_key;
+    set $api_key $arg_key;
     set $service_id $arg_service_id;
 
     # set $redis_cmd "HMGET cachedkey:$key:$service_id service-id service-name realm consumer-org-name app-name plan-name";
@@ -109,7 +109,7 @@ location ~ /cache/api_key/get {
         end;
         ';
 
-    content_by_lua_file /opt/ADBE/api-gateway/api-gateway-core/scripts/api_key_validator.lua;
+    content_by_lua 'ngx.apiGateway.validation.validateApiKey()';
 }
 
 # pure REST API URI where POST goes to /set, GET to /get, DELETE to /del through internal redirect