From bb9eadc10d62dedb80613de6ced67a209d42339e Mon Sep 17 00:00:00 2001
From: Stephen Blott
Date: Thu, 14 May 2015 15:02:44 +0100
Subject: Rework how SimpleCache works.

Change the implementation of SimpleCache such that it does not rely upon
timers.  The problem with times is that they retain a reference to the
object even if Vimium itself loses all references.  This approach seems
simpler, and perfectly adequate for our purposes.
---
 lib/utils.coffee | 42 +++++++++++++++++-------------------------
 1 file changed, 17 insertions(+), 25 deletions(-)

(limited to 'lib')

diff --git a/lib/utils.coffee b/lib/utils.coffee
index a56340f5..cbc937b6 100644
--- a/lib/utils.coffee
+++ b/lib/utils.coffee
@@ -230,56 +230,48 @@ globalRoot.extend = (hash1, hash2) ->
 
 # A simple cache. Entries used within two expiry periods are retained, otherwise they are discarded.
 # At most 2 * @entries entries are retained.
-#
-# Note.  We need to be careful with @timer.  If all references to a cache are lost, then eventually its
-# contents must be garbage collected, which will not happen if there are active timers.
 class SimpleCache
   # expiry: expiry time in milliseconds (default, one hour)
-  # entries: maximum number of entries in @cache (there may be this many entries in @previous, too)
+  # entries: maximum number of entries in @cache (there may be up to this many entries in @previous, too)
   constructor: (@expiry = 60 * 60 * 1000, @entries = 1000) ->
     @cache = {}
     @previous = {}
-    @timer = null
-
-  rotate: ->
-    @previous = @cache
-    @cache = {}
-    # We reset the timer every time the cache is rotated (which could be because a previous timer expired, or
-    # because the number of @entries was exceeded).  We only restart the timer if the cache is not empty.
-    clearTimeout @timer if @timer?
-    @timer = null
-    @checkTimer() if 0 < Object.keys(@previous).length
-
-  checkTimer: ->
-    unless @timer?
-      @timer = Utils.setTimeout @expiry, => @rotate()
+    @lastRotation = new Date()
 
   has: (key) ->
+    @rotate()
     (key of @cache) or key of @previous
 
   # Set value, and return that value.  If value is null, then delete key.
   set: (key, value = null) ->
-    @checkTimer()
+    @rotate()
+    delete @previous[key]
     if value?
       @cache[key] = value
-      delete @previous[key]
-      @rotate() if @entries < Object.keys(@cache).length
     else
       delete @cache[key]
-      delete @previous[key]
-    value
+      null
 
   get: (key) ->
+    @rotate()
     if key of @cache
       @cache[key]
     else if key of @previous
       @cache[key] = @previous[key]
+      delete @previous[key]
+      @cache[key]
     else
       null
 
+  rotate: (force = false) ->
+    if force or @entries < Object.keys(@cache).length or @expiry < new Date() - @lastRotation
+      @lastRotation = new Date()
+      @previous = @cache
+      @cache = {}
+
   clear: ->
-    @rotate()
-    @rotate()
+    @rotate true
+    @rotate true
 
 # This is a simple class for the common case where we want to use some data value which may be immediately
 # available, or for which we may have to wait.  It implements a use-immediately-or-wait queue, and calls the
-- 
cgit v1.2.3