Merge pull request #15 from AppsFlyer/caffeine-2.9.0

caffeine 2.9.0

.gitignore

@@ -101,3 +101,4 @@ fabric.properties
 .classpath
 .project
 .settings
+.lsp

project.clj

@@ -1,9 +1,9 @@
-(defproject com.appsflyer/cloffeine "0.1.9"
+(defproject com.appsflyer/cloffeine "0.2.0"
   :description "A warpper over https://github.com/ben-manes/caffeine"
   :url "https://github.com/AppsFlyer/cloffeine"
   :license {:name "Eclipse Public License"
             :url  "http://www.eclipse.org/legal/epl-v10.html"}
-  :dependencies [[com.github.ben-manes.caffeine/caffeine "2.8.8"]]
+  :dependencies [[com.github.ben-manes.caffeine/caffeine "2.9.0"]]
   :plugins [[lein-codox "0.10.7"]]
   :codox {:output-path "codox"
           :source-uri  "http://github.com/AppsFlyer/cloffeine/blob/{version}/{filepath}#L{line}"

src/cloffeine/common.clj

@@ -2,7 +2,7 @@
   (:import [com.github.benmanes.caffeine.cache AsyncCacheLoader
                                                Cache
                                                CacheLoader
-                                               CacheWriter
+                                               RemovalListener
                                                Caffeine
                                                Weigher]
            [com.github.benmanes.caffeine.cache.stats CacheStats]
@@ -49,16 +49,13 @@
   * `:ticker` `com.github.benmanes.caffeine.cache.Ticker` Specifies a
       nanosecond-precision time source for use in determining when entries should
       be expired or refreshed. By default, System.nanoTime() is used.
-  * `:removalListener` `com.github.benmanes.caffeine.cache.RemovalListener`.
+  * `:weigher` `com.github.benmanes.caffeine.cache.Weigher` Specifies the weigher
+      to use in determining the weight of entries.
+  * `:evictionListener` `com.github.benmanes.caffeine.cache.RemovalListener` 
       Specifies a listener instance that caches should notify each time an entry
       is removed for any reason. Each cache created by this builder will invoke
       this listener as part of the routine maintenance described in the class
       documentation above.
-  * `:weigher` `com.github.benmanes.caffeine.cache.Weigher` Specifies the weigher
-      to use in determining the weight of entries.
-  * `:writer` `com.github.benmanes.caffeine.cache.CacheWriter` Specifies a writer
-      instance that caches should notify each time an entry is explicitly created
-      or modified, or removed for any reason.
   * `:timeUnit` ``[:ms :us :s :m :h :d]`` default is `:s`"
   ^Caffeine [settings]
   (let [bldr     (Caffeine/newBuilder)
@@ -83,7 +80,7 @@
             (:ticker settings) (.ticker (:ticker settings))
             (:removalListener settings) (.removalListener (:removalListener settings))
             (:weigher settings) (.weigher (:weigher settings))
-            (:writer settings) (.writer (:writer settings)))))
+            (:evictionListener settings) (.evictionListener (:evictionListener settings)))))
 
 (defn reify-async-cache-loader
   "A helper for implementing an `AsyncCacheLoader`.
@@ -125,19 +122,15 @@
      (reload [_this k v]
        (reloading-fn k v)))))
 
-(defn reify-cache-writer
-  "A helper for implementing `CacheWriter`
+(defn reify-removal-listener
+  "A helper for implementing `RemovalListener`
   
-  * `delete-handler` - `(fn [this k v removal-cause])`. Deletes the value
-    corresponding to the key from the external resource.
-  * `write-handler` - `(fn [this k v])`. Writes the value corresponding to the
-    key to the external resource."
-  [delete-handler write-handler]
-  (reify CacheWriter
-    (delete ^void [this k v removal-cause]
-      (delete-handler this k v removal-cause))
-    (write ^void [this k v]
-      (write-handler this k v))))
+  * `removal-handler` - `(fn [k v removal-cause])`. React upon removal
+  of k. `cause` is a `RemovalCause` enum: {COLLECTED|EXPIRED|EXPLICIT|REPLACED|SIZE}"
+  [removal-handler]
+  (reify RemovalListener
+    (onRemoval [_this k v cause] 
+      (removal-handler k v cause))))
 
 (defn reify-weigher
   "A helper for implementing `Weigher`.

test/cloffeine/core_test.clj

@@ -8,7 +8,7 @@
             [promesa.core :as p]
             [clojure.string :as s])
   (:import [com.google.common.testing FakeTicker]
-           [com.github.benmanes.caffeine.cache Ticker]
+           [com.github.benmanes.caffeine.cache Ticker RemovalCause]
            [java.util.concurrent TimeUnit]
            [java.util.logging Logger Level]
            [clojure.lang ExceptionInfo]))
@@ -192,6 +192,7 @@
   (let [loads (atom 0)
         reloads (atom 0)
         reload-fails? (atom false)
+        replaced (atom [])
         db (atom {:key 17})
         cl (common/reify-cache-loader
              (fn [k]
@@ -202,9 +203,14 @@
                (if @reload-fails?
                  (throw (Exception. (format "reload failed for key: %s" k)))
                  (get @db k))))
+        removal-listener (common/reify-removal-listener
+                           (fn [_k v cause]
+                             (when (= cause RemovalCause/REPLACED)
+                               (swap! replaced conj v))))
         ticker (FakeTicker.)
         lcache (loading-cache/make-cache cl {:refreshAfterWrite 10
                                              :timeUnit :s
+                                             :removalListener removal-listener
                                              :ticker (reify-ticker ticker)})]
     (testing "no key, load succeeds"
       (is (= 17 (loading-cache/get lcache :key)))
@@ -222,6 +228,7 @@
       (loading-cache/cleanup lcache)
       (Thread/sleep 10)
       (is (= 1 @reloads))
+      (is (= [17] @replaced))
       (is (= 42 (loading-cache/get lcache :key))))
     (testing "time to refresh again, but reload fails"
       (reset! reload-fails? true)
@@ -231,12 +238,14 @@
       (is (= 1 @reloads))
       (is (= 42 (loading-cache/get lcache :key)))
       (is (= 1 @reloads))
+      (is (= [17] @replaced))
       (reset! reload-fails? false)
       (.advance ticker 10 TimeUnit/SECONDS)
       (is (= 42 (loading-cache/get lcache :key)))
       (loading-cache/cleanup lcache)
       (Thread/sleep 10)
       (is (= 2 @reloads))
+      (is (= [17 42] @replaced))
       (is (= 43 (loading-cache/get lcache :key)))
       (is (= 2 @reloads)))))