change: check metadata_schema with check_schema like the other schema (…

…#4381)

Signed-off-by: spacewander <spacewanderlzx@gmail.com>

apisix/admin/plugin_metadata.lua

@@ -20,6 +20,7 @@ local require = require
 local core    = require("apisix.core")
 local api_router = require("apisix.api_router")
 
+local injected_mark = "injected metadata_schema"
 local _M = {
 }
 
@@ -50,15 +51,14 @@ local function check_conf(plugin_name, conf)
         return nil, {error_msg = "missing configurations"}
     end
 
-    local schema = plugin_object.metadata_schema or {
-        type = "object",
-        properties = {},
-    }
-    if not schema.properties then
-        schema.properties = {
-            additionalProperties = false,
+    if not plugin_object.metadata_schema then
+        plugin_object.metadata_schema = {
+            type = "object",
+            ['$comment'] = injected_mark,
+            properties = {},
         }
     end
+    local schema = plugin_object.metadata_schema
 
     -- inject interceptors schema to each plugins
     if schema.properties.interceptors
@@ -70,7 +70,17 @@ local function check_conf(plugin_name, conf)
 
     core.log.info("schema: ", core.json.delay_encode(schema))
     core.log.info("conf  : ", core.json.delay_encode(conf))
-    local ok, err = core.schema.check(schema, conf)
+
+    local ok, err
+    if schema['$comment'] == injected_mark
+      -- check_schema is not required. If missing, fallback to check schema directly
+      or not plugin_object.check_schema
+    then
+        ok, err = core.schema.check(schema, conf)
+    else
+        ok, err = plugin_object.check_schema(conf, core.schema.TYPE_METADATA)
+    end
+
     if not ok then
         return nil, {error_msg = "invalid configuration: " .. err}
     end

apisix/core/schema.lua

@@ -22,7 +22,9 @@ local pcall = pcall
 
 local _M = {
     version = 0.3,
+
     TYPE_CONSUMER = 1,
+    TYPE_METADATA = 2,
 }
 
 

apisix/plugins/batch-requests.lua

@@ -111,12 +111,11 @@ local _M = {
 }
 
 
-function _M.check_schema(conf)
-    local ok, err = core.schema.check(schema, conf)
-    if not ok then
-        return false, err
+function _M.check_schema(conf, schema_type)
+    if schema_type == core.schema.TYPE_METADATA then
+        return core.schema.check(metadata_schema, conf)
     end
-    return true
+    return core.schema.check(schema, conf)
 end
 
 

apisix/plugins/example-plugin.lua

@@ -53,6 +53,9 @@ local _M = {
 
 
 function _M.check_schema(conf, schema_type)
+    if schema_type == core.schema.TYPE_METADATA then
+        return core.schema.check(metadata_schema, conf)
+    end
     return core.schema.check(schema, conf)
 end
 

apisix/plugins/http-logger.lua

@@ -81,7 +81,10 @@ local _M = {
 }
 
 
-function _M.check_schema(conf)
+function _M.check_schema(conf, schema_type)
+    if schema_type == core.schema.TYPE_METADATA then
+        return core.schema.check(metadata_schema, conf)
+    end
     return core.schema.check(schema, conf)
 end
 

apisix/plugins/skywalking.lua

@@ -23,7 +23,7 @@ local math = math
 local require = require
 
 local plugin_name = "skywalking"
-local metadata_schema = {
+local attr_schema = {
     type = "object",
     properties = {
         service_name = {
@@ -66,7 +66,7 @@ local _M = {
     priority = -1100, -- last running plugin, but before serverless post func
     name = plugin_name,
     schema = schema,
-    metadata_schema = metadata_schema,
+    attr_schema = attr_schema,
 }
 
 
@@ -117,7 +117,7 @@ function _M.init()
                                                        "plugin_attr",
                                                        plugin_name) or {}
     local_plugin_info = core.table.clone(local_plugin_info)
-    local ok, err = core.schema.check(metadata_schema, local_plugin_info)
+    local ok, err = core.schema.check(attr_schema, local_plugin_info)
     if not ok then
         core.log.error("failed to check the plugin_attr[", plugin_name, "]",
                        ": ", err)

t/plugin/error-log-logger.t

@@ -126,11 +126,15 @@ plugins:
                 }]]
                 )
 
+            -- ensure the request is rejected even this plugin doesn't
+            -- have check_schema method
+            ngx.status = code
             core.log.warn("this is a warning message for test.")
         }
     }
 --- request
 GET /tg
+--- error_code: 400
 --- response_body
 --- error_log eval
 qr/please set the correct plugin_metadata for error-log-logger/