bug: limit-count

[jeremy1392]

Current Behavior

I try to apply limit-count with redis to limit the API rate per consumers.
My redis server works well.

limit-count info:

count: 1000
time_window: 1000
key_type: var
key: consumer_name
rejected_code: 503
rejected_msg: API limit exceeds
policy: redis
allow_degradation: false
show_limit_quota_header: true
redis_host: redis.XXXX.XX
redis_port: 6379
redis_password: XXXXXX
redis_database: 0
redis_timeout: 1000

The 1st bug: it applies limit on routes and not on global and consumer_name is not working.

The 2nd bug: after some times, the plugin crashes:

Expected Behavior

API rate at consumer_name level.
If I have 30 routes and 1 consumer with API rate limiting of 1000.
I expect to have those 3000 requests split across routes.

Error Logs

2024/11/21 20:37:20 [warn] 57#57: 8 [lua] plugin.lua:954: decrypt_conf(): failed to get schema for plugin: limit-count, context: init_worker_by_lua

Steps to Reproduce

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
e9dd32464ac9 apache/apisix:latest "/docker-entrypoint.…" 57 minutes ago Up 2 minutes 0.0.0.0:32936->9080/tcp, :::32936->9080/tcp, 0.0.0.0:32935->9091/tcp, :::32935->9091/tcp, 0.0.0.0:32934->9092/tcp, :::32934->9092/tcp, 0.0.0.0:32933->9180/tcp, :::32933->9180/tcp, 0.0.0.0:32932->9443/tcp, :::32932->9443/tcp root_apisix_1
633a442adcf6 nginx:alpine "/docker-entrypoint.…" 6 weeks ago Up 6 weeks 0.0.0.0:80->80/tcp, :::80->80/tcp loadbalancer
d0b2957d213a apache/apisix-dashboard:3.0.0-alpine "/usr/local/apisix-d…" 6 weeks ago Up 6 weeks 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp apisix-dashboard
b9fe507b91d2 prom/prometheus:v2.25.0 "/bin/prometheus --c…" 6 weeks ago Up 6 weeks 9090/tcp prometheus
93afedfafa73 grafana/grafana:latest "/run.sh" 6 weeks ago Up 6 weeks 0.0.0.0:3000->3000/tcp, :::3000->3000/tcp grafana
1eb17a543ca0 bitnami/etcd:3.5.11 "/opt/bitnami/script…" 6 weeks ago Up 6 weeks 0.0.0.0:2379->2379/tcp, :::2379->2379/tcp, 2380/tcp etcd
8538722a1a75 grafana/loki:latest "/usr/bin/loki -conf…" 6 weeks ago Up 6 weeks 0.0.0.0:3100->3100/tcp, :::3100->3100/tcp loki

Environment

• APISIX version (run apisix version): latest
• Operating system (run uname -a): Linux Ubuntu-2204-jammy-amd64-base 5.15.0-118-generic change: merged the similar code, and not allowed to specify id when use POST method. #128-Ubuntu SMP Fri Jul 5 09:28:59 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux

[membphis]

what is your APISIX version?

you can exec: apisix version to fetch version info

[membphis]

I make a try with the latest APISIX: a851952

Tried to bind the limit-count to route or global rule, all are fine.

$ prove t/plugin/limit-count-redis-*-consumer.t
t/plugin/limit-count-redis-route-consumer.t ... ok
t/plugin/limit-count-redis-global-consumer.t .. ok
All tests successful.
Files=2, Tests=26,  3 wallclock secs ( 0.01 usr  0.01 sys +  0.58 cusr  0.26 csys =  0.86 CPU)
Result: PASS

We need more information to reproduce your issue, waiting for @jeremy1392 's response ^_^

enable plugin limit-count on route

Test results: There is no problem with this case, it runs normally without any errors.

Here are the steps:

# t/plugin/limit-count-redis-route-consumer.t
BEGIN {
    if ($ENV{TEST_NGINX_CHECK_LEAK}) {
        $SkipReason = "unavailable for the hup tests";

    } else {
        $ENV{TEST_NGINX_USE_HUP} = 1;
        undef $ENV{TEST_NGINX_USE_STAP};
    }
}

use t::APISIX 'no_plan';

repeat_each(1);
no_long_string();
no_shuffle();
no_root_location();

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

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

    if (!$block->error_log && !$block->no_error_log) {
        $block->set_value("no_error_log", "[error]\n[alert]");
    }
});

run_tests;

__DATA__


