feat: validate the subordinate and check reference when deleting and adding…

apisix/admin/stream_routes.lua

@@ -16,15 +16,36 @@
 --
 local core = require("apisix.core")
 local utils = require("apisix.admin.utils")
+local config_util = require("apisix.core.config_util")
+local routes = require("apisix.stream.router.ip_port").routes
 local stream_route_checker = require("apisix.stream.router.ip_port").stream_route_checker
 local tostring = tostring
+local string = string
+local table = table
 
 
 local _M = {
     version = 0.1,
     need_v3_filter = true,
 }
 
+local function check_router_refer(items, id)
+    local refer_list = {}
+    for _, item in config_util.iterate_values(items) do
+        if item.value == nil then
+            goto CONTINUE
+        end
+        local r_id = string.gsub(item["key"], "/", "_")
+        local route = item.value
+        if route.protocol and route.protocol.superior_id and route.protocol.superior_id == id then
+            table.insert(refer_list,r_id)
+        end
+        ::CONTINUE::
+    end
+    return refer_list
+end
+
+
 
 local function check_conf(id, conf, need_id)
     if not conf then
@@ -142,8 +163,18 @@ function _M.delete(id)
         return 400, {error_msg = "missing stream route id"}
     end
 
+    local items,_ = routes()
     local key = "/stream_routes/" .. id
     -- core.log.info("key: ", key)
+    local refer_list = {}
+    if items ~= nil then
+        refer_list=check_router_refer(items,id)
+    end
+    if #refer_list >0 then
+        local warn_message = key.." is referred by "..table.concat(refer_list,";;")
+        return 400,warn_message
+    end
+
     local res, err = core.etcd.delete(key)
     if not res then
         core.log.error("failed to delete stream route[", key, "]: ", err)

apisix/cli/ngx_tpl.lua

@@ -447,6 +447,7 @@ http {
 
     init_worker_by_lua_block {
         apisix.http_init_worker()
+        apisix.stream_init_worker()
     }
 
     exit_worker_by_lua_block {

apisix/stream/router/ip_port.lua

@@ -63,23 +63,46 @@ local create_router
 do
     local sni_to_items = {}
     local tls_routes = {}
+    local routeid_to_protocols = {}
 
     function create_router(items)
         local tls_routes_idx = 1
         local other_routes_idx = 1
         core.table.clear(tls_routes)
         core.table.clear(other_routes)
         core.table.clear(sni_to_items)
+        core.table.clear(routeid_to_protocols)
 
         for _, item in config_util.iterate_values(items) do
             if item.value == nil then
                 goto CONTINUE
             end
+            local route = item.value
+            if route.protocol  then
+               routeid_to_protocols[item.key]=route.protocol.name
+            else
+               routeid_to_protocols[item.key]="No-Protocol"
+            end
+            ::CONTINUE::
+        end
 
+        for _, item in config_util.iterate_values(items) do
+            if item.value == nil then
+                goto CONTINUE
+            end
             local route = item.value
             if route.protocol and route.protocol.superior_id then
                 -- subordinate route won't be matched in the entry
-                -- TODO: check the subordinate relationship in the Admin API
+                local key="/apisix/stream_routes/"..route.protocol.superior_id
+                if routeid_to_protocols[key] == nil then
+                    core.log.warn("There is not exist stream_route: "..key)
+                elseif routeid_to_protocols[key] == "No-Protocol" then
+                    core.log.warn("The stream_route: "..key.." may lacks procotol configuration")
+                elseif routeid_to_protocols[key] == route.protocol.name then
+                    goto CONTINUE
+                else
+                    core.log.warn("Different between stream_route:"..item.key.." and "..key)
+                end
                 goto CONTINUE
             end
 

t/APISIX.pm

@@ -603,6 +603,7 @@ _EOC_
 
     init_worker_by_lua_block {
         require("apisix").http_init_worker()
+        require("apisix").stream_init_worker()
         $extra_init_worker_by_lua
     }
 

t/admin/stream-routes.t

@@ -639,3 +639,86 @@ passed
 {"error_msg":"property \"faults\" validation failed: wrong type: expected array, got string"}
 --- no_error_log
 [error]
+
+
+
+=== TEST 17:  put reference route +  delete
+xrpc:
+  protocols:
+    - name: pingpong
+--- config
+    location /t {
+        content_by_lua_block {
+            local t = require("lib.test_admin").test
+            local etcd = require("apisix.core.etcd")
+            local code, body = t('/apisix/admin/stream_routes/12',
+                ngx.HTTP_PUT,
+                [[{
+                    "remote_addr": "127.0.0.1",
+                    "desc": "test-desc",
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:8080": 1
+                        },
+                        "type": "roundrobin"
+                    },
+                    "protocol": {
+                        "name": "pingpong",
+                        "superior_id": "1",
+                        "conf": {
+                            "faults": [{
+                                "commands": ["get", "ping"],
+                                "delay": 5
+                            }]
+                        }
+                    "desc": "new route"
+                }]],
+                [[{
+                    "value": {
+                        "remote_addr": "127.0.0.1",
+                        "desc": "test-desc",
+                        "upstream": {
+                            "nodes": {
+                                "127.0.0.1:8080": 1
+                            },
+                            "type": "roundrobin"
+                        },
+                        "protocol": {
+                            "name": "pingpong",
+                            "superior_id": "1",
+                            "conf": {
+                                "faults": [{
+                                    "commands": ["get", "ping"],
+                                    "delay": 5
+                                }]
+                            }
+                        "desc": "new route"
+                    },
+                    "key": "/apisix/stream_routes/12"
+                }]]
+                )
+            ngx.status = code
+            ngx.say(body)
+            local res = assert(etcd.get('/stream_routes/12'))
+            local create_time = res.body.node.value.create_time
+            assert(create_time ~= nil, "create_time is nil")
+            local update_time = res.body.node.value.update_time
+            assert(update_time ~= nil, "update_time is nil")
+            if code ~= 200 then
+                ngx.status = code
+                ngx.say(message)
+                return
+            end
+            ngx.say("[push] code: ", code, " message: ", message)
+            local id = string.sub(res.key, #"/apisix/stream_routes/" + 1)
+            code, message = t('/apisix/admin/stream_routes/' .. id, ngx.HTTP_DELETE)
+            ngx.say("[delete] code: ", code, " message: ", message)
+        }
+    }
+--- request
+GET /t
+--- response_body
+[push] code: 200 message: passed
+[delete] code: 400 message: /stream_routes/1 is referred by _apisix_stream_routes_12
+--- no_error_log
+[error]