Add idle auto-lock setting #1153
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest' | ||
| import { createIdleTracker } from './useIdleAutoLock' | ||
|
|
||
| function createMockWindow() { | ||
| const listeners = new Map<string, Set<EventListener>>() | ||
| const addSpy = vi.fn((event: string, handler: EventListener) => { | ||
| if (!listeners.has(event)) listeners.set(event, new Set()) | ||
| listeners.get(event)!.add(handler) | ||
| }) | ||
| const removeSpy = vi.fn((event: string, handler: EventListener) => { | ||
| listeners.get(event)?.delete(handler) | ||
| }) | ||
| const win = { | ||
| addEventListener: addSpy, | ||
| removeEventListener: removeSpy, | ||
| dispatch(event: string) { | ||
| listeners.get(event)?.forEach((handler) => handler(new Event(event))) | ||
| }, | ||
| } as unknown as Window & { dispatch: (event: string) => void } | ||
| return { win, addSpy, removeSpy } | ||
| } | ||
|
|
||
| describe('createIdleTracker', () => { | ||
| beforeEach(() => { | ||
| vi.useFakeTimers() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| vi.useRealTimers() | ||
| }) | ||
|
|
||
| it('fires callback after timeout period of inactivity', () => { | ||
| const onLock = vi.fn() | ||
| const { win } = createMockWindow() | ||
| const tracker = createIdleTracker(onLock, 5 * 60 * 1_000, win) | ||
| tracker.start() | ||
|
|
||
| vi.advanceTimersByTime(4 * 60 * 1_000) | ||
| expect(onLock).not.toHaveBeenCalled() | ||
|
|
||
| vi.advanceTimersByTime(1 * 60 * 1_000) | ||
| expect(onLock).toHaveBeenCalledTimes(1) | ||
| }) | ||
|
|
||
| it('resets timer on user activity', () => { | ||
| const onLock = vi.fn() | ||
| const { win } = createMockWindow() | ||
| const tracker = createIdleTracker(onLock, 5 * 60 * 1_000, win) | ||
| tracker.start() | ||
|
|
||
| // Advance 4 minutes | ||
| vi.advanceTimersByTime(4 * 60 * 1_000) | ||
| expect(onLock).not.toHaveBeenCalled() | ||
|
|
||
| // Simulate mouse activity | ||
| win.dispatch('mousemove') | ||
|
|
||
| // 4 more minutes from activity (would be 8 total, but timer restarted) | ||
| vi.advanceTimersByTime(4 * 60 * 1_000) | ||
| expect(onLock).not.toHaveBeenCalled() | ||
|
|
||
| // 1 more minute → 5 since last activity | ||
| vi.advanceTimersByTime(1 * 60 * 1_000) | ||
| expect(onLock).toHaveBeenCalledTimes(1) | ||
| }) | ||
|
|
||
| it('cleans up timers and listeners on stop', () => { | ||
| const onLock = vi.fn() | ||
| const { win, removeSpy } = createMockWindow() | ||
| const tracker = createIdleTracker(onLock, 5 * 60 * 1_000, win) | ||
| tracker.start() | ||
|
|
||
| tracker.stop() | ||
| expect(removeSpy).toHaveBeenCalled() | ||
|
|
||
| vi.advanceTimersByTime(10 * 60 * 1_000) | ||
| expect(onLock).not.toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('resets on keyboard activity', () => { | ||
| const onLock = vi.fn() | ||
| const { win } = createMockWindow() | ||
| const tracker = createIdleTracker(onLock, 1 * 60 * 1_000, win) | ||
| tracker.start() | ||
|
|
||
| vi.advanceTimersByTime(50_000) | ||
| win.dispatch('keydown') | ||
|
|
||
| vi.advanceTimersByTime(50_000) | ||
| expect(onLock).not.toHaveBeenCalled() | ||
|
|
||
| vi.advanceTimersByTime(10_000) | ||
| expect(onLock).toHaveBeenCalledTimes(1) | ||
| }) | ||
|
|
||
| it('registers listeners for all activity events', () => { | ||
| const onLock = vi.fn() | ||
| const { win, addSpy } = createMockWindow() | ||
| const tracker = createIdleTracker(onLock, 60_000, win) | ||
| tracker.start() | ||
|
|
||
| const calls = addSpy.mock.calls.map((c) => c[0]) | ||
| expect(calls).toContain('mousemove') | ||
| expect(calls).toContain('mousedown') | ||
| expect(calls).toContain('keydown') | ||
| expect(calls).toContain('touchstart') | ||
| expect(calls).toContain('scroll') | ||
| }) | ||
| }) |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import { useEffect, useRef } from 'react' | ||
|
|
||
| const ACTIVITY_EVENTS = ['mousemove', 'mousedown', 'keydown', 'touchstart', 'scroll'] as const | ||
|
|
||
| export function createIdleTracker(onLock: () => void, timeoutMs: number, win: Window) { | ||
| let timer: ReturnType<typeof setTimeout> | undefined | ||
|
|
||
| const resetTimer = () => { | ||
| if (timer) clearTimeout(timer) | ||
| timer = setTimeout(onLock, timeoutMs) | ||
| } | ||
|
|
||
| return { | ||
| start() { | ||
| resetTimer() | ||
| for (const event of ACTIVITY_EVENTS) { | ||
| win.addEventListener(event, resetTimer, { passive: true }) | ||
|
Collaborator
There was a problem hiding this comment. Can/should |
||
| } | ||
| }, | ||
| stop() { | ||
| if (timer) clearTimeout(timer) | ||
| timer = undefined | ||
| for (const event of ACTIVITY_EVENTS) { | ||
| win.removeEventListener(event, resetTimer) | ||
| } | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| export function useIdleAutoLock(onLock: () => void, timeoutMinutes: number) { | ||
| const onLockRef = useRef(onLock) | ||
|
Collaborator
There was a problem hiding this comment. Just curious.. why does not the timer not reset when |
||
|
|
||
| useEffect(() => { | ||
| onLockRef.current = onLock | ||
| }) | ||
|
|
||
| useEffect(() => { | ||
| if (timeoutMinutes <= 0) return | ||
|
|
||
| const tracker = createIdleTracker(() => onLockRef.current(), timeoutMinutes * 60 * 1_000, window) | ||
| tracker.start() | ||
|
|
||
| return () => tracker.stop() | ||
| }, [timeoutMinutes]) | ||
| } | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
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.
Nit: If
startreturns the stop function,AbortControllercan be used to simplify the listener removal.