screen-locker/screen_locker/_startup_checks.py
Krzysztof kuhy Rudnicki 6a07dc56aa
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
pre-commit / pre-commit (push) Waiting to run
Tests / test (push) Waiting to run
Tests / lock-popup-safety (push) Waiting to run
Tests / flutter-coverage (push) Waiting to run
Tests / web-coverage (push) Waiting to run
release-apk / release (APK) (push) Waiting to run
Reading hour from book-guard: +1h shutdown; base 20->19 from 2026-10-01
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-26 19:02:24 +02:00

250 lines
11 KiB
Python

"""Startup early-exit checks for the screen locker.
Split out of ``screen_lock.py`` to keep every file under the 250-line cap.
These run before any lock window is built and decide whether the lock is
needed at all: scheduled skip, weekly minimum already met, relaxed day, or
genuine extreme heat.
The entry point is ``_check_non_verify_exits``, which
``_auto_upgrade.AutoUpgradeMixin._check_early_exits`` calls.
"""
from __future__ import annotations
import logging
import sys
import tkinter as tk
from screen_locker._compliance_predicates import is_relaxed_day_skipped_today
from screen_locker._constants import (
EXTRA_BENEFITS_FILE,
HEAT_SKIP_CITY,
HEAT_SKIP_TEMP_THRESHOLD,
SHUTDOWN_BASE_FILE,
SICK_DAY_STATE_FILE,
)
from screen_locker._decision_log import (
LockDecision,
record_decision,
)
from screen_locker._degraded_sources import degraded_sources
from screen_locker._extra_benefits import process_week_transition
from screen_locker._lock_invariant import refuse_to_lock_over_logged_workout
from screen_locker._shutdown_base import (
apply_flat_bonuses_if_new,
reset_to_base_if_new_day,
)
from screen_locker._sync_mixin import SyncMixin
from screen_locker._temperature import (
HARD_TIMEOUT_SECONDS,
fetch_current_temp_with_status,
)
from screen_locker._weekly_check import (
WEEKLY_WORKOUT_MINIMUM,
count_weekly_workouts,
has_weekly_minimum,
is_relaxed_day,
)
__all__ = ["StartupChecksMixin"]
_logger = logging.getLogger(__name__)
class StartupChecksMixin(SyncMixin):
"""Decide, before building any UI, whether the lock should run today.
Inherits ``SyncMixin`` rather than sitting beside it in ``ScreenLocker``'s
base list: the early-exit sequence calls ``_ingest_synced_manual_workouts``
and ``_auto_fill_week_runnerup_bonus`` directly, so the dependency is real
and this keeps the god-class's ancestor count from growing.
"""
def _record_decision(
self, *, locked: bool, reason: str, detail: str, **extra: object
) -> None:
"""Record one lock decision, annotated with this week's progress.
The weekly count is attached to every decision because "was it right to
skip?" is unanswerable without it -- during the 2026-08 outage the
journal could not distinguish "5/5, correctly skipped" from "0/5, should
have locked".
"""
# A backend that could not be read makes weekly_count a floor, not a
# count. Say so on the decision line itself: on 2026-08-24 the only
# trace of a dead Firebase was a warning 90 seconds earlier, and the
# DECISION line read "weekly=0/5" as if that zero were a measurement.
unreadable = degraded_sources()
if unreadable:
extra = {
**extra,
"unreadable_sources": ",".join(src.name for src in unreadable),
}
record_decision(
LockDecision(
locked=locked,
reason=reason,
detail=detail,
weekly_count=count_weekly_workouts(self.log_file),
weekly_required=WEEKLY_WORKOUT_MINIMUM,
# Annotate with the conditions this first-match-wins ladder
# never reached, so "why not lock?" is answerable from the one
# line rather than by re-deriving the ladder by hand.
extra={**self._other_conditions(reason), **extra},
)
)
def _record_skip(self, reason: str, detail: str, **extra: object) -> None:
"""Record a decision not to enforce, then exit the process."""
self._record_decision(locked=False, reason=reason, detail=detail, **extra)
sys.exit(0)
def _check_non_verify_exits(self) -> None:
"""Check all normal (non-verify) startup early-exit conditions."""
if self._is_scheduled_skip_today():
self._record_skip("scheduled_skip_day", "Today is a scheduled skip day.")
return
# Award streak / shutdown-bonus / EB-extension rewards from last week
# before the daily reset, so a Monday transition's bonus is recorded
# in time for _apply_weekly_shutdown_bonus below to see it.
for reward_msg in process_week_transition(self.log_file, EXTRA_BENEFITS_FILE):
_logger.info("Weekly reward: %s", reward_msg)
# Reset shutdown config to base (19:00) at the start of each new day,
# then layer this week's earned bonus back on top of the fresh base.
if reset_to_base_if_new_day(
SHUTDOWN_BASE_FILE,
self,
sick_day_state_file=SICK_DAY_STATE_FILE,
log_file=self.log_file,
):
self._apply_weekly_shutdown_bonus()
# A LeetCode solve or a reading credit usually lands hours after the
# reset; this 5-minute tick turns it into the extra hour the same day.
apply_flat_bonuses_if_new(SHUTDOWN_BASE_FILE, self)
# Ingest any manual workouts synced from the phone (or another device)
# before the early-exit checks, so a manual logged off-app still counts
# toward today's/this week's minimum.
self._ingest_synced_manual_workouts()
# Auto-fill any RunnerUp workouts from earlier in the current ISO week
# before any early-exit check, so gaps are closed regardless of today's
# logged state (early_bird, sick_day, etc.).
self._auto_fill_week_runnerup_bonus()
if self._check_today_state_exits():
return
# Day-of-week routing: Tue/Wed/Thu relaxed (optional), Fri-Mon enforced.
if is_relaxed_day():
# The recurring 30-minute workout-locker.timer re-derives
# relaxed_day from scratch every tick, so without this check a
# dismissal via "Skip — No Penalty" would be forgotten by the very
# next run and the prompt would reappear.
if is_relaxed_day_skipped_today(self.log_file):
self._record_skip(
"relaxed_day_already_skipped",
"Relaxed day already dismissed via Skip — No Penalty today.",
)
return
self._record_decision(
locked=False,
reason="relaxed_day",
detail="Relaxed day (Tue-Thu) — showing the optional prompt.",
)
self._relaxed_day_mode = True
return
# Fri-Mon: skip lock when weekly minimum is already met.
if has_weekly_minimum(self.log_file):
self._record_skip(
"weekly_minimum_met",
f"Weekly minimum of {WEEKLY_WORKOUT_MINIMUM} workouts met.",
)
return
# Only remaining same-day skip: genuine extreme heat. Sick days go
# through the justification flow instead; there is no banked
# "skip a workout" credit — that mechanic works against the goal of
# maximizing weekly workouts, so it was removed in favor of a
# shutdown-time-only reward (see _apply_weekly_shutdown_bonus).
# A logged workout outranks every rung above, whatever their order.
if refuse_to_lock_over_logged_workout(self.has_logged_today, self._record_skip):
return
heat = self._check_heat_skip_exit()
# Nothing excused today: falling through here means the lock WILL be
# built. Recorded explicitly so the trail shows enforcement happening,
# not merely the absence of a skip -- "no line at all" was precisely
# the signature of the 2026-08 outage.
#
# The heat reading rides along because the check was previously
# invisible on its most common outcome: a grep for "temperat|heat"
# across ~1700 runs returned nothing, so "checked, 27°C, under the
# threshold" and "never got here" looked identical in the trail.
self._record_decision(
locked=True,
reason="enforced",
detail="No exemption applied — building the lock screen.",
heat_check=heat,
)
def _check_heat_skip_exit(self) -> str:
"""Exit early if today qualifies for the extreme-heat skip dialog.
Fail-closed by construction: a failed or timed-out temperature fetch
falls straight through to the lock, same as "not hot enough" — the
only difference is this logs *why* explicitly, so a fetch failure
is never silently indistinguishable from a normal day in the logs.
Returns:
A short summary of what the check saw, for the decision record.
Only returns at all when the lock is going ahead; the skip path
exits the process from inside ``_record_skip``.
"""
check = fetch_current_temp_with_status(HEAT_SKIP_CITY)
if check.timed_out:
_logger.warning(
"Heat-skip temperature check timed out after %.1fs — "
"defaulting to lock.",
HARD_TIMEOUT_SECONDS,
)
return "timed_out"
if check.temp_celsius is None:
_logger.warning(
"Heat-skip temperature check failed (network/API error) — "
"defaulting to lock."
)
return "fetch_failed"
if check.temp_celsius < HEAT_SKIP_TEMP_THRESHOLD:
# Logged even though nothing is wrong: this is the check's most
# common outcome and it used to leave no trace at all, so "the
# heat check ran and said no" was indistinguishable from "the
# heat check was never reached".
_logger.info(
"%s is %.0f°C, under the %d°C heat-skip threshold — "
"the lock goes ahead.",
HEAT_SKIP_CITY,
check.temp_celsius,
HEAT_SKIP_TEMP_THRESHOLD,
)
return f"{check.temp_celsius:.0f}C_under_threshold"
_logger.info(
"Temperature %.0f°C exceeds threshold — showing heat-skip dialog.",
check.temp_celsius,
)
try:
skipped = self._show_heat_skip_dialog(check.temp_celsius)
except tk.TclError as exc:
# The dialog owns its own tk.Tk(). With no reachable display that
# raises here, and letting it escape would kill the process before
# the "enforced" record below is written -- a lock that silently
# never happened. Offering no skip is the fail-closed answer.
_logger.warning(
"Heat-skip dialog could not be shown (%s) — defaulting to "
"lock rather than skipping the workout.",
exc,
)
return f"{check.temp_celsius:.0f}C_dialog_unavailable"
if skipped:
self._save_heat_skip_log(check.temp_celsius)
self._record_skip(
"heat_skip",
f"User skipped the workout due to heat ({check.temp_celsius:.0f}°C).",
temp_celsius=round(check.temp_celsius, 1),
)
return f"{check.temp_celsius:.0f}C_skip_declined"