chore(plugins) remove deprecated BasePlugin

It has been removed from the docs for some time, but the core still has to check each method to see if it's actually reimplemented or just inherited. Updated everal fixture plugins that still used it.
Kong · Oct 14, 2021 · f901f00 · f901f00
1 parent 66ec8af
commit f901f00
Show file tree

Hide file tree

Showing 25 changed files with 81 additions and 379 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -73,6 +73,7 @@
   plugin configurations `service_tag`, `consumer_tag`, and `status_tag`.
   [#6230](https://github.com/Kong/kong/pull/6230)
   Thanks [onematchfox](https://github.com/onematchfox) for the patch!
+- The deprecated **BasePlugin** has been removed. [#7961](https://github.com/Kong/kong/pull/7961)
 
 [Back to TOC](#table-of-contents)
 

diff --git a/kong-2.6.0-0.rockspec b/kong-2.6.0-0.rockspec
@@ -87,7 +87,6 @@ build = {
     ["kong.resty.dns.client"] = "kong/resty/dns/client.lua",
     ["kong.resty.dns.utils"] = "kong/resty/dns/utils.lua",
     ["kong.resty.ctx"] = "kong/resty/ctx.lua",
-    ["kong.vendor.classic"] = "kong/vendor/classic.lua",
 
     ["kong.cmd"] = "kong/cmd/init.lua",
     ["kong.cmd.roar"] = "kong/cmd/roar.lua",
@@ -252,8 +251,6 @@ build = {
     ["kong.pdk.nginx"] = "kong/pdk/nginx.lua",
     ["kong.pdk.cluster"] = "kong/pdk/cluster.lua",
 
-    ["kong.plugins.base_plugin"] = "kong/plugins/base_plugin.lua",
-
     ["kong.plugins.basic-auth.migrations"] = "kong/plugins/basic-auth/migrations/init.lua",
     ["kong.plugins.basic-auth.migrations.000_base_basic_auth"] = "kong/plugins/basic-auth/migrations/000_base_basic_auth.lua",
     ["kong.plugins.basic-auth.migrations.002_130_to_140"] = "kong/plugins/basic-auth/migrations/002_130_to_140.lua",

diff --git a/kong/db/dao/plugins.lua b/kong/db/dao/plugins.lua
@@ -2,7 +2,6 @@ local constants = require "kong.constants"
 local utils = require "kong.tools.utils"
 local DAO = require "kong.db.dao"
 local plugin_loader = require "kong.db.schema.plugin_loader"
-local BasePlugin = require "kong.plugins.base_plugin"
 local reports = require "kong.reports"
 local plugin_servers = require "kong.runloop.plugin_servers"
 
@@ -123,7 +122,7 @@ local function implements(plugin, method)
   end
 
   local m = plugin[method]
-  return type(m) == "function" and m ~= BasePlugin[method]
+  return type(m) == "function"
 end
 
 
@@ -273,13 +272,6 @@ function Plugins:load_plugin_schemas(plugin_set)
     local handler, err = load_plugin(self, plugin)
 
     if handler then
-      if type(handler.is) == "function" and handler:is(BasePlugin) then
-        -- Backwards-compatibility for 0.x and 1.x plugins inheriting from the
-        -- BasePlugin class.
-        -- TODO: deprecate & remove
-        handler = handler()
-      end
-
       if handler._go then
         go_plugins_cnt = go_plugins_cnt + 1
       end

diff --git a/kong/plugins/base_plugin.lua b/kong/plugins/base_plugin.lua
diff --git a/kong/runloop/plugins_iterator.lua b/kong/runloop/plugins_iterator.lua
@@ -1,4 +1,3 @@
-local BasePlugin   = require "kong.plugins.base_plugin"
 local workspaces   = require "kong.workspaces"
 local constants    = require "kong.constants"
 local warmup       = require "kong.cache.warmup"
@@ -270,8 +269,7 @@ local function get_next_init_worker(self)
 
   self.i = i
 
-  local phase_handler = plugin.handler.init_worker
-  if phase_handler and phase_handler ~= BasePlugin.init_worker then
+  if plugin.handler.init_worker then
     return plugin
   end
 
@@ -310,8 +308,7 @@ local function get_next(self)
 
       plugins[n] = cfg
 
-      if not ctx.buffered_proxying and plugin.handler.response and
-                                       plugin.handler.response ~= BasePlugin.response then
+      if not ctx.buffered_proxying and plugin.handler.response then
         ctx.buffered_proxying = true
       end
     end
@@ -337,10 +334,7 @@ local function get_next_configured_plugin(self)
 
   self.i = i
 
-  local phase = self.phase
-  local phase_handler = plugin.handler[phase]
-
-  if phase_handler and phase_handler ~= BasePlugin[phase] then
+  if plugin.handler[self.phase] then
     return plugin, self.plugins[i]
   end
 
@@ -543,7 +537,8 @@ function PluginsIterator.new(version)
 
       else
         if version == "init" and not cache_full then
-          local ok, err = warmup.single_entity(kong.db.plugins, plugin)
+          local ok
+          ok, err = warmup.single_entity(kong.db.plugins, plugin)
           if not ok then
             if err ~= "no memory" then
               return nil, err
@@ -581,12 +576,12 @@ function PluginsIterator.new(version)
   end
 
   for _, plugin in ipairs(loaded_plugins) do
+    local name = plugin.name
     for _, data in pairs(ws) do
       for phase_name, phase in pairs(data.phases) do
-        if data.combos[plugin.name] then
-          local phase_handler = plugin.handler[phase_name]
-          if phase_handler and phase_handler ~= BasePlugin[phase_name] then
-            phase[plugin.name] = true
+        if data.combos[name] then
+          if plugin.handler[phase_name] then
+            phase[name] = true
           end
         end
       end

diff --git a/kong/vendor/classic.lua b/kong/vendor/classic.lua
diff --git a/spec/02-integration/05-proxy/21-grpc_plugins_triggering_spec.lua b/spec/02-integration/05-proxy/21-grpc_plugins_triggering_spec.lua
@@ -28,7 +28,7 @@ local function wait()
   -- in the logs when executing this
   helpers.wait_until(function()
     local logs = pl_file.read(TEST_CONF.prefix .. "/" .. TEST_CONF.proxy_error_log)
-    local _, count = logs:gsub([[executing plugin "logger": log]], "")
+    local _, count = logs:gsub("%[logger%] log phase", "")
 
     return count >= 1
   end, 10)

diff --git a/spec/02-integration/05-proxy/28-stream_plugins_triggering_spec.lua b/spec/02-integration/05-proxy/28-stream_plugins_triggering_spec.lua
@@ -28,7 +28,7 @@ local function wait()
   -- in the logs when executing this
   helpers.wait_until(function()
     local logs = pl_file.read(TEST_CONF.prefix .. "/" .. TEST_CONF.proxy_error_log)
-    local _, count = logs:gsub([[executing plugin "logger": log]], "")
+    local _, count = logs:gsub("%[logger%] log phase", "")
 
     return count >= 1
   end, 10)

diff --git a/spec/02-integration/07-sdk/02-log_spec.lua b/spec/02-integration/07-sdk/02-log_spec.lua
@@ -86,7 +86,7 @@ describe("PDK: kong.log", function()
 
       local cfg = helpers.test_conf
       local logs = pl_file.read(cfg.prefix .. "/" .. cfg.proxy_error_log)
-      local _, count = logs:gsub([[executing plugin "logger%-last": log]], "")
+      local _, count = logs:gsub("%[logger%-last%] log phase", "")
 
       return count == 2
     end, 10)

diff --git a/spec/fixtures/custom_plugins/kong/plugins/admin-api-method/handler.lua b/spec/fixtures/custom_plugins/kong/plugins/admin-api-method/handler.lua
@@ -1,16 +1,8 @@
 -- a plugin fixture to test a method on the admin api
-local BasePlugin = require "kong.plugins.base_plugin"
-
-
-local AdminApiMethod = BasePlugin:extend()
-
-
-AdminApiMethod.PRIORITY = 1000
-
-
-function AdminApiMethod:new()
-  AdminApiMethod.super.new(self, "admin-api-method")
-end
 
+local AdminApiMethod = {
+  VERSION = "0.1-t",
+  PRIORITY = 1000,
+}
 
 return AdminApiMethod
diff --git a/spec/fixtures/custom_plugins/kong/plugins/cache/handler.lua b/spec/fixtures/custom_plugins/kong/plugins/cache/handler.lua
@@ -1,21 +1,13 @@
-local BasePlugin = require "kong.plugins.base_plugin"
 local singletons = require "kong.singletons"
 
 
-local CacheHandler = BasePlugin:extend()
-
-
-CacheHandler.PRIORITY = 1000
-
-
-function CacheHandler:new()
-  CacheHandler.super.new(self, "cache")
-end
+local CacheHandler =  {
+  VERSION = "0.1-t",
+  PRIORITY = 1000,
+}
 
 
 function CacheHandler:access(conf)
-  CacheHandler.super.access(self)
-
   ngx.req.read_body()
 
   local args, err = ngx.req.get_post_args()

diff --git a/spec/fixtures/custom_plugins/kong/plugins/ctx-checker-last/handler.lua b/spec/fixtures/custom_plugins/kong/plugins/ctx-checker-last/handler.lua
@@ -1,17 +1,11 @@
-local BasePlugin = require "kong.plugins.base_plugin"
 local CtxCheckerHandler = require "spec.fixtures.custom_plugins.kong.plugins.ctx-checker.handler"
 
 
-local CtxCheckerLastHandler = BasePlugin:extend()
-
-
--- This plugin is a copy of ctx checker with a lower priority (it will run last)
-CtxCheckerLastHandler.PRIORITY = 0
-
-
-function CtxCheckerLastHandler:new()
-  CtxCheckerLastHandler.super.new(self, "ctx-checker-last")
-end
+local CtxCheckerLastHandler =  {
+  VERSION = "0.1-t",
+  PRIORITY = 0,
+  _name = "ctx-checker-last",
+}
 
 
 CtxCheckerLastHandler.access = CtxCheckerHandler.access

diff --git a/spec/fixtures/custom_plugins/kong/plugins/ctx-checker/handler.lua b/spec/fixtures/custom_plugins/kong/plugins/ctx-checker/handler.lua
@@ -1,4 +1,3 @@
-local BasePlugin = require "kong.plugins.base_plugin"
 local tablex = require "pl.tablex"
 local inspect = require "inspect"
 
@@ -10,10 +9,11 @@ local error = error
 local tostring = tostring
 
 
-local CtxCheckerHandler = BasePlugin:extend()
-
-
-CtxCheckerHandler.PRIORITY = 1000
+local CtxCheckerHandler =  {
+  VERSION = "0.1-t",
+  PRIORITY = 1000,
+  _name = "ctx-checker",
+}
 
 
 local function get_ctx(ctx_kind)
@@ -39,14 +39,7 @@ local function set_header(conf, name, value)
 end
 
 
-function CtxCheckerHandler:new()
-  CtxCheckerHandler.super.new(self, "ctx-checker")
-end
-
-
 function CtxCheckerHandler:access(conf)
-  CtxCheckerHandler.super.access(self)
-
   local set_field = conf.ctx_set_field
   if not set_field then
     return
@@ -76,8 +69,6 @@ end
 
 
 function CtxCheckerHandler:header_filter(conf)
-  CtxCheckerHandler.super.header_filter(self)
-
   local check_field = conf.ctx_check_field
   if not check_field then
     return
@@ -105,7 +96,7 @@ function CtxCheckerHandler:header_filter(conf)
   end
 
   if ok then
-    return set_header(conf, self._name .. "-" .. check_field, tostring(val))
+    return set_header(conf, self._name .."-" .. check_field, tostring(val))
   end
 
   if conf.throw_error then