diff --git a/CHANGELOG.md b/CHANGELOG.md index c33500637..efc6747d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,35 +13,37 @@ Diff: [2.0.0...master] ## [2.0.0] -> Released on: 2018/03/17 +> Released on: 2018/03/18 This release implements numerous new features. The major version digit has been bumped to ensure that the changes to the interpretation of the callback return values (documented below) do not break any dependent application. -- Feature: implement a new `purge()` method to clear all cached items in both +#### Added + +- Implement a new `purge()` method to clear all cached items in both the L2 and L3 caches. [#34](https://github.com/thibaultcha/lua-resty-mlcache/pull/34) -- Feature: implement a new `shm_miss` option. This option receives the name +- Implement a new `shm_miss` option. This option receives the name of a lua_shared_dict, and when specified, will cache misses there instead of the instance's `shm` shared dict. This is particularly useful for certain types of workload where a large number of misses can be triggered and eventually evict too many cached values (hits) from the instance's `shm`. [#42](https://github.com/thibaultcha/lua-resty-mlcache/pull/42) -- Feature: implement a new `l1_serializer` callback option. It allows the +- Implement a new `l1_serializer` callback option. It allows the deserialization of data from L2 or L3 into arbitrary Lua data inside the LRU cache (L1). This includes userdata, cdata, functions, etc... Thanks to [@jdesgats](https://github.com/jdesgats) for the contribution. [#29](https://github.com/thibaultcha/lua-resty-mlcache/pull/29) -- Feature: implement a new `shm_set_tries` option to retry `shm:set()` +- Implement a new `shm_set_tries` option to retry `shm:set()` operations and ensure LRU eviction when caching unusually large values. [#41](https://github.com/thibaultcha/lua-resty-mlcache/issues/41) -- Feature: the L3 callback can now return `nil + err`, which will be bubbled up +- The L3 callback can now return `nil + err`, which will be bubbled up to the caller of `get()`. Prior to this change, the second return value of callbacks was ignored, and users had to throw hard Lua errors from inside their callbacks. [#35](https://github.com/thibaultcha/lua-resty-mlcache/pull/35) -- Feature: support for custom IPC module. +- Support for custom IPC module. [#31](https://github.com/thibaultcha/lua-resty-mlcache/issues/31) [Back to TOC](#table-of-contents) @@ -50,7 +52,9 @@ values (documented below) do not break any dependent application. > Released on: 2017/08/26 -- Fix: Do not rely on memory address of mlcache instance in invalidation events +#### Fixed + +- Do not rely on memory address of mlcache instance in invalidation events channel names. This ensures invalidation events are properly broadcasted to sibling instances in other workers. [#27](https://github.com/thibaultcha/lua-resty-mlcache/pull/27) diff --git a/lib/resty/mlcache.lua b/lib/resty/mlcache.lua index bc50ce73c..985c1309a 100644 --- a/lib/resty/mlcache.lua +++ b/lib/resty/mlcache.lua @@ -172,7 +172,7 @@ end local _M = { - _VERSION = "1.0.1", + _VERSION = "2.0.0", _AUTHOR = "Thibault Charbonnier", _LICENSE = "MIT", _URL = "https://github.com/thibaultcha/lua-resty-mlcache", diff --git a/lua-resty-mlcache-1.0.1-1.rockspec b/lua-resty-mlcache-2.0.0-1.rockspec similarity index 97% rename from lua-resty-mlcache-1.0.1-1.rockspec rename to lua-resty-mlcache-2.0.0-1.rockspec index d2afd2613..f4f497054 100644 --- a/lua-resty-mlcache-1.0.1-1.rockspec +++ b/lua-resty-mlcache-2.0.0-1.rockspec @@ -1,8 +1,8 @@ package = "lua-resty-mlcache" -version = "1.0.1-1" +version = "2.0.0-1" source = { url = "git://github.com/thibaultcha/lua-resty-mlcache", - tag = "1.0.1" + tag = "2.0.0" } description = { summary = "Multi-level caching library for OpenResty",