feat(powerMonitor): expose interface to query system idle state #11807
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,26 +10,28 @@ const assert = require('assert') | |
| const dbus = require('dbus-native') | ||
| const Promise = require('bluebird') | ||
|
|
||
| const skip = process.platform !== 'linux' || !process.env.DBUS_SYSTEM_BUS_ADDRESS | ||
|
|
||
| describe('powerMonitor', () => { | ||
| let logindMock, dbusMockPowerMonitor, getCalls, emitSignal, reset | ||
|
|
||
| if (!skip) { | ||
| before(async () => { | ||
| const systemBus = dbus.systemBus() | ||
| const loginService = systemBus.getService('org.freedesktop.login1') | ||
| const getInterface = Promise.promisify(loginService.getInterface, {context: loginService}) | ||
| logindMock = await getInterface('/org/freedesktop/login1', 'org.freedesktop.DBus.Mock') | ||
| getCalls = Promise.promisify(logindMock.GetCalls, {context: logindMock}) | ||
| emitSignal = Promise.promisify(logindMock.EmitSignal, {context: logindMock}) | ||
| reset = Promise.promisify(logindMock.Reset, {context: logindMock}) | ||
| }) | ||
|
|
||
| after(async () => { | ||
| await reset() | ||
| }) | ||
| } | ||
|
|
||
| (skip ? describe.skip : describe)('when powerMonitor module is loaded with dbus mock', () => { | ||
| function onceMethodCalled (done) { | ||
| function cb () { | ||
| logindMock.removeListener('MethodCalled', cb) | ||
|
|
@@ -41,7 +43,7 @@ const skip = process.platform !== 'linux' || !process.env.DBUS_SYSTEM_BUS_ADDRES | |
| before((done) => { | ||
| logindMock.on('MethodCalled', onceMethodCalled(done)) | ||
| // lazy load powerMonitor after we listen to MethodCalled mock signal | ||
| dbusMockPowerMonitor = require('electron').remote.powerMonitor | ||
|
There was a problem hiding this comment. @tarruda Is it required to lazy initialize the module ? I was hoping we can just initialize the module only once for all the specs here. There was a problem hiding this comment. It has to be lazy loaded if we want to verify that electron inhibits the system suspend (it does this by calling a method via dbus). |
||
| }) | ||
|
|
||
| it('should call Inhibit to delay suspend', async () => { | ||
|
|
@@ -59,14 +61,14 @@ const skip = process.platform !== 'linux' || !process.env.DBUS_SYSTEM_BUS_ADDRES | |
|
|
||
| describe('when PrepareForSleep(true) signal is sent by logind', () => { | ||
| it('should emit "suspend" event', (done) => { | ||
| dbusMockPowerMonitor.once('suspend', () => done()) | ||
| emitSignal('org.freedesktop.login1.Manager', 'PrepareForSleep', | ||
| 'b', [['b', true]]) | ||
| }) | ||
|
|
||
| describe('when PrepareForSleep(false) signal is sent by logind', () => { | ||
| it('should emit "resume" event', (done) => { | ||
| dbusMockPowerMonitor.once('resume', () => done()) | ||
| emitSignal('org.freedesktop.login1.Manager', 'PrepareForSleep', | ||
| 'b', [['b', false]]) | ||
| }) | ||
|
|
@@ -90,7 +92,7 @@ const skip = process.platform !== 'linux' || !process.env.DBUS_SYSTEM_BUS_ADDRES | |
| before(async () => { | ||
| const calls = await getCalls() | ||
| assert.equal(calls.length, 2) | ||
| dbusMockPowerMonitor.once('shutdown', () => { }) | ||
| }) | ||
|
|
||
| it('should call Inhibit to delay shutdown', async () => { | ||
|
|
@@ -108,11 +110,53 @@ const skip = process.platform !== 'linux' || !process.env.DBUS_SYSTEM_BUS_ADDRES | |
|
|
||
| describe('when PrepareForShutdown(true) signal is sent by logind', () => { | ||
| it('should emit "shutdown" event', (done) => { | ||
| dbusMockPowerMonitor.once('shutdown', () => { done() }) | ||
| emitSignal('org.freedesktop.login1.Manager', 'PrepareForShutdown', | ||
| 'b', [['b', true]]) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('when powerMonitor module is loaded', () => { | ||
| let powerMonitor | ||
| before(() => { | ||
| powerMonitor = require('electron').remote.powerMonitor | ||
| }) | ||
|
|
||
| describe('powerMonitor.querySystemIdleState', () => { | ||
| it('notify current system idle state', (done) => { | ||
| powerMonitor.querySystemIdleState(1, (idleState) => { | ||
| assert.ok(idleState) | ||
| done() | ||
| }) | ||
| }) | ||
|
|
||
| it('does not accept non positive integer threshold', () => { | ||
| assert.throws(() => { | ||
| powerMonitor.querySystemIdleState(-1, (idleState) => { | ||
| }) | ||
| }) | ||
|
|
||
| assert.throws(() => { | ||
| powerMonitor.querySystemIdleState(NaN, (idleState) => { | ||
| }) | ||
| }) | ||
|
|
||
| assert.throws(() => { | ||
| powerMonitor.querySystemIdleState('a', (idleState) => { | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('powerMonitor.querySystemIdleTime', () => { | ||
| it('notify current system idle time', (done) => { | ||
| powerMonitor.querySystemIdleTime((idleTime) => { | ||
| assert.ok(idleTime >= 0) | ||
| done() | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know another reviewer suggested this, but are we sure that we want this?
Since we're not publishing the
ui::CheckIdleStateIsLocked(), if all you want to do is check for system lock it's reasonable to pass a-1in foridle_threshold.If we include that method, we can avoid this wart by having a recommended way to test for lock
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm I didn't thought in that way, but also checking
lockstate is somewhat limited per platform support, so passing-1doesn't guarantee you can reliable acquire intended state. I think it's rather limit api surface, and exposeCheckIdleStateIsLockedseparately if there's demand for it.