From 19e103fea2e55a3e3bc3a777b4c618e644b57760 Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Sun, 28 Jun 2026 03:56:24 -0400
Subject: fix: stop the mode-line cleanly when disabled before startup fires

The delayed initial fetch was scheduled with run-at-time but the one-shot timer
was discarded, and when the mode is enabled before after-init the start is
queued on after-init-hook. Disabling the mode before either fired could still
start timers, hit the network, or mutate mode-line state after the user turned
it off. Stop now cancels the stored startup timer and removes the after-init
hook, and the startup callback no-ops when the mode is off.
---
 tests/test-wttrin--mode-line-start.el           | 12 ++++--
 tests/test-wttrin--mode-line-timer-lifecycle.el | 55 +++++++++++++++++++++++++
 2 files changed, 64 insertions(+), 3 deletions(-)
 create mode 100644 tests/test-wttrin--mode-line-timer-lifecycle.el

(limited to 'tests')

diff --git a/tests/test-wttrin--mode-line-start.el b/tests/test-wttrin--mode-line-start.el
index 1b86689..21cdb24 100644
--- a/tests/test-wttrin--mode-line-start.el
+++ b/tests/test-wttrin--mode-line-start.el
@@ -21,7 +21,8 @@
   (setq wttrin-mode-line-string nil)
   (setq wttrin--mode-line-cache nil)
   (setq wttrin--mode-line-timer nil)
-  (setq wttrin--buffer-refresh-timer nil))
+  (setq wttrin--buffer-refresh-timer nil)
+  (setq wttrin--mode-line-startup-timer nil))
 
 (defun test-wttrin--mode-line-start-teardown ()
   "Teardown for mode-line-start tests."
@@ -30,10 +31,13 @@
     (cancel-timer wttrin--mode-line-timer))
   (when (timerp wttrin--buffer-refresh-timer)
     (cancel-timer wttrin--buffer-refresh-timer))
+  (when (timerp wttrin--mode-line-startup-timer)
+    (cancel-timer wttrin--mode-line-startup-timer))
   (setq wttrin-mode-line-string nil)
   (setq wttrin--mode-line-cache nil)
   (setq wttrin--mode-line-timer nil)
-  (setq wttrin--buffer-refresh-timer nil))
+  (setq wttrin--buffer-refresh-timer nil)
+  (setq wttrin--mode-line-startup-timer nil))
 
 ;;; Normal Cases
 
@@ -70,8 +74,10 @@
                                                 (null (plist-get call :repeat))))
                                          scheduled-calls)))
             (should initial-fetch)
+            ;; The delayed fetch goes through the enabled-guard wrapper so a
+            ;; disable before it fires is a no-op.
             (should (eq (plist-get initial-fetch :func)
-                        #'wttrin--mode-line-fetch-weather)))))
+                        #'wttrin--mode-line-fetch-weather-if-enabled)))))
     (test-wttrin--mode-line-start-teardown)))
 
 (ert-deftest test-wttrin--mode-line-start-normal-creates-repeating-mode-line-timer ()
diff --git a/tests/test-wttrin--mode-line-timer-lifecycle.el b/tests/test-wttrin--mode-line-timer-lifecycle.el
new file mode 100644
index 0000000..2cd5b9f
--- /dev/null
+++ b/tests/test-wttrin--mode-line-timer-lifecycle.el
@@ -0,0 +1,55 @@
+;;; test-wttrin--mode-line-timer-lifecycle.el --- Mode-line timer lifecycle -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2024-2026 Craig Jennings
+
+;;; Commentary:
+;; Tests that disabling wttrin-mode-line-mode before the delayed startup fetch
+;; fires cannot start the mode-line: the one-shot startup timer is cancelled and
+;; the deferred after-init hook is removed, and the startup callback no-ops when
+;; the mode is off.
+
+;;; Code:
+
+(require 'ert)
+(require 'cl-lib)
+(require 'wttrin)
+(require 'testutil-wttrin)
+
+(ert-deftest test-wttrin--mode-line-fetch-weather-if-enabled-normal-runs-when-enabled ()
+  "Normal: the delayed startup fetch runs when the mode is on."
+  (let ((called nil))
+    (cl-letf (((symbol-function 'wttrin--mode-line-fetch-weather)
+               (lambda (&rest _) (setq called t))))
+      (let ((wttrin-mode-line-mode t))
+        (wttrin--mode-line-fetch-weather-if-enabled)
+        (should called)))))
+
+(ert-deftest test-wttrin--mode-line-fetch-weather-if-enabled-error-skips-when-disabled ()
+  "Error: the delayed startup fetch is skipped when the mode was turned off
+before it fired, so a disabled mode never hits the network or mutates state."
+  (let ((called nil))
+    (cl-letf (((symbol-function 'wttrin--mode-line-fetch-weather)
+               (lambda (&rest _) (setq called t))))
+      (let ((wttrin-mode-line-mode nil))
+        (wttrin--mode-line-fetch-weather-if-enabled)
+        (should-not called)))))
+
+(ert-deftest test-wttrin--mode-line-stop-boundary-cancels-startup-timer-and-hook ()
+  "Boundary: stop cancels a pending startup timer and removes the after-init
+hook, so neither can start the mode-line after the user disabled it."
+  (let ((wttrin--mode-line-timer nil)
+        (wttrin--buffer-refresh-timer nil)
+        (wttrin--mode-line-startup-timer (run-at-time 9999 nil #'ignore))
+        (wttrin-mode-line-string nil)
+        (wttrin--mode-line-cache nil)
+        (wttrin--mode-line-rendered-stale nil))
+    (add-hook 'after-init-hook #'wttrin--mode-line-start)
+    (unwind-protect
+        (progn
+          (wttrin--mode-line-stop)
+          (should (null wttrin--mode-line-startup-timer))
+          (should-not (memq #'wttrin--mode-line-start after-init-hook)))
+      (remove-hook 'after-init-hook #'wttrin--mode-line-start))))
+
+(provide 'test-wttrin--mode-line-timer-lifecycle)
+;;; test-wttrin--mode-line-timer-lifecycle.el ends here
-- 
cgit v1.2.3