(refactor) plugins to remove dependencies to kong.tools and use more PDK #3845

bungle · 2018-10-10T18:54:01Z

Summary

This contains changes to following plugins and their test suite? This is rebased on @hishamhm's https://github.com/Kong/kong/tree/feat/plugins-update-new-apis branch (#3844) which should be merged and REVIEWed before this.

acl
basic-auth
correlation-id
hmac-auth
jwt
ldap-auth
rate-limiting (still has some flaky tests)
request-termination

Also contains a small fix to a typo on key-auth plugin.

kong/plugins/acl/api.lua

kong/plugins/key-auth/handler.lua

kong/plugins/basic-auth/handler.lua

hishamhm · 2018-10-15T18:55:58Z

kong/plugins/correlation-id/handler.lua

+      )
+    end,
+  }, { __index = function(_, generator)
+      kong.log.err("Invalid generator: " .. generator)


This extra metatable that's added for error-checking only is effectively dead code, because the schema guarantees that conf.generator is always valid. I think we could remove this and make generators a simple table.

(I realize this was in the original code already, just noticed that and thought we could clean it up)

hishamhm · 2018-10-15T18:57:36Z

kong/plugins/hmac-auth/access.lua

@@ -28,6 +24,7 @@ local DIGEST = "digest"
 local SIGNATURE_NOT_VALID = "HMAC signature cannot be verified"
 local SIGNATURE_NOT_SAME = "HMAC signature does not match"

+
 local new_tab


new_tab can be removed and replaced by kong.table.new

hishamhm · 2018-10-15T19:00:43Z

kong/plugins/hmac-auth/access.lua

  -- parse the header to retrieve hamc parameters
  if authorization_header then
-    local iterator, iter_err = ngx_gmatch(authorization_header, "\\s*[Hh]mac\\s*username=\"(.+)\",\\s*algorithm=\"(.+)\",\\s*headers=\"(.+)\",\\s*signature=\"(.+)\"")
+    local iterator, iter_err = re_gmatch(authorization_header,
+                                          "\\s*[Hh]mac\\s*username=\"(.+)\",\\s*algorithm=\"(.+)\",\\s*headers=\"(.+)\",\\s*signature=\"(.+)\"")


you can reduce the line by breaking this long string into shorter ones connected by .. (don't worry, the compiler's constant-subexpression-elimination will make it into a single string)

hishamhm · 2018-10-15T20:08:30Z

kong/plugins/hmac-auth/access.lua

-  local signature_2 = ngx_decode_base64(hmac_params.signature)
+
+local function validate_signature(hmac_params)
+  local signature_1 = create_hash(ngx.var.request_uri, hmac_params)


It's unfortunate we still need to rely on ngx.var.request_uri here, but I guess it's because we don't have an exact equivalent in the PDK, right? Would this be our best shot sticking to the current PDK API?

local function get_path_and_query() local p = ngx.request.get_path() local q = ngx.request.get_raw_query() return (q ~= "") and (p .. "?" .. q) or p end

(which is inefficient because get_path strips the query from ngx.var.request_uri and then this adds it back, I know.)

Is this pattern common enough to warrant a kong.request.get_path_and_query function? (The aws-lambda plugin does the same as the above, but that's mostly for backwards compat with the "request_uri" info being forwarded)

hishamhm · 2018-10-15T21:18:43Z

kong/plugins/request-termination/handler.lua

-    local ctx = ngx.ctx
-    if ctx.delay_response and not ctx.delayed_response then
-      ctx.delayed_response = {
+    local shared_ctx = kong.ctx.shared


The whole delayed_response logic (and flush function) can be replaced by kong.response.exit, which takes care of it. It is possible to just do

if content then return kong.response.exit(status, content, { ["Content-Type"] = conf.content_type }) end

instead of this whole block, also removing the flush function above.

hishamhm · 2018-10-15T21:24:34Z

kong/plugins/rate-limiting/policies/init.lua

+end
+
+
+local function get_timestamps(now)


Copying these functions multiple times inside the same plugin feels wrong. If the idea is to move them out of kong.tools.* and into the plugin, then maybe create a timestamps utility module inside the plugin for them?

Only two times. Is that the threshold, when to make a new library and modification to rocks.

I can get back to just using kong.tools.timestamp module.

hishamhm · 2018-10-15T21:28:09Z

kong/plugins/rate-limiting/policies/init.lua

 local fmt = string.format


-local NULL_UUID = "00000000-0000-0000-0000-000000000000"
+local log_err = kong and kong.log.err or function(...)


Is this here because of tests where kong is not available? If that's the case, I'd rather just populate kong.log.err in the test case before testing this module instead of leaking ngx.log here.

hishamhm

I think the delayed_response in request-termination is the biggest issue (unless I missed something there that makes that code necessary.)

fixed

thibaultcha · 2018-10-18T19:33:11Z

kong/plugins/acl/handler.lua

-    ngx_log(ngx_error, "[acl plugin] Cannot identify the consumer, add an ",
-                       "authentication plugin to use the ACL plugin")
-    return responses.send_HTTP_FORBIDDEN("You cannot consume this service")
+    kong.log.err("Cannot identify the consumer, add an authentication " ..


It is still preferred to use the variadic form of this function, (, instead of ..).

thibaultcha · 2018-10-18T19:40:22Z

kong/plugins/basic-auth/basicauth_credentials.lua

+  end
+
+  return re_find(str, uuid_regex, 'ioj') ~= nil
+end


Why are we duplicating is_valid_uuid? This is a blocker. The scope of this work is not to get rid of kong.tools.utils.

kong/plugins/hmac-auth/access.lua

thibaultcha · 2018-10-18T19:45:44Z

kong/plugins/jwt/asn_sequence.lua

  return input
 end

+


Such vendor files ideally should be left untouched and are not subject to our coding style, as pulling fixes from upstream becomes harder.

thibaultcha · 2018-10-18T19:47:35Z

kong/plugins/ldap-auth/handler.lua

 LdapAuthHandler.PRIORITY = 1002
-LdapAuthHandler.VERSION = "0.1.0"
+LdapAuthHandler.VERSION = "0.1.1"


All of these massive updates warrant increasing the second digit (e.g. 0.2.0) in all of these plugins, instead of the patch digit.

…lugin

…ion-id plugin

…uest-termination plugin

…ting plugin

bungle added the pr/please review label Oct 10, 2018

bungle force-pushed the feat/plugins-update-new-apis-pt2 branch 6 times, most recently from 42e7340 to 8174bf7 Compare October 15, 2018 17:44

hishamhm reviewed Oct 15, 2018

View reviewed changes

kong/plugins/acl/api.lua Show resolved Hide resolved

hishamhm reviewed Oct 15, 2018

View reviewed changes

kong/plugins/key-auth/handler.lua Show resolved Hide resolved

hishamhm reviewed Oct 15, 2018

View reviewed changes

kong/plugins/basic-auth/handler.lua Outdated Show resolved Hide resolved

hishamhm reviewed Oct 15, 2018

View reviewed changes

hishamhm previously requested changes Oct 15, 2018

View reviewed changes

bungle force-pushed the feat/plugins-update-new-apis-pt2 branch 2 times, most recently from 7e7efbf to 44830e1 Compare October 16, 2018 15:39

This was referenced Oct 16, 2018

feat(pdk) add kong.request.get_path_and_querystring #3859

Closed

Kong is not able to recognize "JSON Merge Patch" content type #3823

Closed

bungle force-pushed the feat/plugins-update-new-apis-pt2 branch from 44830e1 to f427b25 Compare October 17, 2018 15:10

bungle force-pushed the feat/plugins-update-new-apis-pt2 branch 4 times, most recently from ffe251b to b16b0d3 Compare October 17, 2018 23:36

thibaultcha reviewed Oct 18, 2018

View reviewed changes

thibaultcha requested changes Oct 18, 2018

View reviewed changes

bungle added 9 commits October 19, 2018 14:01

style(key-auth) fix a typo in word occurred

0a5bf7e

refactor(acl) remove kong.tools.* dependency from acl plugin

d18e1a5

refactor(basic-auth) remove kong.tools.* dependency from basic-auth p…

561245c

…lugin

refactor(correlation-id) remove kong.tools.* dependency from correlat…

f84af08

…ion-id plugin

refactor(hmac-auth) remove kong.tools.* dependency from hmac-auth plugin

3ce4414

refactor(jwt) remove kong.tools.* dependency from jwt plugin

31eb7f7

refactor(ldap-auth) remove kong.tools.* dependency from ldap-auth plugin

e335610

refactor(request-termination) remove kong.tools.* dependency from req…

03d2e98

…uest-termination plugin

refactor(rate-limiting) remove kong.tools.* dependency from rate-limi…

0ad4aa3

…ting plugin

bungle force-pushed the feat/plugins-update-new-apis-pt2 branch from b16b0d3 to 0ad4aa3 Compare October 19, 2018 11:02

thibaultcha approved these changes Oct 20, 2018

View reviewed changes

thibaultcha merged commit e147b4c into next Oct 20, 2018

thibaultcha deleted the feat/plugins-update-new-apis-pt2 branch October 20, 2018 01:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(refactor) plugins to remove dependencies to kong.tools and use more PDK #3845

(refactor) plugins to remove dependencies to kong.tools and use more PDK #3845

bungle commented Oct 10, 2018 •

edited

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018

hishamhm Oct 15, 2018 •

edited

bungle Oct 16, 2018 •

edited

bungle Oct 16, 2018

hishamhm Oct 15, 2018

hishamhm left a comment

thibaultcha Oct 18, 2018

thibaultcha Oct 18, 2018

thibaultcha Oct 18, 2018

thibaultcha Oct 18, 2018

(refactor) plugins to remove dependencies to kong.tools and use more PDK #3845

(refactor) plugins to remove dependencies to kong.tools and use more PDK #3845

Conversation

bungle commented Oct 10, 2018 • edited

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hishamhm Oct 15, 2018 • edited

Choose a reason for hiding this comment

bungle Oct 16, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hishamhm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bungle commented Oct 10, 2018 •

edited

hishamhm Oct 15, 2018 •

edited

bungle Oct 16, 2018 •

edited