Skip to content

fix(ai-proxy-multi): guard construct_upstream in healthcheck timers #13592

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.

Sign up for GitHub

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

Open
shreemaan-abhishek wants to merge 2 commits into
base: master
Choose a base branch
from
+545 −11
Open

fix(ai-proxy-multi): guard construct_upstream in healthcheck timers #13592

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3593b9
fix(ai-proxy-multi): guard construct_upstream in healthcheck timers
shreemaan-abhishek Jun 22, 2026
48aa51d
fix(ai-proxy-multi): make working-pool checker failure handling nil-s…
shreemaan-abhishek Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 33 additions & 11 deletions apisix/healthcheck_manager.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ local function timer_create_checker()
if not res_conf then
goto continue
end
local upstream
local ok, upstream, err
local plugin_name = get_plugin_name(resource_path)
if plugin_name and plugin_name ~= "" then
local _, sub_path = config_util.parse_path(resource_path)
Expand All @@ -189,7 +189,14 @@ local function timer_create_checker()
--- callback construct_upstream to create an upstream dynamically
local upstream_constructor_config = jp.value(res_conf.value, json_path)
local plugin = require("apisix.plugins." .. plugin_name)
upstream = plugin.construct_upstream(upstream_constructor_config)
ok, upstream, err = pcall(plugin.construct_upstream, upstream_constructor_config)
if not ok or not upstream then
err = err or upstream
core.log.error("[creating checker] unable to construct upstream",
" for plugin: ", plugin_name, ", resource path: ", resource_path,
", json path: ", json_path, ", error: ", err)
goto continue
end
upstream.resource_key = resource_path
else
upstream = res_conf.value.upstream or res_conf.value
Expand Down Expand Up @@ -237,7 +244,7 @@ local function timer_working_pool_check()
local res_conf = resource.fetch_latest_conf(resource_path)
local need_destroy = true
if res_conf and res_conf.value then
local upstream
local ok, upstream, err
local plugin_name = get_plugin_name(resource_path)
if plugin_name and plugin_name ~= "" then
local _, sub_path = config_util.parse_path(resource_path)
Expand All @@ -247,17 +254,32 @@ local function timer_working_pool_check()
--- callback construct_upstream to create an upstream dynamically
local upstream_constructor_config = jp.value(res_conf.value, json_path)
local plugin = require("apisix.plugins." .. plugin_name)
upstream = plugin.construct_upstream(upstream_constructor_config)
upstream.resource_key = resource_path
ok, upstream, err = pcall(plugin.construct_upstream, upstream_constructor_config)
if not ok or not upstream then
err = err or upstream
upstream = nil
local err_msg = "[checking checker] unable to construct upstream for plugin: "
.. plugin_name .. ", resource path: " .. resource_path
.. ", json path: " .. json_path .. ", error: " .. err
if not ok then
core.log.error(err_msg)
else
core.log.warn(err_msg)
end
else
upstream.resource_key = resource_path
end
Comment on lines +257 to +273
else
upstream = res_conf.value.upstream or res_conf.value
end
local current_ver = upstream_utils.version(res_conf.modifiedIndex,
upstream._nodes_ver)
core.log.info("checking working pool for resource: ", resource_path,
" current version: ", current_ver, " item version: ", item.version)
if item.version == current_ver then
need_destroy = false
if upstream then
local current_ver = upstream_utils.version(res_conf.modifiedIndex,
upstream._nodes_ver)
core.log.info("checking working pool for resource: ", resource_path,
" current version: ", current_ver, " item version: ", item.version)
if item.version == current_ver then
need_destroy = false
end
end
Comment on lines +277 to 285
end

Expand Down
291 changes: 291 additions & 0 deletions t/plugin/ai-proxy-multi-construct-upstream-panic.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
#
# 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';

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


add_block_preprocessor(sub {
my ($block) = @_;

if (!defined $block->request) {
$block->set_value("request", "GET /t");
}

my $user_yaml_config = <<_EOC_;
plugins:
- ai-proxy-multi
_EOC_
$block->set_value("extra_yaml_config", $user_yaml_config);

my $http_config = $block->http_config // <<_EOC_;
server {
server_name openai;
listen 127.0.0.1:16724;

default_type 'application/json';

location /v1/chat/completions {
content_by_lua_block {
ngx.say([[{"choices":[{"message":{"content":"ok","role":"assistant"}}]}]])
}
}

location /status {
content_by_lua_block {
ngx.say("ok")
}
}
}
_EOC_

$block->set_value("http_config", $http_config);
});

run_tests();

__DATA__

