fix(schema) convert shorthands to shorthand_fields

Kong · Sep 22, 2020 · 4ce5620 · 4ce5620
1 parent d016ade
commit 4ce5620
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 52 deletions.
diff --git a/kong/db/schema/entities/services.lua b/kong/db/schema/entities/services.lua
@@ -69,34 +69,37 @@ return {
                       then_match = { eq = null }}},
   },
 
-  shorthands = {
-    { url = function(sugar_url)
-              local parsed_url = url.parse(tostring(sugar_url))
-              if not parsed_url then
-                return
-              end
+  shorthand_fields = {
+    { url = {
+      type = "string",
+      func = function(sugar_url)
+        local parsed_url = url.parse(tostring(sugar_url))
+        if not parsed_url then
+          return
+        end
 
-              local port = tonumber(parsed_url.port)
+        local port = tonumber(parsed_url.port)
 
-              local prot
-              if port == 80 then
-                prot = "http"
-              elseif port == 443 then
-                prot = "https"
-              end
+        local prot
+        if port == 80 then
+          prot = "http"
+        elseif port == 443 then
+          prot = "https"
+        end
 
-              local protocol = parsed_url.scheme or prot or default_protocol
+        local protocol = parsed_url.scheme or prot or default_protocol
 
-              return {
-                protocol = protocol,
-                host = parsed_url.host or null,
-                port = port or
-                       parsed_url.port or
-                       (protocol == "http"  and 80)  or
-                       (protocol == "https" and 443) or
-                       default_port,
-                path = parsed_url.path or null,
-              }
-            end },
+        return {
+          protocol = protocol,
+          host = parsed_url.host or null,
+          port = port or
+                 parsed_url.port or
+                 (protocol == "http"  and 80)  or
+                 (protocol == "https" and 443) or
+                 default_port,
+          path = parsed_url.path or null,
+        }
+      end
+    }, },
   }
 }
diff --git a/kong/db/schema/entities/upstreams.lua b/kong/db/schema/entities/upstreams.lua
@@ -233,8 +233,10 @@ local r =  {
   -- This is a hack to preserve backwards compatibility with regard to the
   -- behavior of the hash_on field, and have it take place both in the Admin API
   -- and via declarative configuration.
-  shorthands = {
-    { algorithm = function(value)
+  shorthand_fields = {
+    { algorithm = {
+      type = "string",
+      func = function(value)
         if value == "least-connections" then
           return {
             algorithm = value,
@@ -245,11 +247,13 @@ local r =  {
             algorithm = value,
           }
         end
-      end
-    },
+      end,
+    }, },
     -- Then, if hash_on is set to some non-null value, adjust the algorithm
     -- field accordingly.
-    { hash_on = function(value)
+    { hash_on = {
+      type = "string",
+      func = function(value)
         if value == null then
           return {
             hash_on = "none"
@@ -266,7 +270,7 @@ local r =  {
           }
         end
       end
-    },
+    }, },
   },
 }
 

diff --git a/kong/plugins/acl/schema.lua b/kong/plugins/acl/schema.lua
@@ -13,14 +13,22 @@ return {
           { deny = { type = "array", elements = { type = "string" }, }, },
           { hide_groups_header = { type = "boolean", default = false }, },
         },
-        shorthands = {
+        shorthand_fields = {
           -- deprecated forms, to be removed in Kong 3.0
-          { blacklist = function(value)
-              return { deny = value }
-            end },
-          { whitelist = function(value)
-              return { allow = value }
-            end },
+          { blacklist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { deny = value }
+              end,
+          }, },
+          { whitelist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { allow = value }
+              end,
+          }, },
         },
       }
     }

diff --git a/kong/plugins/bot-detection/schema.lua b/kong/plugins/bot-detection/schema.lua
@@ -19,14 +19,22 @@ return {
               default = {},
           }, },
         },
-        shorthands = {
+        shorthand_fields = {
           -- deprecated forms, to be removed in Kong 3.0
-          { blacklist = function(value)
-              return { deny = value }
-            end },
-          { whitelist = function(value)
-              return { allow = value }
-            end },
+          { blacklist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { deny = value }
+              end,
+          }, },
+          { whitelist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { allow = value }
+              end,
+          }, },
         },
     }, },
   },

diff --git a/kong/plugins/ip-restriction/schema.lua b/kong/plugins/ip-restriction/schema.lua
@@ -11,14 +11,22 @@ return {
           { allow = { type = "array", elements = typedefs.ip_or_cidr, }, },
           { deny = { type = "array", elements = typedefs.ip_or_cidr, }, },
         },
-        shorthands = {
+        shorthand_fields = {
           -- deprecated forms, to be removed in Kong 3.0
-          { blacklist = function(value)
-              return { deny = value }
-            end },
-          { whitelist = function(value)
-              return { allow = value }
-            end },
+          { blacklist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { deny = value }
+              end,
+          }, },
+          { whitelist = {
+              type = "array",
+              elements = { type = "string", is_regex = true },
+              func = function(value)
+                return { allow = value }
+              end,
+          }, },
         },
       },
     },