bug: schema validate failed: schema not found, path:plugins.xxx

[EthanSivan]

Current Behavior

Write a custom idempot.lua, save it and get an error: schema validate failed: schema not found, path:plugins.custom-idempot

Expected Behavior

No response

Error Logs

No response

Steps to Reproduce

1. Writing a custom idempot.lua
2. Save the apisix rule

Environment

• APISIX version: 3.9.1
• Operating system: Linux apisix-control-plane-7b97488c96-2qqn8 6.1.128 change: added doc of how to load plugin. #1 SMP PREEMPT_DYNAMIC Wed Feb 26 21:46:15 UTC 2025 x86_64 GNU/Linux
• OpenResty / Nginx version (run openresty -V or nginx -V): nginx version: openresty/1.25.3.1
• etcd version, if relevant (run curl http://127.0.0.1:9090/v1/server_info):
• APISIX Dashboard version, if relevant:
• Plugin runner version, for issues related to plugin runners:
• LuaRocks version, for installation issues (run luarocks --version): 3.8.0

[EthanSivan]

This is my lua script：

local core = require("apisix.core")
local redis_new = require("resty.redis").new

local plugin_name = "custom-idempotent"

-- Plugin schema for route-level config
local schema = {
    type = "object",
    properties = {
        host = { type = "string", description = "Redis host", default = "127.0.0.1" },
        port = { type = "integer", description = "Redis port", default = 6379 },
        ttl = { type = "integer", description = "Key expiration time (seconds)", default = 3600 },
        strict_mode = { type = "boolean", description = "Strict mode for request hash match", default = true }
    },
    additionalProperties = false
}

local _M = {
    version = 1.0,
    priority = 800,
    name = plugin_name,
    schema = schema
}

-- Converts Redis HGETALL result to Lua table
local function normalize_hgetall_result(data)
    local res = {}
    for index, value in ipairs(data) do
        if index % 2 == 1 then
            res[value] = data[index + 1]
        end
    end
    return res
end

-- Generates a base64 hash of the request
local function hash_request(ctx)
    local request = {
        method = core.request.get_method(),
        uri = ctx.var.request_uri,
        headers = core.request.headers(),
        body = core.request.get_body()
    }
    local json = core.json.stably_encode(request)
    return ngx.encode_base64(json)
end

-- Gets Request-Id header or fallback to ctx.var
local function get_request_id(ctx)
    return core.request.header(ctx, "Request-Id") or ctx.var.request_id
end

-- Gets Request-Time header or generate UTC ISO8601
local function get_request_time(ctx)
    local t = core.request.header(ctx, "Request-Time")
    if t then return t end
    local utc = os.date("!*t")
    return string.format("%04d-%02d-%02dT%02d:%02d:%02dZ",
        utc.year, utc.month, utc.day, utc.hour, utc.min, utc.sec)
end

-- Establish Redis connection
local function get_redis_connection(conf)
    local red = redis_new()
    red:set_timeout(1000)
    local ok, err = red:connect(conf.host, conf.port)
    if not ok then
        return nil, "Redis connection error: " .. (err or "unknown")
    end
    return red
end

-- Access phase handler
function _M.access(conf, ctx)
    local ok, err = core.schema.check(schema, conf)
    if not ok then
        core.log.error("Invalid plugin conf: ", err)
        return core.response.exit(500, "Invalid plugin config")
    end

    local request_id = get_request_id(ctx)
    if not request_id then
        return core.response.exit(400, "Missing Request-Id")
    end

    local request_time = get_request_time(ctx)
    local request_hash = hash_request(ctx)
    local redis_key = "idempotent#" .. request_id

    local red, err = get_redis_connection(conf)
    if not red then
        core.log.error(err)
        return core.response.exit(500, "Redis unavailable")
    end

    local resp, err = red:hgetall(redis_key)
    if not resp then
        core.log.error("Redis hgetall error: ", err)
        return core.response.exit(500)
    end

    if next(resp) == nil then
        red:hset(redis_key, "request", request_hash)
        red:hset(redis_key, "request_id", request_id)
        red:hset(redis_key, "request_time", request_time)
        red:expire(redis_key, conf.ttl or 3600)
    else
        local data = normalize_hgetall_result(resp)
        local stored_hash = data["request"]

        if conf.strict_mode and stored_hash and request_hash ~= stored_hash then
            return core.response.exit(422, {
                message = "Request-Id cannot be reused for different payloads",
                request_id = request_id
            })
        end

        if not data["response"] then
            return core.response.exit(409, {
                message = "Request is already being processed",
                request_id = request_id,
                request_time = data["request_time"]
            })
        end

        local cached = core.json.decode(data["response"])
        for k, v in pairs(cached["headers"] or {}) do
            core.response.set_header(k, v)
        end
        return core.response.exit(cached["status"], cached["body"])
    end
end

-- body_filter phase: cache the response
function _M.body_filter(conf, ctx)
    local request_id = core.request.header(ctx, "Request-Id")
    if not request_id then return end

    local redis_key = "idempotent#" .. request_id
    local red, err = get_redis_connection(conf)
    if not red then
        core.log.error("Redis error in body_filter: ", err)
        return
    end

    local response = {
        status = ngx.status,
        body = core.response.hold_body_chunk(ctx, true),
        headers = ngx.resp.get_headers()
    }

    local ok, err = red:hset(redis_key, "response", core.json.encode(response))
    if not ok then
        core.log.error("Failed to save response to Redis: ", err)
        return
    end

    red:expire(redis_key, conf.ttl or 3600)
end

return _M

[EthanSivan]

I tried to copy the custom script to the plugins path of apisix, but encountered a read-only problem, but I have specified the corresponding custom lua path in config.yaml. I am not sure if this is the cause of the problem

[Baoyuantop]

https://github.com/apache/apisix-dashboard/blob/master/docs/en/latest/FAQ.md#4-after-modifying-the-plugin-schema-or-creating-a-custom-plugin-in-apache-apisix-why-cant-i-find-it-on-the-dashboard

[Baoyuantop]

Hi @WangChengXu, Is the problem solved?

[EthanSivan]

Hi @wangchengxu, Is the problem solved?

@Baoyuantop Thank you for your guidance, but I still haven't been able to resolve this issue.

[Baoyuantop]

From the error message in your screenshot, it looks like the jsonschema in the dashboard is not being updated to recognize your custom plugin.
Can you try using the admin api to configure the plugin?

[Baoyuantop]

If there is still a problem, please open it again.