Skip to content

Commit

Permalink
Mapping rules: Avoid issues with double slash.
Browse files Browse the repository at this point in the history
Due to the work make in APIAP, the double slash can happen quite easily,
as described in THREESCALE-3950. With this commit, when a new
mapping_rule is defined, double slash will be simplified to one to be
able to match with ngx.var.uri.

FIX THREESCALE-3950

Signed-off-by: Eloy Coto <eloy.coto@gmail.com>
  • Loading branch information
eloycoto committed Jan 20, 2020
1 parent 1d26a86 commit c0a23dc
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Add the correct host header when using an http proxy [THREESCALE-4178](https://issues.jboss.org/browse/THREESCALE-4178) [PR #1143](https://github.com/3scale/APIcast/pull/1143)
- Normalize policy names capitalization [THREESCALE-4150](https://issues.jboss.org/browse/THREESCALE-4150) [PR #1154](https://github.com/3scale/APIcast/pull/1154)
- Fix issues with non-alphanumeric variables in liquid [THREESCALE-3968](https://issues.jboss.org/browse/THREESCALE-3968) [PR #1158](https://github.com/3scale/APIcast/pull/1158)
- Fix issues with double mapping rules [THREESCALE-3950](https://issues.jboss.org/browse/THREESCALE-3950) [PR #1159](https://github.com/3scale/APIcast/pull/1159)



### Fixed
Expand Down
5 changes: 5 additions & 0 deletions gateway/src/apicast/mapping_rule.lua
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ local function hash_to_array(hash)
end

local function regexpify(pattern)
-- some urls in APIAP uses double / that it's a valid url, but ngx.var.uri
-- eliminates the duplicates, so mapping rule needs to remove the duplicates
-- ones.
pattern = re_gsub(pattern,[[\/\/+]], '/', 'oj')

pattern = re_gsub(pattern, [[\?.*]], '', 'oj')
-- dollar sign is escaped by another $, see https://github.com/openresty/lua-nginx-module#ngxresub
pattern = re_gsub(pattern, [[\{.+?\}]], [[([\w-.~%!$$&'()*+,;=@:]+)]], 'oj')
Expand Down
8 changes: 8 additions & 0 deletions gateway/src/apicast/policy/soap/soap.lua
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ local MappingRule = require('apicast.mapping_rule')
local Usage = require('apicast.usage')
local mapping_rules_matcher = require('apicast.mapping_rules_matcher')
local MimeType = require('resty.mime')
local resty_url = require 'resty.url'

local policy = require('apicast.policy')

Expand Down Expand Up @@ -90,6 +91,13 @@ end
function _M:rewrite(context)
local soap_action_uri = extract_soap_uri()

-- If the soap_action_uri is a complete url, the mapping rule is only the
-- path, so parse to send only the path.
local url, err = resty_url.parse(soap_action_uri)
if not err then
soap_action_uri = url.path
end

if soap_action_uri then
local soap_usage = usage_from_matching_rules(
soap_action_uri, self.mapping_rules)
Expand Down
23 changes: 23 additions & 0 deletions spec/mapping_rule_spec.lua
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,29 @@ describe('mapping_rule', function()
assert.is_true(mapping_rule:matches('GET', '/foo/a:b/bar'))
assert.is_true(mapping_rule:matches('GET', "/foo/a%b/bar"))
end)

it('double slashes are transformed correctly to a simple one', function()
local test_cases = {
["/foo//bar"] = "/foo/bar",
["/foo///bar"] = "/foo/bar",
["/foo/ /bar"] = "/foo/ /bar",
["/foo/bar///"] = "/foo/bar/",
["///foo///bar///"] = "/foo/bar/",
}

for key, value in pairs(test_cases) do
local mapping_rule = MappingRule.from_proxy_rule({
http_method = 'GET',
pattern = key,
querystring_parameters = { },
metric_system_name = 'hits',
delta = 1
})

assert.is_true(mapping_rule:matches('GET', value), "Invalid key:" .. key)
end

end)
end)

describe('.any_method', function()
Expand Down
8 changes: 4 additions & 4 deletions spec/policy/soap/soap_spec.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ describe('SOAP policy', function()
describe('.rewrite', function()
local context -- Context shared between policies

local full_url = "http://www.example.com:80/path/to/myfile.html?" ..
"key1=value1&key2=value2#SomewhereInTheDocument"

local base_url = "http://www.example.com:80"
local base_path = "/path/to/myfile.html?key1=value1&key2=value2#SomewhereInTheDocument"
local full_url = base_url .. base_path
-- Define a config with 3 rules. Their patterns have values that allow us
-- to easily associate them with a SOAP action receive via SOAPAction
-- header or via Content-Type. The third one is used to tests matching of
Expand All @@ -24,7 +24,7 @@ describe('SOAP policy', function()
delta = 20
},
{
pattern = full_url,
pattern = base_path,
metric_system_name = 'hits',
delta = 30
},
Expand Down

0 comments on commit c0a23dc

Please sign in to comment.