|
| 1 | +import { act, renderHook } from "@testing-library/react"; |
| 2 | +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; |
| 3 | +import { USER_PRESENCE_IDLE_MS, useUserPresence } from "./useUserPresence"; |
| 4 | + |
| 5 | +const MINUTE = 60 * 1000; |
| 6 | + |
| 7 | +describe("useUserPresence", () => { |
| 8 | + beforeEach(() => { |
| 9 | + vi.useFakeTimers(); |
| 10 | + // Input only counts while the window has focus; jsdom has no real focus. |
| 11 | + vi.spyOn(document, "hasFocus").mockReturnValue(true); |
| 12 | + }); |
| 13 | + |
| 14 | + afterEach(() => { |
| 15 | + vi.useRealTimers(); |
| 16 | + }); |
| 17 | + |
| 18 | + it("starts present", () => { |
| 19 | + const { result } = renderHook(() => useUserPresence()); |
| 20 | + expect(result.current).toBe(true); |
| 21 | + }); |
| 22 | + |
| 23 | + it("flips to away after the idle threshold with no input", () => { |
| 24 | + const { result } = renderHook(() => useUserPresence()); |
| 25 | + |
| 26 | + act(() => { |
| 27 | + vi.advanceTimersByTime(USER_PRESENCE_IDLE_MS + MINUTE); |
| 28 | + }); |
| 29 | + |
| 30 | + expect(result.current).toBe(false); |
| 31 | + }); |
| 32 | + |
| 33 | + it("stays present while the user keeps interacting", () => { |
| 34 | + const { result } = renderHook(() => useUserPresence()); |
| 35 | + |
| 36 | + act(() => { |
| 37 | + for (let i = 0; i < 15; i++) { |
| 38 | + vi.advanceTimersByTime(MINUTE); |
| 39 | + window.dispatchEvent(new Event("pointermove")); |
| 40 | + } |
| 41 | + }); |
| 42 | + |
| 43 | + expect(result.current).toBe(true); |
| 44 | + }); |
| 45 | + |
| 46 | + it("returns to present on interaction after going away", () => { |
| 47 | + const { result } = renderHook(() => useUserPresence()); |
| 48 | + |
| 49 | + act(() => { |
| 50 | + vi.advanceTimersByTime(USER_PRESENCE_IDLE_MS + MINUTE); |
| 51 | + }); |
| 52 | + expect(result.current).toBe(false); |
| 53 | + |
| 54 | + act(() => { |
| 55 | + window.dispatchEvent(new Event("keydown")); |
| 56 | + }); |
| 57 | + |
| 58 | + expect(result.current).toBe(true); |
| 59 | + }); |
| 60 | + |
| 61 | + it("ignores input while the window is unfocused", () => { |
| 62 | + vi.spyOn(document, "hasFocus").mockReturnValue(false); |
| 63 | + const { result } = renderHook(() => useUserPresence()); |
| 64 | + |
| 65 | + act(() => { |
| 66 | + for (let i = 0; i < 11; i++) { |
| 67 | + vi.advanceTimersByTime(MINUTE); |
| 68 | + window.dispatchEvent(new Event("pointermove")); |
| 69 | + } |
| 70 | + }); |
| 71 | + |
| 72 | + expect(result.current).toBe(false); |
| 73 | + }); |
| 74 | + |
| 75 | + it("respects a custom idle threshold", () => { |
| 76 | + const { result } = renderHook(() => useUserPresence(2 * MINUTE)); |
| 77 | + |
| 78 | + act(() => { |
| 79 | + vi.advanceTimersByTime(3 * MINUTE); |
| 80 | + }); |
| 81 | + |
| 82 | + expect(result.current).toBe(false); |
| 83 | + }); |
| 84 | + |
| 85 | + it("stays present under a sub-throttle idle threshold while interacting", () => { |
| 86 | + // idleMs below the 15s activity throttle: the throttle must scale down or |
| 87 | + // active input would be dropped and the user pinned "away". |
| 88 | + const { result } = renderHook(() => useUserPresence(10_000)); |
| 89 | + |
| 90 | + act(() => { |
| 91 | + for (let i = 0; i < 20; i++) { |
| 92 | + vi.advanceTimersByTime(4_000); |
| 93 | + window.dispatchEvent(new Event("keydown")); |
| 94 | + } |
| 95 | + }); |
| 96 | + |
| 97 | + expect(result.current).toBe(true); |
| 98 | + }); |
| 99 | + |
| 100 | + it("removes listeners on unmount", () => { |
| 101 | + const removeSpy = vi.spyOn(window, "removeEventListener"); |
| 102 | + const { unmount } = renderHook(() => useUserPresence()); |
| 103 | + |
| 104 | + unmount(); |
| 105 | + |
| 106 | + const removed = removeSpy.mock.calls.map(([event]) => event); |
| 107 | + expect(removed).toEqual( |
| 108 | + expect.arrayContaining([ |
| 109 | + "pointerdown", |
| 110 | + "pointermove", |
| 111 | + "keydown", |
| 112 | + "wheel", |
| 113 | + "focus", |
| 114 | + ]), |
| 115 | + ); |
| 116 | + }); |
| 117 | +}); |
0 commit comments