apisix/t/core/lrucache.t

#
# 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();
log_level("info");

run_tests;

__DATA__

=== TEST 1: sanity
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local idx = 0
            local function create_obj()
                idx = idx + 1
                return {idx = idx}
            end

            local obj = core.lrucache.global("key", nil, create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = core.lrucache.global("key", nil, create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = core.lrucache.global("key", "1", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))
        }
    }
--- request
GET /t
--- response_body
obj: {"idx":1}
obj: {"idx":1}
obj: {"idx":2}
--- no_error_log
[error]



=== TEST 2: new
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local idx = 0
            local function create_obj()
                idx = idx + 1
                return {idx = idx}
            end

            local lru_get = core.lrucache.new()

            local obj = lru_get("key", nil, create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = lru_get("key", nil, create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = lru_get("key", "1", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = lru_get("key", "1", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = lru_get("key-different", "1", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))
        }
    }
--- request
GET /t
--- response_body
obj: {"idx":1}
obj: {"idx":1}
obj: {"idx":2}
obj: {"idx":2}
obj: {"idx":3}
--- no_error_log
[error]



=== TEST 3: cache the non-table object, eg: number or string
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local idx = 0
            local function create_num()
                idx = idx + 1
                return idx
            end

            local obj = core.lrucache.global("key", nil, create_num)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = core.lrucache.global("key", nil, create_num)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            obj = core.lrucache.global("key", "1", create_num)
            ngx.say("obj: ", require("toolkit.json").encode(obj))
        }
    }
--- request
GET /t
--- response_body
obj: 1
obj: 1
obj: 2
--- no_error_log
[error]



=== TEST 4: sanity
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local function server_release(self)
                ngx.say("release: ", require("toolkit.json").encode(self))
            end

            local lrucache_server_picker = core.lrucache.new({
                ttl = 300, count = 256, release = server_release,
            })

            local t1 = lrucache_server_picker("nnn", "t1",
                function () return {name = "aaa"} end)

            ngx.say("obj: ", require("toolkit.json").encode(t1))

            local t2 = lrucache_server_picker("nnn", "t2",
                function () return {name = "bbb"} end)

            ngx.say("obj: ", require("toolkit.json").encode(t2))
        }
    }
--- request
GET /t
--- response_body
obj: {"name":"aaa"}
release: {"name":"aaa"}
obj: {"name":"bbb"}
--- no_error_log
[error]



=== TEST 5: invalid_stale = true
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local idx = 0
            local function create_obj()
                idx = idx + 1
                return {idx = idx}
            end

            local lru_get = core.lrucache.new({
                ttl = 0.1, count = 256, invalid_stale = true,
            })

            local obj = lru_get("key", "ver", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))
            local obj = lru_get("key", "ver", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))

            ngx.sleep(0.15)
            local obj = lru_get("key", "ver", create_obj)
            ngx.say("obj: ", require("toolkit.json").encode(obj))
        }
    }
--- request
GET /t
--- response_body
obj: {"idx":1}
obj: {"idx":1}
obj: {"idx":2}
--- no_error_log
[error]



=== TEST 6: when creating cached objects, use resty-lock to avoid repeated creation.
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local idx = 0
            local function create_obj()
                idx = idx + 1
                ngx.sleep(0.1)
                return {idx = idx}
            end

            local lru_get = core.lrucache.new({
                ttl = 1, count = 256, invalid_stale = true, serial_creating = true,
            })

            local function f()
                local obj = lru_get("key", "ver", create_obj)
                ngx.say("obj: ", require("toolkit.json").encode(obj))
            end

            ngx.thread.spawn(f)
            ngx.thread.spawn(f)

            ngx.sleep(0.3)
        }
    }
--- request
GET /t
--- response_body
obj: {"idx":1}
obj: {"idx":1}
--- no_error_log
[error]



=== TEST 7: different `key` and `ver`, cached same one table
--- config
    location /t {
        content_by_lua_block {
            local core = require("apisix.core")

            local item = {}
            local idx = 0
            local function create_obj()
                idx = idx + 1
                ngx.say("create obj ", idx, " time")
                return item
            end

            local lru_get = core.lrucache.new({
                ttl = 10, count = 256
            })

            local obj = lru_get("key", "ver", create_obj)
            ngx.say("fetch obj: ", obj == item)

            obj = lru_get("key2", "ver2", create_obj)
            ngx.say("fetch obj: ", obj == item)

            obj = lru_get("key", "ver", create_obj)
            ngx.say("fetch obj: ", obj == item)
        }
    }
--- request
GET /t
--- response_body
create obj 1 time
fetch obj: true
create obj 2 time
fetch obj: true
fetch obj: true
--- no_error_log
[error]