[3scale_batcher] Update regrex to match key with special chars

Currently, when key is base64 encoded or contains special chars, the
batcher policy will save it to the cache but won't be able to retrieve
it due to the regrex mismatch. This leads to two problems:
* Reports are not sent to the backend
* Report cache filling up over time.

This commit changes the regular expression key to accept any character
except spaces.

CHANGELOG.md

@@ -39,6 +39,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Replace luafilesystem-ffi with [luafilesystem](https://github.com/lunarmodules/luafilesystem) [PR #1445](https://github.com/3scale/APIcast/pull/1445) [THREESCALE-10662](https://issues.redhat.com/browse/THREESCALE-10662)
 
+- Fixed 3scale Batcher policy unable to handle base64 encoded `user_key` [PR #1453](https://github.com/3scale/APIcast/pull/1453) [THREESCALE-10934](https://issues.redhat.com/browse/THREESCALE-10934)
+
 ### Added
 
 - Detect number of CPU shares when running on Cgroups V2 [PR #1410](https://github.com/3scale/apicast/pull/1410) [THREESCALE-10167](https://issues.redhat.com/browse/THREESCALE-10167)

gateway/src/apicast/policy/3scale_batcher/keys_helper.lua

@@ -39,9 +39,9 @@ local function metrics_part_in_key(usage)
 end
 
 local regexes_report_key = {
-  [[service_id:(?<service_id>[\w-]+),user_key:(?<user_key>[\w-]+),metric:(?<metric>[\S-]+)]],
+  [[service_id:(?<service_id>[\w-]+),user_key:(?<user_key>[\S-]+),metric:(?<metric>[\S-]+)]],
   [[service_id:(?<service_id>[\w-]+),access_token:(?<access_token>[\w-]+),metric:(?<metric>[\S-]+)]],
-  [[service_id:(?<service_id>[\w-]+),app_id:(?<app_id>[\w-]+),app_key:(?<app_key>[\w-]+),metric:(?<metric>[\S-]+)]],
+  [[service_id:(?<service_id>[\w-]+),app_id:(?<app_id>[\w-]+),app_key:(?<app_key>[\S-]+),metric:(?<metric>[\S-]+)]],
   [[service_id:(?<service_id>[\w-]+),app_id:(?<app_id>[\w-]+),metric:(?<metric>[\S-]+)]],
 }
 

spec/policy/3scale_batcher/keys_helper_spec.lua

@@ -34,6 +34,11 @@ describe('Keys Helper', function()
 
       local report = keys_helper.report_from_key_batched_report(key)
       assert.same({ service_id = 's1', app_id = 'ai', app_key = 'ak', metric = 'm1' }, report)
+
+      -- special chars
+      key = 'service_id:s1,app_id:ai,app_key:!#$%&\'()*+,-.:;<=>?@[]^_`{|}~,metric:m1'
+      report = keys_helper.report_from_key_batched_report(key)
+      assert.same({ service_id = 's1', app_id = 'ai', app_key = '!#$%&\'()*+,-.:;<=>?@[]^_`{|}~', metric = 'm1' }, report)
     end)
 
     it('returns a valid metric in case of special chars', function()
@@ -56,6 +61,24 @@ describe('Keys Helper', function()
 
       local report = keys_helper.report_from_key_batched_report(key)
       assert.same({ service_id = 's1', user_key = 'uk', metric = 'm1' }, report)
+
+      key = 'service_id:s1,user_key:you-&$#!!!,metric:m1'
+      report = keys_helper.report_from_key_batched_report(key)
+      assert.same({ service_id = 's1', user_key = 'you-&$#!!!', metric = 'm1' }, report)
+
+      -- Base64
+      key = 'service_id:s1,user_key:aGVsbG93b3JsZAo=,metric:m1'
+      report = keys_helper.report_from_key_batched_report(key)
+      assert.same({ service_id = 's1', user_key = 'aGVsbG93b3JsZAo=', metric = 'm1' }, report)
+
+    end)
+
+    it('returns an error when user_key has space', function()
+      local key = 'service_id:s1,app_id:ai,app_key:I have spaces,metric:m%1'
+      assert.returns_error('credentials not found', keys_helper.report_from_key_batched_report(key))
+
+      key = 'service_id:s1,user_key:I have spaces,metric:m1'
+      assert.returns_error('credentials not found', keys_helper.report_from_key_batched_report(key))
     end)
 
     it('returns a report given a key of a batched report with access token', function()