Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ref check while deleting proto via Admin API #4575

Merged
merged 11 commits into from
Jul 14, 2021
33 changes: 22 additions & 11 deletions apisix/admin/proto.lua
Original file line number Diff line number Diff line change
Expand Up @@ -117,25 +117,31 @@ function _M.post(id, conf)
return res.status, res.body
end

function _M.check_proto_used(plugins, deleting, ptype, pid)
local function check_proto_used(plugins, deleting, ptype, pid)

core.log.info("plugins1: ", core.json.delay_encode(plugins, true))
--core.log.info("check_proto_used plugins: ", core.json.delay_encode(plugins, true))
--core.log.info("check_proto_used deleting: ", deleting)
--core.log.info("check_proto_used ptype: ", ptype)
--core.log.info("check_proto_used pid: ", pid)

if plugins then
if type(plugins) == "table" and plugins["grpc-transcode"]
and plugins["grpc-transcode"].proto_id
and tostring(plugins["grpc-transcode"].proto_id) == deleting then
return 400, {error_msg = "can not delete this proto,"
-- core.log.info("check_proto_used proto is used: ", core.json.delay_encode(plugins, true))
return false, {error_msg = "can not delete this proto,"
.. ptype .. " [" .. pid
.. "] is still using it now"}
end
end
return true,"ok"
end

function _M.delete(id)
if not id then
return 400, {error_msg = "missing proto id"}
end
core.log.info("proto delete: ", id)

local routes, routes_ver = get_routes()

Expand All @@ -144,13 +150,16 @@ function _M.delete(id)

if routes_ver and routes then
for _, route in ipairs(routes) do
if type(route) == "table" and route.value
and route.value.plugins then
return _M.check_proto_used(route.value.plugins, id, "route",
route.value.id)
core.log.info("proto delete route item: ", core.json.delay_encode(route, true))
if type(route) == "table" and route.value and route.value.plugins then
local ret, err = check_proto_used(route.value.plugins, id, "route",route.value.id)
if not ret then
return 400, err
end
end
end
end
core.log.info("proto delete route ref check pass: ", id)

local services, services_ver = get_services()

Expand All @@ -159,13 +168,15 @@ function _M.delete(id)

if services_ver and services then
for _, service in ipairs(services) do
if type(service) == "table" and service.value
and service.value.plugins then
return _M.check_proto_used(service.value.plugins, id,
"service", service.value.id)
if type(service) == "table" and service.value and service.value.plugins then
local ret, err = check_proto_used(service.value.plugins, id, "service", service.value.id)
if not ret then
return 400, err
end
end
end
end
core.log.info("proto delete service ref check pass: ", id)

local key = "/proto/" .. id
-- core.log.info("key: ", key)
Expand Down
99 changes: 99 additions & 0 deletions t/admin/proto3.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
use t::APISIX 'no_plan';

repeat_each(1);
no_long_string();
no_root_location();
no_shuffle();
log_level("info");

run_tests;

__DATA__

=== TEST 1: post proto + delete
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local etcd = require("apisix.core.etcd")
local code, message, res = t('/apisix/admin/proto',
ngx.HTTP_POST,
[[{
"content": "syntax = \"proto3\";
package proto;
message HelloRequest{
string name = 1;
}

message HelloResponse{
int32 code = 1;
string msg = 2;
}
// The greeting service definition.
service Hello {
// Sends a greeting
rpc SayHi (HelloRequest) returns (HelloResponse){}
}"
}]],
[[
{
"node": {
"value": {
"create_time": 1625845753,
"update_time": 1625845753,
"content": "syntax = \"proto3\";\npackage proto;\nmessage HelloRequest{\n string name = 1;\n }\n\nmessage HelloResponse{\n int32 code = 1;\n string msg = 2;\n }\n // The greeting service definition.\nservice Hello {\n // Sends a greeting\n rpc SayHi (HelloRequest) returns (HelloResponse){}\n }"
}
},
"action": "create"
}
]]
)

if code ~= 201 then
ngx.status = code
ngx.say(message)
return
end

ngx.say("[push] code: ", code, " message: ", message)

local id = string.sub(res.node.key, #"/apisix/proto/" + 1)
local res = assert(etcd.get('/proto/' .. id))
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")

code, message = t('/apisix/admin/proto/' .. id,
ngx.HTTP_DELETE,
nil,
[[{
"action": "delete"
}]]
)
ngx.say("[delete] code: ", code, " message: ", message)
}
}
--- request
GET /t
--- response_body
[push] code: 200 message: passed
[delete] code: 200 message: passed
--- no_error_log
[error]