=== TEST 1: panic in construct_upstream during checker creation must not crash the timer
# construct_upstream is overridden to raise a Lua error on every call. The
# healthcheck manager creation timer wraps it in pcall, logs the failure and
# skips the bad resource instead of aborting checker creation for the whole
# worker. Proxying is unaffected.
--- extra_init_worker_by_lua
local plugin = require "apisix.plugins.ai-proxy-multi"
plugin.construct_upstream = function(instance)
local panic_check
panic_check.cnt = 1
end
Comment on lines +75 to +78
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local json = require("cjson.safe")

local checks = {
active = {
type = "http",
http_path = "/status",
healthy = {
interval = 1,
successes = 1,
},
unhealthy = {
interval = 1,
http_failures = 2,
},
},
}

local route = {
uri = "/ai",
plugins = {
["ai-proxy-multi"] = {
fallback_strategy = "instance_health_and_rate_limiting",
instances = {
{
name = "ai-instance",
provider = "openai",
weight = 1,
auth = {
header = {
Authorization = "Bearer token",
},
},
options = {
model = "gpt-4",
},
override = {
endpoint = "http://127.0.0.1:16724",
},
checks = checks,
},
{
name = "ai-instance-2",
provider = "openai",
weight = 1,
auth = {
header = {
Authorization = "Bearer token",
},
},
options = {
model = "gpt-3",
},
override = {
endpoint = "http://127.0.0.1:16724",
},
},
},
ssl_verify = false,
},
},
}

local code, body = t('/apisix/admin/routes/1',
ngx.HTTP_PUT,
json.encode(route)
)
assert(code < 300, body)

local function send_ai()
local code = t("/ai",
ngx.HTTP_POST,
json.encode({messages = {{role = "user", content = "hi"}}}),
nil,
{
["Content-Type"] = "application/json",
}
)
return code
end

-- queues the checker creation, which the timer picks up next second
assert(send_ai() == 200, "first request should succeed")
ngx.sleep(2)
assert(send_ai() == 200, "second request should succeed")
ngx.say("passed")
}
}
--- timeout: 10
--- response_body
passed
--- error_log
[creating checker] unable to construct upstream for plugin: ai-proxy-multi, resource path: /apisix/routes/1#plugins['ai-proxy-multi'].instances[0], json path: $.plugins['ai-proxy-multi'].instances[0]
'panic_check' (a nil value)



=== TEST 2: panic in construct_upstream during working pool check must not crash the timer
# The first call (creation timer) succeeds so a checker lands in the working
# pool; later calls (the working pool check timer) raise a Lua error. The
# check timer wraps construct_upstream in pcall, logs and keeps the entry
# instead of crashing the worker.
--- extra_init_worker_by_lua
local plugin = require "apisix.plugins.ai-proxy-multi"
local old_func = plugin.construct_upstream
local cnt = 0
plugin.construct_upstream = function(instance)
cnt = cnt + 1
if cnt <= 1 then
return old_func(instance)
end
local panic_check
panic_check.cnt = cnt
end
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local json = require("cjson.safe")

local checks = {
active = {
type = "http",
http_path = "/status",
healthy = {
interval = 1,
successes = 1,
},
unhealthy = {
interval = 1,
http_failures = 2,
},
},
}

local route = {
uri = "/ai",
plugins = {
["ai-proxy-multi"] = {
fallback_strategy = "instance_health_and_rate_limiting",
instances = {
{
name = "ai-instance",
provider = "openai",
weight = 1,
auth = {
header = {
Authorization = "Bearer token",
},
},
options = {
model = "gpt-4",
},
override = {
endpoint = "http://127.0.0.1:16724",
},
checks = checks,
},
{
name = "ai-instance-2",
provider = "openai",
weight = 1,
auth = {
header = {
Authorization = "Bearer token",
},
},
options = {
model = "gpt-3",
},
override = {
endpoint = "http://127.0.0.1:16724",
},
},
},
ssl_verify = false,
},
},
}

local code, body = t('/apisix/admin/routes/1',
ngx.HTTP_PUT,
json.encode(route)
)
assert(code < 300, body)

local function send_ai()
local code = t("/ai",
ngx.HTTP_POST,
json.encode({messages = {{role = "user", content = "hi"}}}),
nil,
{
["Content-Type"] = "application/json",
}
)
return code
end

assert(send_ai() == 200, "first request should succeed")
ngx.sleep(2)
assert(send_ai() == 200, "second request should succeed")
ngx.say("passed")
}
}
--- timeout: 10
--- response_body
passed
--- error_log
[checking checker] unable to construct upstream for plugin: ai-proxy-multi, resource path: /apisix/routes/1#plugins['ai-proxy-multi'].instances[0], json path: $.plugins['ai-proxy-multi'].instances[0]
'panic_check' (a nil value)
Loading