fix(dns): change dns client switch to new_dns_client (#13501)

* fix(dns): change dns client switch to `new_dns_client` * fixed test case failures * remove unnecessary debug log * fixed test cases * fix test cases: revert 05 worker_consistency * fixed dns tool switch
Kong · Aug 16, 2024 · ca9c4ea · ca9c4ea · github-actions · Aug 16, 2024
1 parent 64a0dd1
commit ca9c4ea
Show file tree

Hide file tree

Showing 18 changed files with 257 additions and 183 deletions.
diff --git a/kong.conf.default b/kong.conf.default
@@ -1542,9 +1542,7 @@
 # It provides observable statistics, you can retrieve them through the Admin API
 # `/status/dns`.
 
-#legacy_dns_client = off         # Disable the new DNS resolver, using the
-                                 # original DNS resolver. See above `dns_xxx`
-                                 # options for the original DNS resolver.
+#new_dns_client = on             # Enable the new DNS resolver
 
 #resolver_address = <name servers parsed from resolv.conf>
                                  # Comma-separated list of nameservers, each

diff --git a/kong/api/routes/dns.lua b/kong/api/routes/dns.lua
@@ -5,7 +5,7 @@ return {
   ["/status/dns"] = {
     GET = function (self, db, helpers)
 
-      if kong.configuration.legacy_dns_client then
+      if not kong.configuration.new_dns_client then
         return kong.response.exit(501, {
           message = "not implemented with the legacy DNS client"
         })

diff --git a/kong/api/routes/kong.lua b/kong/api/routes/kong.lua
@@ -272,7 +272,7 @@ return {
   },
   ["/status/dns"] = {
     GET = function (self, db, helpers)
-      if kong.configuration.legacy_dns_client then
+      if not kong.configuration.new_dns_client then
         return kong.response.exit(501, { message = "not implemented with the legacy DNS client" })
       end
 

diff --git a/kong/conf_loader/constants.lua b/kong/conf_loader/constants.lua
@@ -371,7 +371,7 @@ local CONF_PARSERS = {
   dns_error_ttl = { typ = "number" },
   dns_no_sync = { typ = "boolean" },
 
-  legacy_dns_client = { typ = "boolean" },
+  new_dns_client = { typ = "boolean" },
 
   resolver_address = { typ = "array" },
   resolver_hosts_file = { typ = "string" },

diff --git a/kong/resty/dns/client.lua b/kong/resty/dns/client.lua
@@ -1,6 +1,6 @@
 -- Use the new dns client library instead. If you want to switch to the original
--- one, you can set `legacy_dns_client = on` in kong.conf.
-if ngx.shared.kong_dns_cache and not _G.busted_legacy_dns_client then
+-- one, you can set `new_dns_client = off` in kong.conf.
+if ngx.shared.kong_dns_cache and _G.busted_new_dns_client ~= false then
   package.loaded["kong.dns.client"] = nil
   return require("kong.dns.client")
 end

diff --git a/kong/templates/kong_defaults.lua b/kong/templates/kong_defaults.lua
@@ -170,7 +170,7 @@ dns_not_found_ttl = 30
 dns_error_ttl = 1
 dns_no_sync = off
 
-legacy_dns_client = off
+new_dns_client = on
 
 resolver_address = NONE
 resolver_hosts_file = /etc/hosts

diff --git a/kong/templates/nginx_kong.lua b/kong/templates/nginx_kong.lua
@@ -23,7 +23,7 @@ lua_shared_dict kong_db_cache               ${{MEM_CACHE_SIZE}};
 lua_shared_dict kong_db_cache_miss          12m;
 lua_shared_dict kong_secrets                5m;
 
-> if not legacy_dns_client then
+> if new_dns_client then
 lua_shared_dict kong_dns_cache              ${{RESOLVER_MEM_CACHE_SIZE}};
 > end
 

diff --git a/kong/tools/dns.lua b/kong/tools/dns.lua
@@ -38,7 +38,7 @@ local setup_client = function(conf)
   }
 
   -- new dns client
-  if ngx.shared.kong_dns_cache and not _G.busted_legacy_dns_client then
+  if ngx.shared.kong_dns_cache and _G.busted_new_dns_client ~= false then
 
     servers = {}