2019-09-12 12:15:08 +00:00
|
|
|
describe("AutoSuspend", function()
|
2017-06-23 17:04:11 +00:00
|
|
|
setup(function()
|
|
|
|
|
require("commonrequire")
|
|
|
|
|
package.unloadAll()
|
2019-02-18 16:01:00 +00:00
|
|
|
require("document/canvascontext"):init(require("device"))
|
2017-06-23 17:04:11 +00:00
|
|
|
end)
|
|
|
|
|
|
2019-09-12 12:15:08 +00:00
|
|
|
describe("suspend", function()
|
|
|
|
|
before_each(function()
|
|
|
|
|
local Device = require("device")
|
|
|
|
|
stub(Device, "isKobo")
|
|
|
|
|
Device.isKobo.returns(true)
|
|
|
|
|
Device.input.waitEvent = function() end
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
stub(UIManager, "suspend")
|
|
|
|
|
UIManager._run_forever = true
|
|
|
|
|
G_reader_settings:saveSetting("auto_suspend_timeout_seconds", 10)
|
|
|
|
|
require("mock_time"):install()
|
The great Input/GestureDetector/TimeVal spring cleanup (a.k.a., a saner main loop) (#7415)
* ReaderDictionary: Port delay computations to TimeVal
* ReaderHighlight: Port delay computations to TimeVal
* ReaderView: Port delay computations to TimeVal
* Android: Reset gesture detection state on APP_CMD_TERM_WINDOW.
This prevents potentially being stuck in bogus gesture states when switching apps.
* GestureDetector:
* Port delay computations to TimeVal
* Fixed delay computations to handle time warps (large and negative deltas).
* Simplified timed callback handling to invalidate timers much earlier, preventing accumulating useless timers that no longer have any chance of ever detecting a gesture.
* Fixed state clearing to handle the actual effective slots, instead of hard-coding slot 0 & slot 1.
* Simplified timed callback handling in general, and added support for a timerfd backend for better performance and accuracy.
* The improved timed callback handling allows us to detect and honor (as much as possible) the three possible clock sources usable by Linux evdev events.
The only case where synthetic timestamps are used (and that only to handle timed callbacks) is limited to non-timerfd platforms where input events use
a clock source that is *NOT* MONOTONIC.
AFAICT, that's pretty much... PocketBook, and that's it?
* Input:
* Use the <linux/input.h> FFI module instead of re-declaring every constant
* Fixed (verbose) debug logging of input events to actually translate said constants properly.
* Completely reset gesture detection state on suspend. This should prevent bogus gesture detection on resume.
* Refactored the waitEvent loop to make it easier to comprehend (hopefully) and much more efficient.
Of specific note, it no longer does a crazy select spam every 100µs, instead computing and relying on sane timeouts,
as afforded by switching the UI event/input loop to the MONOTONIC time base, and the refactored timed callbacks in GestureDetector.
* reMarkable: Stopped enforcing synthetic timestamps on input events, as it should no longer be necessary.
* TimeVal:
* Refactored and simplified, especially as far as metamethods are concerned (based on <bsd/sys/time.h>).
* Added a host of new methods to query the various POSIX clock sources, and made :now default to MONOTONIC.
* Removed the debug guard in __sub, as time going backwards can be a perfectly normal occurrence.
* New methods:
* Clock sources: :realtime, :monotonic, :monotonic_coarse, :realtime_coarse, :boottime
* Utility: :tonumber, :tousecs, :tomsecs, :fromnumber, :isPositive, :isZero
* UIManager:
* Ported event loop & scheduling to TimeVal, and switched to the MONOTONIC time base.
This ensures reliable and consistent scheduling, as time is ensured never to go backwards.
* Added a :getTime() method, that returns a cached TimeVal:now(), updated at the top of every UI frame.
It's used throughout the codebase to cadge a syscall in circumstances where we are guaranteed that a syscall would return a mostly identical value,
because very few time has passed.
The only code left that does live syscalls does it because it's actually necessary for accuracy,
and the only code left that does that in a REALTIME time base is code that *actually* deals with calendar time (e.g., Statistics).
* DictQuickLookup: Port delay computations to TimeVal
* FootNoteWidget: Port delay computations to TimeVal
* HTMLBoxWidget: Port delay computations to TimeVal
* Notification: Port delay computations to TimeVal
* TextBoxWidget: Port delay computations to TimeVal
* AutoSuspend: Port to TimeVal
* AutoTurn:
* Fix it so that settings are actually honored.
* Port to TimeVal
* BackgroundRunner: Port to TimeVal
* Calibre: Port benchmarking code to TimeVal
* BookInfoManager: Removed unnecessary yield in the metadata extraction subprocess now that subprocesses get scheduled properly.
* All in all, these changes reduced the CPU cost of a single tap by a factor of ten (!), and got rid of an insane amount of weird poll/wakeup cycles that must have been hell on CPU schedulers and batteries..
2021-03-30 00:57:59 +00:00
|
|
|
-- Reset UIManager:getTime()
|
|
|
|
|
UIManager:handleInput()
|
2019-09-12 12:15:08 +00:00
|
|
|
end)
|
2017-06-23 17:04:11 +00:00
|
|
|
|
2019-09-12 12:15:08 +00:00
|
|
|
after_each(function()
|
|
|
|
|
require("device").isKobo:revert()
|
|
|
|
|
require("ui/uimanager").suspend:revert()
|
|
|
|
|
G_reader_settings:delSetting("auto_suspend_timeout_seconds")
|
|
|
|
|
require("mock_time"):uninstall()
|
|
|
|
|
end)
|
2017-06-23 17:04:11 +00:00
|
|
|
|
2019-09-12 12:15:08 +00:00
|
|
|
it("should be able to execute suspend when timing out", function()
|
|
|
|
|
local mock_time = require("mock_time")
|
|
|
|
|
local widget_class = dofile("plugins/autosuspend.koplugin/main.lua")
|
|
|
|
|
local widget = widget_class:new() --luacheck: ignore
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.suspend).was.called(0)
|
|
|
|
|
mock_time:increase(6)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.suspend).was.called(1)
|
|
|
|
|
end)
|
2017-06-23 17:04:11 +00:00
|
|
|
|
2019-09-12 12:15:08 +00:00
|
|
|
it("should be able to deprecate last task", function()
|
|
|
|
|
local mock_time = require("mock_time")
|
|
|
|
|
local widget_class = dofile("plugins/autosuspend.koplugin/main.lua")
|
|
|
|
|
local widget = widget_class:new()
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.suspend).was.called(0)
|
|
|
|
|
widget:onInputEvent()
|
|
|
|
|
widget:onSuspend()
|
|
|
|
|
widget:onResume()
|
|
|
|
|
mock_time:increase(6)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.suspend).was.called(0)
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.suspend).was.called(1)
|
|
|
|
|
end)
|
2017-06-23 17:04:11 +00:00
|
|
|
end)
|
|
|
|
|
|
2019-09-12 12:15:08 +00:00
|
|
|
describe("shutdown", function()
|
|
|
|
|
--- @todo duplicate with above, elegant way to DRY?
|
|
|
|
|
before_each(function()
|
|
|
|
|
local Device = require("device")
|
|
|
|
|
stub(Device, "isKobo")
|
|
|
|
|
Device.isKobo.returns(true)
|
|
|
|
|
stub(Device, "canPowerOff")
|
|
|
|
|
Device.canPowerOff.returns(true)
|
|
|
|
|
Device.input.waitEvent = function() end
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
stub(UIManager, "poweroff_action")
|
|
|
|
|
UIManager._run_forever = true
|
|
|
|
|
G_reader_settings:saveSetting("autoshutdown_timeout_seconds", 10)
|
|
|
|
|
require("mock_time"):install()
|
The great Input/GestureDetector/TimeVal spring cleanup (a.k.a., a saner main loop) (#7415)
* ReaderDictionary: Port delay computations to TimeVal
* ReaderHighlight: Port delay computations to TimeVal
* ReaderView: Port delay computations to TimeVal
* Android: Reset gesture detection state on APP_CMD_TERM_WINDOW.
This prevents potentially being stuck in bogus gesture states when switching apps.
* GestureDetector:
* Port delay computations to TimeVal
* Fixed delay computations to handle time warps (large and negative deltas).
* Simplified timed callback handling to invalidate timers much earlier, preventing accumulating useless timers that no longer have any chance of ever detecting a gesture.
* Fixed state clearing to handle the actual effective slots, instead of hard-coding slot 0 & slot 1.
* Simplified timed callback handling in general, and added support for a timerfd backend for better performance and accuracy.
* The improved timed callback handling allows us to detect and honor (as much as possible) the three possible clock sources usable by Linux evdev events.
The only case where synthetic timestamps are used (and that only to handle timed callbacks) is limited to non-timerfd platforms where input events use
a clock source that is *NOT* MONOTONIC.
AFAICT, that's pretty much... PocketBook, and that's it?
* Input:
* Use the <linux/input.h> FFI module instead of re-declaring every constant
* Fixed (verbose) debug logging of input events to actually translate said constants properly.
* Completely reset gesture detection state on suspend. This should prevent bogus gesture detection on resume.
* Refactored the waitEvent loop to make it easier to comprehend (hopefully) and much more efficient.
Of specific note, it no longer does a crazy select spam every 100µs, instead computing and relying on sane timeouts,
as afforded by switching the UI event/input loop to the MONOTONIC time base, and the refactored timed callbacks in GestureDetector.
* reMarkable: Stopped enforcing synthetic timestamps on input events, as it should no longer be necessary.
* TimeVal:
* Refactored and simplified, especially as far as metamethods are concerned (based on <bsd/sys/time.h>).
* Added a host of new methods to query the various POSIX clock sources, and made :now default to MONOTONIC.
* Removed the debug guard in __sub, as time going backwards can be a perfectly normal occurrence.
* New methods:
* Clock sources: :realtime, :monotonic, :monotonic_coarse, :realtime_coarse, :boottime
* Utility: :tonumber, :tousecs, :tomsecs, :fromnumber, :isPositive, :isZero
* UIManager:
* Ported event loop & scheduling to TimeVal, and switched to the MONOTONIC time base.
This ensures reliable and consistent scheduling, as time is ensured never to go backwards.
* Added a :getTime() method, that returns a cached TimeVal:now(), updated at the top of every UI frame.
It's used throughout the codebase to cadge a syscall in circumstances where we are guaranteed that a syscall would return a mostly identical value,
because very few time has passed.
The only code left that does live syscalls does it because it's actually necessary for accuracy,
and the only code left that does that in a REALTIME time base is code that *actually* deals with calendar time (e.g., Statistics).
* DictQuickLookup: Port delay computations to TimeVal
* FootNoteWidget: Port delay computations to TimeVal
* HTMLBoxWidget: Port delay computations to TimeVal
* Notification: Port delay computations to TimeVal
* TextBoxWidget: Port delay computations to TimeVal
* AutoSuspend: Port to TimeVal
* AutoTurn:
* Fix it so that settings are actually honored.
* Port to TimeVal
* BackgroundRunner: Port to TimeVal
* Calibre: Port benchmarking code to TimeVal
* BookInfoManager: Removed unnecessary yield in the metadata extraction subprocess now that subprocesses get scheduled properly.
* All in all, these changes reduced the CPU cost of a single tap by a factor of ten (!), and got rid of an insane amount of weird poll/wakeup cycles that must have been hell on CPU schedulers and batteries..
2021-03-30 00:57:59 +00:00
|
|
|
-- Reset UIManager:getTime()
|
|
|
|
|
UIManager:handleInput()
|
2019-09-12 12:15:08 +00:00
|
|
|
end)
|
|
|
|
|
|
|
|
|
|
after_each(function()
|
|
|
|
|
require("device").isKobo:revert()
|
|
|
|
|
require("ui/uimanager").poweroff_action:revert()
|
|
|
|
|
G_reader_settings:delSetting("autoshutdown_timeout_seconds")
|
|
|
|
|
require("mock_time"):uninstall()
|
|
|
|
|
end)
|
|
|
|
|
|
|
|
|
|
it("should be able to execute suspend when timing out", function()
|
|
|
|
|
local mock_time = require("mock_time")
|
|
|
|
|
local widget_class = dofile("plugins/autosuspend.koplugin/main.lua")
|
|
|
|
|
local widget = widget_class:new() --luacheck: ignore
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.poweroff_action).was.called(0)
|
|
|
|
|
mock_time:increase(6)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.poweroff_action).was.called(1)
|
|
|
|
|
end)
|
|
|
|
|
|
|
|
|
|
it("should be able to deprecate last task", function()
|
|
|
|
|
local mock_time = require("mock_time")
|
|
|
|
|
local widget_class = dofile("plugins/autosuspend.koplugin/main.lua")
|
|
|
|
|
local widget = widget_class:new()
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
local UIManager = require("ui/uimanager")
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.poweroff_action).was.called(0)
|
|
|
|
|
widget:onInputEvent()
|
|
|
|
|
widget:onSuspend()
|
|
|
|
|
widget:onResume()
|
|
|
|
|
mock_time:increase(6)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.poweroff_action).was.called(0)
|
|
|
|
|
mock_time:increase(5)
|
|
|
|
|
UIManager:handleInput()
|
|
|
|
|
assert.stub(UIManager.poweroff_action).was.called(1)
|
|
|
|
|
end)
|
2017-06-23 17:04:11 +00:00
|
|
|
end)
|
|
|
|
|
end)
|
