fix: schedule settled refreshes after Codex activity

Author: ericweichun

menubar.py

@@ -143,6 +143,7 @@
 INSTALL_BUTTON_EXTRA_HEIGHT = BUTTON_HEIGHT + 10.0
 UPDATE_DISMISS_SECONDS = 24 * 3600
 UPDATE_ALERT_BODY_LIMIT = 2000
+SETTLED_REFRESH_DELAYS = (3.0, 15.0, 45.0)
 
 logger = logging.getLogger(__name__)
 
@@ -415,6 +416,7 @@ class AppDelegate(NSObject):
     _history_entries_cache_fingerprint = objc.ivar()
     _quota_notifier = objc.ivar()
     _switch_menu_action_taken = objc.ivar()
+    _settled_refresh_timers = objc.ivar()
     language = objc.ivar()
 
     def initWithMock_interval_(self, mock: bool, interval: int) -> AppDelegate:
@@ -442,6 +444,7 @@ def initWithMock_interval_(self, mock: bool, interval: int) -> AppDelegate:
         self._history_entries_cache = None
         self._history_entries_cache_fingerprint = None
         self._switch_menu_action_taken = False
+        self._settled_refresh_timers = []
         return self
 
     def applicationDidFinishLaunching_(self, notification: Any) -> None:
@@ -491,6 +494,7 @@ def timerFired_(self, timer: Any) -> None:
 
     def refreshNow_(self, sender: Any) -> None:
         self._refresh(queue_if_busy=True)
+        self._schedule_settled_refreshes()
 
     def installHook_(self, sender: Any) -> None:
         thread = threading.Thread(target=self._install_hook_in_background, daemon=True)
@@ -885,6 +889,33 @@ def _refresh(self, queue_if_busy: bool = False) -> None:
 
     def refreshFromFileEvent_(self, _sender: Any) -> None:
         self._refresh(queue_if_busy=True)
+        self._schedule_settled_refreshes()
+
+    def _schedule_settled_refreshes(self) -> None:
+        for timer in self._settled_refresh_timers:
+            with contextlib.suppress(Exception):
+                timer.invalidate()
+
+        timers = []
+        for delay in SETTLED_REFRESH_DELAYS:
+            timer = NSTimer.scheduledTimerWithTimeInterval_target_selector_userInfo_repeats_(
+                delay,
+                self,
+                "settledRefreshTimerFired:",
+                None,
+                False,
+            )
+            NSRunLoop.currentRunLoop().addTimer_forMode_(timer, NSRunLoopCommonModes)
+            timers.append(timer)
+        self._settled_refresh_timers = timers
+
+    def settledRefreshTimerFired_(self, timer: Any) -> None:
+        self._settled_refresh_timers = [
+            pending
+            for pending in self._settled_refresh_timers
+            if pending is not timer and pending.isValid()
+        ]
+        self._refresh(queue_if_busy=True)
 
     def _refresh_in_background(self) -> None:
         submitted = False

tests/test_menubar.py

@@ -1489,6 +1489,99 @@ def test_refresh_now_queues_when_refresh_is_busy() -> None:
     assert delegate._refresh_queued is True
 
 
+def test_schedule_settled_refreshes_replaces_pending_timers(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    class FakeTimer:
+        def __init__(self, delay: float) -> None:
+            self.delay = delay
+            self.invalidated = False
+
+        def invalidate(self) -> None:
+            self.invalidated = True
+
+        def isValid(self) -> bool:
+            return not self.invalidated
+
+    class FakeNSTimer:
+        created: list[FakeTimer] = []
+
+        @staticmethod
+        def scheduledTimerWithTimeInterval_target_selector_userInfo_repeats_(
+            delay: float,
+            _target: object,
+            _selector: str,
+            _user_info: object,
+            _repeats: bool,
+        ) -> FakeTimer:
+            timer = FakeTimer(delay)
+            FakeNSTimer.created.append(timer)
+            return timer
+
+    class FakeRunLoop:
+        added: list[FakeTimer] = []
+
+        @staticmethod
+        def currentRunLoop() -> type[FakeRunLoop]:
+            return FakeRunLoop
+
+        @staticmethod
+        def addTimer_forMode_(timer: FakeTimer, _mode: object) -> None:
+            FakeRunLoop.added.append(timer)
+
+    class Delegate:
+        _settled_refresh_timers: list[FakeTimer]
+
+        def __init__(self) -> None:
+            self._settled_refresh_timers = [FakeTimer(1.0)]
+
+    old_timer = Delegate()._settled_refresh_timers[0]
+    delegate = Delegate()
+    delegate._settled_refresh_timers = [old_timer]
+    monkeypatch.setattr(menubar, "NSTimer", FakeNSTimer)
+    monkeypatch.setattr(menubar, "NSRunLoop", FakeRunLoop)
+
+    menubar.AppDelegate._schedule_settled_refreshes(cast(Any, delegate))
+
+    assert old_timer.invalidated is True
+    assert [timer.delay for timer in delegate._settled_refresh_timers] == list(
+        menubar.SETTLED_REFRESH_DELAYS
+    )
+    assert FakeRunLoop.added == delegate._settled_refresh_timers
+
+
+def test_settled_refresh_timer_fires_queued_refresh(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    class FakeTimer:
+        def __init__(self, valid: bool) -> None:
+            self._valid = valid
+
+        def isValid(self) -> bool:
+            return self._valid
+
+    refresh_calls = 0
+    queue_flags: list[bool] = []
+
+    def fake_refresh(_self: object, *, queue_if_busy: bool = False) -> None:
+        nonlocal refresh_calls
+        refresh_calls += 1
+        queue_flags.append(queue_if_busy)
+
+    delegate = menubar.AppDelegate.alloc().initWithMock_interval_(True, 60)
+    fired = FakeTimer(True)
+    pending = FakeTimer(True)
+    invalid = FakeTimer(False)
+    delegate._settled_refresh_timers = [fired, pending, invalid]
+    monkeypatch.setattr(menubar.AppDelegate, "_refresh", fake_refresh)
+
+    delegate.settledRefreshTimerFired_(fired)
+
+    assert delegate._settled_refresh_timers == [pending]
+    assert refresh_calls == 1
+    assert queue_flags == [True]
+
+
 def test_apply_refresh_result_clears_busy_flag_when_ui_update_fails() -> None:
     class FailingPopover:
         def isShown(self) -> bool: