Improve status refresh timing

Author: LK4D4

main.lua

@@ -90,6 +90,12 @@ end
 
 function StatusStats:onResume()
     self:refreshStatusBars()
+    self:startTicker()
+end
+
+function StatusStats:onOutOfScreenSaver()
+    self:refreshStatusBars()
+    self:startTicker()
 end
 
 function StatusStats:onCloseWidget()
@@ -331,10 +337,60 @@ function StatusStats:tickStatusBars()
     self:startTicker()
 end
 
+function StatusStats:getNextDurationRefreshDelay(seconds)
+    seconds = tonumber(seconds) or 0
+    if seconds <= 0 then
+        return 1
+    end
+    if seconds < 60 then
+        return 60 - seconds
+    end
+
+    local remainder = seconds % 60
+    if remainder == 0 then
+        return 60
+    end
+    return 60 - remainder
+end
+
+function StatusStats:getNextStatusRefreshDelay()
+    local delays = {}
+
+    if self.settings.session.time then
+        local session = self:getSessionStats()
+        if session then
+            table.insert(delays, self:getNextDurationRefreshDelay(session.time))
+        end
+    end
+
+    if self.settings.today.time then
+        local today = self:getTodayStats()
+        if today then
+            table.insert(delays, self:getNextDurationRefreshDelay(today.time))
+        end
+    end
+
+    if #delays == 0 then
+        if self.settings.session.time or self.settings.today.time then
+            return 60
+        end
+        return nil
+    end
+
+    local next_delay = delays[1]
+    for index = 2, #delays do
+        next_delay = math.min(next_delay, delays[index])
+    end
+    return next_delay
+end
+
 function StatusStats:startTicker()
     UIManager:unschedule(self.tickStatusBars, self)
     if self.settings.show_value_in_header or self.settings.show_value_in_footer then
-        UIManager:scheduleIn(60, self.tickStatusBars, self)
+        local next_delay = self:getNextStatusRefreshDelay()
+        if next_delay then
+            UIManager:scheduleIn(next_delay, self.tickStatusBars, self)
+        end
     end
 end
 

tests/statusstats_spec.lua

@@ -12,6 +12,20 @@ local function assertTrue(value, message)
     end
 end
 
+local ui_manager_state = {
+    shown = {},
+    unscheduled = {},
+    scheduled = {},
+    broadcasted = {},
+}
+
+local function resetUIManagerState()
+    ui_manager_state.shown = {}
+    ui_manager_state.unscheduled = {}
+    ui_manager_state.scheduled = {}
+    ui_manager_state.broadcasted = {}
+end
+
 package.preload["ui/event"] = function()
     return {
         new = function(_, name)
@@ -30,10 +44,25 @@ end
 
 package.preload["ui/uimanager"] = function()
     return {
-        show = function() end,
-        unschedule = function() end,
-        scheduleIn = function() end,
-        broadcastEvent = function() end,
+        show = function(_, widget)
+            table.insert(ui_manager_state.shown, widget)
+        end,
+        unschedule = function(_, callback, context)
+            table.insert(ui_manager_state.unscheduled, {
+                callback = callback,
+                context = context,
+            })
+        end,
+        scheduleIn = function(_, delay, callback, context)
+            table.insert(ui_manager_state.scheduled, {
+                delay = delay,
+                callback = callback,
+                context = context,
+            })
+        end,
+        broadcastEvent = function(_, event)
+            table.insert(ui_manager_state.broadcasted, event)
+        end,
     }
 end
 
@@ -85,6 +114,7 @@ local StatusStats = dofile("main.lua")
 
 local function newPlugin(settings, stats)
     saved_settings = settings
+    resetUIManagerState()
 
     local footer = {
         settings = {
@@ -267,6 +297,65 @@ assertTrue(menu_text:find("Today", 1, true) ~= nil, "today menu should exist")
 assertTrue(menu_text:find("Label style", 1, true) == nil, "label style menu should be removed")
 assertTrue(menu_text:find("Book stats", 1, true) == nil, "book stats menu should be removed")
 
+local time_refresh_plugin = newPlugin({
+    show_value_in_footer = true,
+    session = {
+        time = true,
+        pages = false,
+    },
+}, {
+    session = {
+        time = 125,
+        pages = 0,
+    },
+    today = {
+        time = 0,
+        pages = 0,
+    },
+})
+
+time_refresh_plugin:onReaderReady()
+
+assertEquals(ui_manager_state.scheduled[#ui_manager_state.scheduled].delay, 55, "time-based footer refresh should align to the next minute boundary")
+
+local pages_only_plugin = newPlugin({
+    show_value_in_footer = true,
+    session = {
+        time = false,
+        pages = true,
+    },
+}, {
+    session = {
+        time = 125,
+        pages = 3,
+    },
+    today = {
+        time = 0,
+        pages = 0,
+    },
+})
+
+pages_only_plugin:onReaderReady()
+
+assertEquals(#ui_manager_state.scheduled, 0, "page-only status display should not start a periodic ticker")
+
+local screensaver_plugin = newPlugin({
+    show_value_in_footer = true,
+}, {
+    session = {
+        time = 0,
+        pages = 0,
+    },
+    today = {
+        time = 0,
+        pages = 0,
+    },
+})
+
+screensaver_plugin:onOutOfScreenSaver()
+
+assertEquals(ui_manager_state.broadcasted[#ui_manager_state.broadcasted].name, "RefreshAdditionalContent", "leaving the screensaver should refresh the footer content")
+
 local startup_footer_plugin = newPlugin({
     show_value_in_footer = true,
 }, {