=== TEST 1: add consumer with username
--- config
    location /t {
        content_by_lua_block {
            local t = require("lib.test_admin").test
            local code, body = t('/apisix/admin/consumers',
                ngx.HTTP_PUT,
                [[{
                    "username": "jack",
                    "plugins": {
                        "key-auth": {
                            "key": "auth-one"
                        }
                    }
                }]]
                )

            if code >= 300 then
                ngx.status = code
            end
            ngx.say(body)
        }
    }
--- response_body
passed


=== TEST 2: set route, with redis host and port
--- config
    location /t {
        content_by_lua_block {
            local t = require("lib.test_admin").test
            local code, body = t('/apisix/admin/routes/1',
                ngx.HTTP_PUT,
                [[{
                    "uri": "/hello",
                    "plugins": {
                        "limit-count": {
                            "count": 1,
                            "time_window": 5,
                            "rejected_code": 503,
                            "key_type": "var",
                            "key": "consumer_name",
                            "allow_degradation": false,
                            "show_limit_quota_header": true,
                            "policy": "redis",
                            "redis_host": "127.0.0.1",
                            "redis_port": 6379,
                            "redis_timeout": 1001
                        },
                        "key-auth": {}
                    },
                    "upstream": {
                        "nodes": {
                            "127.0.0.1:1980": 1
                        },
                        "type": "roundrobin"
                    }
                }]]
                )

            if code >= 300 then
                ngx.status = code
            end
            ngx.say(body)
        }
    }
--- response_body
passed



=== TEST 3: up the limit
--- request
GET /hello
--- more_headers
apikey: auth-one
--- error_log
try to lock with key route&consumer#1&jack#redis
unlock with key route&consumer#1&jack#redis

enable plugin limit-count on global_rule

Test results: There is no problem with this case, it runs normally without any errors.

Here are the steps:

# t/plugin/limit-count-redis-global-consumer.t

BEGIN {
    if ($ENV{TEST_NGINX_CHECK_LEAK}) {
        $SkipReason = "unavailable for the hup tests";

    } else {
        $ENV{TEST_NGINX_USE_HUP} = 1;
        undef $ENV{TEST_NGINX_USE_STAP};
    }
}

use t::APISIX 'no_plan';

repeat_each(1);
no_long_string();
no_shuffle();
no_root_location();

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

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

    if (!$block->error_log && !$block->no_error_log) {
        $block->set_value("no_error_log", "[error]\n[alert]");
    }
});

run_tests;

__DATA__


=== TEST 1: add consumer with username
--- config
    location /t {
        content_by_lua_block {
            local t = require("lib.test_admin").test
            local code, body = t('/apisix/admin/consumers',
                ngx.HTTP_PUT,
                [[{
                    "username": "jack",
                    "plugins": {
                        "key-auth": {
                            "key": "auth-one"
                        }
                    }
                }]]
                )

            if code >= 300 then
                ngx.status = code
            end
            ngx.say(body)
        }
    }
--- response_body
passed



=== TEST 2: set global rule, with redis host and port
--- config
    location /t {
        content_by_lua_block {
            local t = require("lib.test_admin").test
            local code, body = t('/apisix/admin/global_rules/1',
                ngx.HTTP_PUT,
                [[{
                    "plugins": {
                        "limit-count": {
                            "count": 2,
                            "time_window": 5,
                            "rejected_code": 503,
                            "key_type": "var",
                            "key": "consumer_name",
                            "policy": "redis",
                            "redis_host": "127.0.0.1",
                            "redis_port": 6379,
                            "redis_timeout": 1001
                        }
                    }
                }]]
                )

            if code >= 300 then
                ngx.status = code
            end
            ngx.say(body)
        }
    }
--- response_body
passed



=== TEST 3: set route, with redis host and port
--- config
    location /t {
        content_by_lua_block {
            local t = require("lib.test_admin").test
            local code, body = t('/apisix/admin/routes/1',
                ngx.HTTP_PUT,
                [[{
                    "uri": "/hello",
                    "plugins": {
                        "key-auth": {}
                    },
                    "upstream": {
                        "nodes": {
                            "127.0.0.1:1980": 1
                        },
                        "type": "roundrobin"
                    }
                }]]
                )

            if code >= 300 then
                ngx.status = code
            end
            ngx.say(body)
        }
    }
--- response_body
passed



=== TEST 4: up the limit
--- request
GET /hello
--- more_headers
apikey: auth-one
--- error_log
try to lock with key global_rule#1#redis
unlock with key global_rule#1#redis