From b638b91169ad4be515c488cf3062c6d09e9214d3 Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Mon, 5 Oct 2026 09:36:12 -0400 Subject: [PATCH 1/3] feat(common): sports_game_over -- the reconciled game-over check (sports family 5) (#770) * feat(common): sports_game_over -- the reconciled game-over check (sports family 5) New hardware-free module src/common/sports_game_over.py with SportsGameOverMixin._is_game_really_over, the scoreboards' SportsLive check that drops a game ESPN still lists as live, copied from ledmatrix-plugins claude/family5-reconcile once the nine copies (five bodies) became one. Over on a final period text; from period FINAL_PERIOD on, also on a 0:00 clock string unless the score is level (a tie at the end of regulation goes to overtime; a game that ends tied ends on its final status). FINAL_PERIOD is the one per-sport seam, a class attribute defaulting to None (the clock never ends a game); the scoreboards declare 3 (hockey), 4 (basketball, football, lacrosse) or None (afl, nrl, soccer, baseball, ufc). - test/test_sports_game_over.py: the plugins' pinned matrix folded to the three FINAL_PERIOD values, edge shapes, the tie guard, ufc's recorded ESPN MMA states, an override deferring through super() (baseball), the base order with SportsLiveSharedMixin._detect_stale_games, host contract. - test/test_sports_game_over_parity.py: with LEDMATRIX_PLUGINS, compares the body with every plugin copy (drift-report normalisation plus decorators) and each plugin's FINAL_PERIOD with the owner's decision. - mypy ratchet, src/common/README.md, CHANGELOG (Unreleased, New modules). - docs/SPORTS_UNIFICATION.md: family 5 status and decisions; the seam tables now match the code (FINAL_PERIOD defaults to None; the CLOCK_COUNTS_DOWN seam never existed and is gone from the doc). Co-Authored-By: Claude Opus 5.5 * docs: cite ledmatrix-plugins #625 for the family 5 reconcile Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- CHANGELOG.md | 10 + docs/SPORTS_UNIFICATION.md | 55 ++++-- mypy-clean.txt | 1 + src/common/README.md | 11 ++ src/common/sports_game_over.py | 125 ++++++++++++ src/common/sports_shared.py | 4 +- test/test_sports_game_over.py | 275 +++++++++++++++++++++++++++ test/test_sports_game_over_parity.py | 123 ++++++++++++ 8 files changed, 584 insertions(+), 20 deletions(-) create mode 100644 src/common/sports_game_over.py create mode 100644 test/test_sports_game_over.py create mode 100644 test/test_sports_game_over_parity.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ba95dce..0a260dad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -668,6 +668,16 @@ policies are unchanged. - `src/display_arbiter.py` -- the display loop's Arbiter (see Tooling). Core-internal: plugins have no reason to import it, so it sets no `ledmatrix_min_version` floor. +- `src/common/sports_game_over.py` -- `SportsGameOverMixin`, sports + consolidation family 5: `_is_game_really_over`, the scoreboards' + `SportsLive` check that drops a game ESPN still lists as live, once the + plugins made their five bodies one. Over on a final period text, or on a + 0:00 clock from period `FINAL_PERIOD` on unless the score is level (a tie + at the end of regulation goes to overtime). `FINAL_PERIOD` is the per-sport + class attribute, `None` by default (the clock never ends a game); the + scoreboards declare 3 (hockey), 4 (basketball, football, lacrosse) or + `None`. List the mixin before `SportsLiveSharedMixin`. A plugin may import + it once it floors on the release that ships it, and deletes its copy then. ### Tooling diff --git a/docs/SPORTS_UNIFICATION.md b/docs/SPORTS_UNIFICATION.md index fe72fe06..3c7072f2 100644 --- a/docs/SPORTS_UNIFICATION.md +++ b/docs/SPORTS_UNIFICATION.md @@ -91,6 +91,7 @@ more. Shared sports code lives in `src/common`: | `sports_live_scroll.py` | next release | `SportsLiveScrollMixin` — rebuild a live scroll strip mid-cycle, keeping the marquee's place | | `sports_display_rules.py` | next release | `SportsCardOptionsMixin`, `SportsGameRulesMixin` — scorebug date options, the no-favourites filter, non-favourite live dwell | | `sports_font_path.py` | next release | `resolve_font_path` — what the plugins' `_resolve_font_path` copies return | +| `sports_game_over.py` | next release | `SportsGameOverMixin` — `_is_game_really_over`, with the `FINAL_PERIOD` seam (family 5) | Each is described in [src/common/README.md](../src/common/README.md). @@ -134,8 +135,7 @@ constants rather than behavior: | Attribute | Meaning | Default | |---|---|---| -| `FINAL_PERIOD` | Period at/after which a zero clock can mean "over" | `4` (hockey overrides to `3`) | -| `CLOCK_COUNTS_DOWN` | Whether `0:00` means "expired" | `True` (soccer/afl/nrl override to `False` — their clocks count up, so `0:00` is kickoff) | +| `FINAL_PERIOD` | Period from which a 0:00 clock ends a game (`sports_game_over`) | `None`: the clock never ends a game (afl, nrl, soccer, baseball, ufc). Hockey sets `3`; basketball, football and lacrosse `4` | | `COALESCE_SCORING_SEQUENCE` | Fold score increments arriving during an active celebration into that one celebration | `False` (football overrides to `True` — a touchdown lands as +6, then +1 for the extra point) | ### Why these are seams and not branches @@ -146,11 +146,14 @@ so NRL matches favorites on team ID. Flattening every plugin to abbreviations would silently select the wrong club for NRL users. The base declares the seam, NRL fills it, and core never learns the string `"nrl"`. -`CLOCK_COUNTS_DOWN` exists for the same reason in the opposite direction: a +`FINAL_PERIOD` exists for the same reason in the opposite direction: a soccer clock reading `0:00` means the match has not kicked off, so running the -clock-expiry branch there would evict live games. +clock-expiry rule there would evict live games. Those sports declare `None`, +and so do baseball (innings, not a clock) and ufc (a bout ends only on ESPN's +final status). One attribute covers both questions, whether the clock can end +a game and from which period, so no separate count-down flag was added. -`COALESCE_SCORING_SEQUENCE` is the third of the same kind. In football one +`COALESCE_SCORING_SEQUENCE` is another of the same kind. In football one scoring play arrives as two score updates, so the follow-up must be folded into the first celebration; in soccer two increments a few seconds apart are two real goals, and folding them would swallow one. Neither default is "right" — which is @@ -298,6 +301,20 @@ Left in the plugins, though identical: renderers) is already core's, in `SportsHelpersMixin`; a renderer that wants it can inherit that. +### Family 5: the game-over check (core done; adoption waits for a release) + +The pilot of the method below. ledmatrix-plugins `scripts/test_game_over_check.py` +(#621) pinned 3,115 answers across the nine plugins first; the reconcile +(ledmatrix-plugins #625) made the five bodies one and +changed only the cells the owner's decisions under +[Product decisions](#product-decisions-each-family-needs) explain: ufc's +clock rule (65 cells), baseball's dormant one (53, every one a game with a +`period` baseball's games never carry), and a level score at 0:00 (five +cells in hockey, basketball, football and lacrosse). The harness renders +were pixel-identical. `src/common/sports_game_over.py` holds the body; +`test/test_sports_game_over_parity.py` compares it, and each plugin's +`FINAL_PERIOD`, with the plugin copies. + ### Why the method changes Byte-identical promotion has nearly run dry. Measured on ledmatrix-plugins @@ -333,8 +350,8 @@ game-over check); the report measures each method in it. The procedure: line in each plugin. - *A per-sport fact* (hockey ends in period 3; a soccer clock counts up). Make it a declared class constant or override point with a default, as - `FINAL_PERIOD`, `CLOCK_COUNTS_DOWN`, `COALESCE_SCORING_SEQUENCE` and - `_favorite_key` are, and add it to the tables above. Never a sport-name + `FINAL_PERIOD`, `COALESCE_SCORING_SEQUENCE` and `_favorite_key` are, + and add it to the tables above. Never a sport-name branch: core must not learn sport names. - *A product difference*: anything a user can see (which games show, a colour, a date, a badge, how long a screen stays). The owner picks the @@ -382,7 +399,7 @@ release. | # | Family | Methods (variants) | Why here | |---|---|---|---| | 4 | Identical sweep | `manager.py`: `_dispatch_switch_refresh`, `_favorite_team_is_live`, `get_vegas_priority_weight`, `_game_involves`, `_favorite_scan_targets`, `_favorite_scan_games`, `_get_total_games_for_manager` (all nine, 1); the live-scroll helpers `_preserving_scroll_position`, `_refresh_live_scroll_managers`, `_live_scroll_managers`, `_note_live_scroll_built`, `_live_scroll_needs_rebuild`, `_live_scroll_fields` (eight, 1). `sports.py`: `_card_option`, `_filtered_or_all`, `_effective_live_duration`, `_recent_date_text` (eight, 1). 58 identical families in all | Nothing to decide; brings `manager.py` into core as a `SportsPluginHostMixin`. `_resolve_font_path` (identical in nine `sports.py` and eight renderers) becomes `sports_font_path.resolve_font_path`, not `font_layout.resolve_asset_path`, which skips the cwd. Core side done; see [Stage 4](#stage-4-the-identical-sweep-core-done-adoption-waits-for-a-release) | -| 5 | Game-over check | `SportsLive._is_game_really_over` (5) | Pure logic, no pixels; its seams (`FINAL_PERIOD`, `CLOCK_COUNTS_DOWN`) were designed in B1. The pilot for the procedure | +| 5 | Game-over check | `SportsLive._is_game_really_over` (5) | Pure logic, no pixels; one seam, `FINAL_PERIOD`. The pilot for the procedure. Reconciled to one body and promoted as `sports_game_over`; adoption waits for the release that ships it. See [Family 5](#family-5-the-game-over-check-core-done-adoption-waits-for-a-release) | | 6 | Favourite matching | `_is_favorite_game` (7 across three classes), `_select_games_for_display` (2: nrl), `_select_recent_games_for_display` (3) | Everything that asks "is this a favourite" goes through the 3.5.0 `_favorite_key` seam | | 7 | Other-games rotation | `_by_importance`, `_other_games_window`, `_advance_other_games_if_due` (2 each: football), `_rotate_other_games_on_display` (2: ufc) | One outlier each; football carries two fixes the other eight lack | | 8 | Rankings | `_fetch_team_rankings` (3), `_choose_poll` (3), `_load_division_team_ids`, `_passes_other_filters`, `_best_rank`, `_is_ranked_game` (2 each: football) | Needs 7; the rank badge and the "ranked only" filter read it | @@ -416,17 +433,17 @@ family 9 prepares. Owner calls to make before (or while) reconciling. Items marked *verify* are suspected behaviour that needs a payload or a rig to confirm first. -- **5, game-over check.** Which rule each sport gets: the clock never ends a - game in afl, nrl and soccer (`CLOCK_COUNTS_DOWN = False`); hockey ends at - 0:00 from period 3, basketball, football and lacrosse from period 4. - baseball and ufc share a copy that reads a missing clock as "0:00": dormant - in baseball (its games carry no `period`), and not triggered by ufc's round - breaks either. ESPN sends a break as `STATUS_END_OF_ROUND` with displayClock - `-`, not `0:00` (verified against recorded payloads; ledmatrix-plugins#580 - pins it). Whatever rule ufc gets must not read `-` as `0:00`. Decide ufc's - rule: no clock rule (ESPN's `STATUS_FINAL` is the only end signal it needs; - this also closes a ~1 s window at the horn when the ticking clock reads - `0:00`), or its own final period. +- **5, game-over check. Decided 2026-10-05, done:** one seam, + `FINAL_PERIOD`: hockey 3; basketball, football and lacrosse 4; `None` (the + clock never ends a game) for afl, nrl and soccer (clocks that count up), + baseball (its games carry no `period`, so the old rule was dormant) and + ufc (a bout ends only on ESPN's final status, which also closes the ~1 s + window at the horn when the ticking clock reads `0:00`; ESPN's round-break + displayClock `-` was never a zero clock, ledmatrix-plugins#580). Only a + non-empty clock string counts (the baseball/ufc copy read a missing clock + as `0:00`). A score level at 0:00 is not over: the game stays live through + the break before overtime, and one that really ends tied ends on its final + status. Baseball keeps its postponed/suspended override in `BaseballLive`. - **6, favourite matching.** NRL keeps matching favourites by team id (abbreviations collide: NEW, CAN), through `_favorite_key` rather than its own copies of the selection methods. Six plugins log the recent-games diff --git a/mypy-clean.txt b/mypy-clean.txt index 63f6f5bc..ffc7a6c5 100644 --- a/mypy-clean.txt +++ b/mypy-clean.txt @@ -38,6 +38,7 @@ src/common/sports_celebration.py src/common/sports_display_rules.py src/common/sports_fetch.py src/common/sports_font_path.py +src/common/sports_game_over.py src/common/sports_live_scroll.py src/common/sports_plugin_host.py src/common/sports_scroll.py diff --git a/src/common/README.md b/src/common/README.md index a0f46287..b84198c7 100644 --- a/src/common/README.md +++ b/src/common/README.md @@ -46,6 +46,7 @@ Rules for the package: | [`sports_display_rules`](#sports_display_rules) | Which games a scoreboard shows, for how long, and its scorebug date line | Yes (scoreboards) | 3.8.0 | | [`sports_fetch`](#sports_fetch) | Scoreboard season fetch, lookback and live-odds decisions | Yes (scoreboards) | 3.7.0 | | [`sports_font_path`](#sports_font_path) | Find a scoreboard's bundled font whatever the cwd | Yes (scoreboards) | 3.8.0 | +| [`sports_game_over`](#sports_game_over) | Whether a game ESPN still lists as live has ended | Yes (scoreboards) | next release | | [`sports_game_renderer`](#sports_game_renderer) | Scoreboard scroll/Vegas card geometry | Yes (scoreboards) | 3.3.0 | | [`sports_helpers`](#sports_helpers) | Small helpers every scoreboard `sports.py` copies | Yes (scoreboards) | 3.5.0 | | [`sports_live_scroll`](#sports_live_scroll) | Rebuild a live scroll strip mid-cycle without moving it | Yes (scoreboards) | 3.8.0 | @@ -294,6 +295,16 @@ path as given when it exists (relative to the cwd), else `font_layout.resolve_asset_path(path)`. What the scoreboards' `_resolve_font_path` copies return on a core that ships it. +### sports_game_over + +[`sports_game_over.py`](sports_game_over.py). `SportsGameOverMixin`: +`_is_game_really_over(game)`, the `SportsLive` check that drops a game ESPN +still lists as live (`SportsLiveSharedMixin._detect_stale_games` calls it). +Over on a final period text, or on a 0:00 clock from period `FINAL_PERIOD` +on unless the score is level. `FINAL_PERIOD` is a class attribute the host +sets per sport; the default `None` means the clock never ends a game. List +it before `SportsLiveSharedMixin`. + ### sports_game_renderer [`sports_game_renderer.py`](sports_game_renderer.py). diff --git a/src/common/sports_game_over.py b/src/common/sports_game_over.py new file mode 100644 index 00000000..3288af7e --- /dev/null +++ b/src/common/sports_game_over.py @@ -0,0 +1,125 @@ +"""Whether a game ESPN still lists as live has in fact ended (sports family 5). + +``SportsGameOverMixin._is_game_really_over`` is the scoreboards' +``SportsLive._is_game_really_over``, reconciled in ledmatrix-plugins +#625 from five bodies into one and copied here under +its existing name. ``SportsLiveSharedMixin._detect_stale_games`` +(``src.common.sports_shared``) calls it on every live game, and the plugins' +live-priority filters call it too, to drop a game ESPN still reports as +in progress. + +A game is over when its period text says final. From period ``FINAL_PERIOD`` +on, a clock reading 0:00 ends it too, unless the score is level: a tie at the +end of regulation goes to overtime (or a shootout), and a game that does end +tied says final. Only a clock *string* is read ("0:00" and ":00" are zero; +":40", "0.0" and ESPN's "-" between MMA rounds are not), and a missing or +unreadable score leaves the decision to the clock. + +``FINAL_PERIOD`` is the one per-sport fact, a class attribute rather than a +sport-name branch. The scoreboards declare it on their ``SportsLive``: + +- 3: hockey; +- 4: basketball, football, lacrosse; +- ``None`` (this default; the clock never ends a game): afl, nrl and soccer, + whose clocks count up; baseball, which has innings; ufc, whose bouts end + only on ESPN's final status. + +A sport can still override the method and defer to it, as baseball's +``BaseballLive`` does to end postponed and suspended games first. + +A new module rather than another method on ``sports_shared``, for the reason +``sports_helpers`` gives: a missing module fails at load, where the version +checks see it; a missing method fails mid-update. + +WHAT A HOST MUST PROVIDE +------------------------ +Derived by walking every ``self.`` the mixin reads; the host-contract +test in ``test/test_sports_game_over.py`` fails if a read is added without +being listed here. + +- ``logger`` -- a ``logging.Logger``; the method logs its verdict at DEBUG. +- ``FINAL_PERIOD`` -- defaulted here to ``None``; set it on the host class. + +The method reads the game dict's ``away_abbr``, ``home_abbr``, +``period_text``, ``period``, ``clock``, ``away_score`` and ``home_score`` +(``_extract_game_details_common``'s keys); any of them may be missing or +null. + +BASE ORDER +---------- +List the mixin before ``SportsLiveSharedMixin`` -- +``class SportsLive(SportsGameOverMixin, SportsLiveSharedMixin, SportsCore)`` -- +so the shared mixin's ``_detect_stale_games`` finds this method through the +MRO. Neither shared mixin defines it, so the order does not change which body +runs today; it keeps the method next to its caller should one ever be added +there. A method on the plugin's own class still wins, and its ``super()`` +reaches this one. The mixin has no ``__init__`` and no state. +""" + +import logging +from typing import Dict, Optional + + +class SportsGameOverMixin: + """The live manager's "is this game really over?" check. See module docstring.""" + + # The host contract, declared for type checking only. + logger: logging.Logger + + #: Period from which a 0:00 clock ends a game; None: the clock never does. + FINAL_PERIOD: Optional[int] = None + + def _is_game_really_over(self, game: Dict) -> bool: + """Whether a game ESPN still lists as live has in fact ended. + + It has when its period text says final. From period ``FINAL_PERIOD`` + on, a clock at 0:00 ends it too, unless the score is level: a tie at + the end of regulation goes to overtime, and a game that does end tied + says final. With ``FINAL_PERIOD = None`` the clock never ends a game. + """ + game_str = f"{game.get('away_abbr')}@{game.get('home_abbr')}" + + # ESPN can send the key as null, and .get()'s default only covers a + # missing key, so a None here crashed the whole live update. + raw_period_text = game.get("period_text") + period_text = raw_period_text.lower() if isinstance(raw_period_text, str) else "" + if "final" in period_text: + self.logger.debug( + f"_is_game_really_over({game_str}): " + f"returning True - 'final' in period_text='{period_text}'" + ) + return True + + # Same for a null or non-numeric period: treat it as period 0. + try: + period = int(game.get("period") or 0) + except (TypeError, ValueError, OverflowError): + period = 0 + # Only a clock string is read: "0:00" and ":00" are zero; ":40" is not. + clock = game.get("clock") + clock_at_zero = isinstance(clock, str) and clock.replace(":", "").strip() in ("000", "00") + + if self.FINAL_PERIOD is not None and period >= self.FINAL_PERIOD and clock_at_zero: + try: + tied = int(game["away_score"]) == int(game["home_score"]) + except (KeyError, TypeError, ValueError, OverflowError): + tied = False # a missing or unreadable score leaves it to the clock + if not tied: + self.logger.debug( + f"_is_game_really_over({game_str}): " + f"returning True - clock at 0:00 (clock='{clock}', period={period})" + ) + return True + self.logger.debug( + f"_is_game_really_over({game_str}): " + f"returning False - tied at 0:00 (period={period}), overtime next" + ) + return False + + self.logger.debug( + f"_is_game_really_over({game_str}): returning False" + ) + return False + + +__all__ = ["SportsGameOverMixin"] diff --git a/src/common/sports_shared.py b/src/common/sports_shared.py index 954a9b1f..f1efbbd7 100644 --- a/src/common/sports_shared.py +++ b/src/common/sports_shared.py @@ -57,7 +57,9 @@ Methods that stay per-plugin, because they are not identical across the eight ``_get_layout_offset``, ``_by_importance``, ``_other_games_window``, ``_upcoming_date_and_time_text``, ``_extract_game_details_common``, ``_load_division_team_ids``, ``_get_timezone``, ``_is_favorite_game``, -``_is_game_really_over``, ``_is_ranked_game``, ``_passes_other_filters``. +``_is_ranked_game``, ``_passes_other_filters``. (``_is_game_really_over``, +which ``_detect_stale_games`` below calls, was here too until the plugins +reconciled it; it is now ``src.common.sports_game_over``.) Of the fourteen shared class constants, thirteen are identical everywhere and live here. Only ``_SCORE_PROBE_TEXT`` varies -- afl and basketball reach three digits diff --git a/test/test_sports_game_over.py b/test/test_sports_game_over.py new file mode 100644 index 00000000..4e83e75f --- /dev/null +++ b/test/test_sports_game_over.py @@ -0,0 +1,275 @@ +"""src.common.sports_game_over: behaviour, host contract and base order. + +The matrix is ledmatrix-plugins' ``scripts/test_game_over_check.py`` (the +table the family 5 reconcile was checked against) folded to the three +``FINAL_PERIOD`` values the nine scoreboards declare: None (afl, baseball, +nrl, soccer, ufc), 4 (basketball, football, lacrosse) and 3 (hockey). +Baseball's postponed/suspended override stays in its plugin and is not here. +""" + +import ast +import logging +import time +from pathlib import Path + +import pytest + +from src.common import sports_game_over +from src.common.sports_game_over import SportsGameOverMixin +from src.common.sports_shared import SportsLiveSharedMixin + +LOG = logging.getLogger("test_sports_game_over") + + +def host(final_period): + """A live manager stand-in declaring ``FINAL_PERIOD`` as a plugin does.""" + cls = type("Live", (SportsGameOverMixin,), {"FINAL_PERIOD": final_period}) + h = cls() + h.logger = LOG + return h + + +MISSING = object() # the key is absent from the game dict + + +def game(period_text="", period=MISSING, clock=MISSING, away="1", home="2"): + g = {"away_abbr": "AWY", "home_abbr": "HOM", "away_score": away, + "home_score": home, "period_text": period_text} + if period is not MISSING: + g["period"] = period + if clock is not MISSING: + g["clock"] = clock + return g + + +# --------------------------------------------------------------------------- +# The matrix: clock x period, for each FINAL_PERIOD. Scores 1-2. +# --------------------------------------------------------------------------- + +FINAL_PERIODS = (None, 4, 3) +PERIODS = (MISSING, 1, 2, 3, 4, 5, 6) +CLOCKS = {"12:00": "12:00", "0:00": "0:00", ":00": ":00", "0.0": "0.0", + "-": "-", "''": "", "None": None, "missing": MISSING} + +#: The period text each ESPN status carries. Only "Final" contains "final"; +#: the method reads no status, so every other text answers the same row. +LIVE_TEXTS = { + "in progress": lambda p: "" if p is MISSING else f"P{p}", + "end of period": lambda p: "" if p is MISSING else f"End P{p}", + "halftime": lambda p: "Halftime", + "end of round": lambda p: "" if p is MISSING else f"End R{p}", + "postponed": lambda p: "Postponed", +} + +#: clock -> one cell per period (missing, 1..6) for FINAL_PERIOD None, 4, 3. +EXPECTED_LIVE = { + "12:00": "....... ....... .......", + "0:00": "....... ....YYY ...YYYY", + ":00": "....... ....YYY ...YYYY", + "0.0": "....... ....... .......", + "-": "....... ....... .......", + "''": "....... ....... .......", + "None": "....... ....... .......", + "missing": "....... ....... .......", +} + + +def row(text_for, clock): + return " ".join( + "".join("Y" if host(fp)._is_game_really_over(game(text_for(p), p, clock)) else "." + for p in PERIODS) + for fp in FINAL_PERIODS) + + +@pytest.mark.parametrize("status", sorted(LIVE_TEXTS)) +@pytest.mark.parametrize("clock_label", sorted(CLOCKS)) +def test_a_live_period_text(status, clock_label): + assert row(LIVE_TEXTS[status], CLOCKS[clock_label]) == EXPECTED_LIVE[clock_label] + + +@pytest.mark.parametrize("clock_label", sorted(CLOCKS)) +def test_a_final_period_text_is_always_over(clock_label): + assert row(lambda p: "Final", CLOCKS[clock_label]) == "YYYYYYY YYYYYYY YYYYYYY" + + +#: label -> (game, one cell per FINAL_PERIOD None, 4, 3) +EDGES = { + "period_text None, P4 0:00": (game(None, 4, "0:00"), ".YY"), + "period None, 0:00": (game("", None, "0:00"), "..."), + "period 'OT', 0:00": (game("OT", "OT", "0:00"), "..."), + "period '4' (str), 0:00": (game("P4", "4", "0:00"), ".YY"), + "clock int 0, P4": (game("P4", 4, 0), "..."), + "clock float 0.0, P4": (game("P4", 4, 0.0), "..."), + "clock ' 0:00 ', P4": (game("P4", 4, " 0:00 "), ".YY"), + "clock '00:00', P4": (game("P4", 4, "00:00"), "..."), + "period_text 'Final/OT', P5 0:00": (game("Final/OT", 5, "0:00"), "YYY"), + "period_text 'FINAL', P1 12:00": (game("FINAL", 1, "12:00"), "YYY"), +} + + +@pytest.mark.parametrize("label", sorted(EDGES)) +def test_edge_shapes(label): + g, want = EDGES[label] + got = "".join("Y" if host(fp)._is_game_really_over(dict(g)) else "." for fp in FINAL_PERIODS) + assert got == want + + +# --------------------------------------------------------------------------- +# The tie guard: level at 0:00 is overtime, not the end. +# --------------------------------------------------------------------------- + +class TestTieGuard: + @pytest.mark.parametrize("fp,period", [(4, 4), (4, 5), (3, 3), (3, 4), (3, 5)]) + def test_level_at_zero_is_not_over(self, fp, period): + assert host(fp)._is_game_really_over(game("", period, "0:00", "2", "2")) is False + + def test_level_scores_compare_as_numbers(self): + assert host(4)._is_game_really_over(game("", 4, "0:00", 2, "2")) is False + assert host(4)._is_game_really_over(game("", 4, "0:00", " 2 ", "2")) is False + + def test_a_game_that_ends_level_ends_on_final(self): + assert host(4)._is_game_really_over(game("Final/OT", 5, "0:00", "2", "2")) is True + + def test_level_before_the_final_period_was_never_over(self): + assert host(4)._is_game_really_over(game("", 3, "0:00", "2", "2")) is False + + @pytest.mark.parametrize("away,home", [ + (MISSING, MISSING), (None, None), ("", ""), ("2", None), + ("2.0", "2.0"), ({"value": 2}, {"value": 2}), ("inf", "inf"), + ]) + def test_an_unreadable_score_leaves_it_to_the_clock(self, away, home): + g = game("", 4, "0:00") + for key, value in (("away_score", away), ("home_score", home)): + if value is MISSING: + del g[key] + else: + g[key] = value + assert host(4)._is_game_really_over(g) is True + + def test_float_infinity_does_not_raise(self): + assert host(4)._is_game_really_over( + game("", 4, "0:00", float("inf"), float("inf"))) is True + + +# --------------------------------------------------------------------------- +# ufc: ESPN MMA payloads, as ufc's _extract_game_details stores them +# (ledmatrix-plugins plugins/ufc-scoreboard/test/fixtures/espn_mma_round_states.json). +# --------------------------------------------------------------------------- + +UFC_RECORDED = { + "in_round_3_of_3": ("R3", 3, "1:21"), + "break_after_round_1": ("R1", 1, "-"), + "end_of_round_after_stoppage": ("R2", 2, "0:51"), + "walkouts_five_rounder": ("", 0, "-"), + "final_five_round_decision": ("R5", 5, "5:00"), + "final_five_round_stoppage": ("R5", 5, "1:38"), + "final_three_round_decision": ("R3", 3, "5:00"), + "final_three_round_stoppage": ("R2", 2, "4:07"), + "break_after_round_4_of_5": ("R4", 4, "-"), + "end_of_round_5_awaiting_decision": ("R5", 5, "-"), +} + + +class TestUfc: + @pytest.mark.parametrize("name", sorted(UFC_RECORDED)) + def test_no_recorded_state_is_over_here(self, name): + """A finished bout leaves the live list on is_final, before this is asked.""" + text, period, clock = UFC_RECORDED[name] + assert host(None)._is_game_really_over(game(text, period, clock, "0", "0")) is False + + @pytest.mark.parametrize("fp", FINAL_PERIODS) + def test_a_round_break_dash_is_never_a_zero_clock(self, fp): + assert host(fp)._is_game_really_over(game("R4", 4, "-", "1", "2")) is False + + @pytest.mark.parametrize("clock", ["0:00", None, MISSING]) + def test_the_horn_does_not_end_a_bout(self, clock): + assert host(None)._is_game_really_over(game("R5", 5, clock, "1", "2")) is False + + +# --------------------------------------------------------------------------- +# Wiring: the default, overrides, and the live mixin's caller. +# --------------------------------------------------------------------------- + +def test_the_default_is_no_clock_rule(): + assert SportsGameOverMixin.FINAL_PERIOD is None + + +def test_an_override_defers_through_super(): + """baseball's BaseballLive: its own check first, then the shared one.""" + + class Baseballish(SportsGameOverMixin): + logger = LOG + + def _is_game_really_over(self, game): + if game.get("status") == "status_postponed": + return True + return super()._is_game_really_over(game) + + b = Baseballish() + assert b._is_game_really_over(dict(game("", 6, "0:00"), status="status_postponed")) is True + assert b._is_game_really_over(game("", 6, "0:00")) is False + assert b._is_game_really_over(game("Final", 9, None)) is True + + +class _Live(SportsGameOverMixin, SportsLiveSharedMixin): + """A SportsLive stand-in in the documented base order.""" + + FINAL_PERIOD = 4 + + def __init__(self): + self.logger = LOG + self.stale_game_timeout = 600 + self.game_update_timestamps = {} + + +class TestBaseOrder: + def test_the_documented_order_resolves_this_method(self): + assert _Live._is_game_really_over is SportsGameOverMixin._is_game_really_over + mro = _Live.__mro__ + assert mro.index(SportsGameOverMixin) < mro.index(SportsLiveSharedMixin) + + def test_neither_shared_mixin_defines_it(self): + """So the base order cannot change which body runs.""" + from src.common.sports_shared import SportsCoreSharedMixin + for mixin in (SportsLiveSharedMixin, SportsCoreSharedMixin): + assert "_is_game_really_over" not in vars(mixin) + + def test_detect_stale_games_drops_an_over_game_through_it(self): + live = _Live() + live.game_update_timestamps = {"over": {"last_seen": time.time()}, + "on": {"last_seen": time.time()}} + games = [dict(game("", 4, "0:00"), id="over"), + dict(game("", 4, "0:00", "2", "2"), id="on")] + live._detect_stale_games(games) + assert [g["id"] for g in games] == ["on"] + assert "over" not in live.game_update_timestamps + + def test_the_class_value_wins_over_the_default(self): + assert _Live().FINAL_PERIOD == 4 + assert _Live()._is_game_really_over(game("", 4, "0:00")) is True + + +# --------------------------------------------------------------------------- +# Host contract +# --------------------------------------------------------------------------- + +def _self_reads(): + tree = ast.parse(Path(sports_game_over.__file__).read_text(encoding="utf-8")) + cls = next(n for n in tree.body + if isinstance(n, ast.ClassDef) and n.name == "SportsGameOverMixin") + return {node.attr for node in ast.walk(cls) + if isinstance(node, ast.Attribute) and isinstance(node.ctx, ast.Load) + and isinstance(node.value, ast.Name) and node.value.id == "self"} + + +class TestHostContract: + def test_every_host_read_is_documented(self): + undocumented = sorted(n for n in _self_reads() + if f"``{n}``" not in sports_game_over.__doc__) + assert undocumented == [], f"read but not in the host contract: {undocumented}" + + def test_the_mixin_creates_no_state(self): + assert "__init__" not in vars(SportsGameOverMixin) + assert not hasattr(SportsGameOverMixin, "logger") + assert sorted(n for n in vars(SportsGameOverMixin) if not n.startswith("__")) == [ + "FINAL_PERIOD", "_is_game_really_over"] diff --git a/test/test_sports_game_over_parity.py b/test/test_sports_game_over_parity.py new file mode 100644 index 00000000..8f09aaee --- /dev/null +++ b/test/test_sports_game_over_parity.py @@ -0,0 +1,123 @@ +"""sports_game_over still matches every plugin copy, and each plugin's FINAL_PERIOD. + +``SportsGameOverMixin._is_game_really_over`` was copied from the scoreboards' +``SportsLive._is_game_really_over`` once family 5 had made the nine copies one +body. The plugins delete their copies once they floor on the release that +ships this module. Until each has, a copy that changes on its own is a fix one +side has and the other lacks. + +Point LEDMATRIX_PLUGINS at a ledmatrix-plugins checkout and the method is +compared with every plugin copy using ``scripts/sports_drift_report.py``'s own +normalisation (the AST with docstrings and annotations dropped), plus the +decorators. A copy that is gone counts as adopted when the plugin's +``sports.py`` names the module. Each plugin's ``SportsLive.FINAL_PERIOD`` is +compared with the value the owner decided for its sport, which stays in the +plugin after adoption. Without the variable this skips: core CI has no plugins +checkout. +""" + +import ast +import importlib.util +import os +from pathlib import Path + +import pytest + +from src.common import sports_game_over + +REPO = Path(__file__).resolve().parents[1] + +#: The owner's decision (docs/SPORTS_UNIFICATION.md, family 5): the period +#: from which a 0:00 clock ends a game, None where the clock never does. +FINAL_PERIOD = { + "afl": None, "baseball": None, "basketball": 4, "football": 4, + "hockey": 3, "lacrosse": 4, "nrl": None, "soccer": None, "ufc": None, +} +NAME = "_is_game_really_over" + + +def _drift_report(): + """scripts/sports_drift_report.py, loaded by path (scripts/ is no package).""" + spec = importlib.util.spec_from_file_location( + "sports_drift_report", REPO / "scripts" / "sports_drift_report.py") + module = importlib.util.module_from_spec(spec) + spec.loader.exec_module(module) + return module + + +DRIFT = _drift_report() + + +def _plugins_root(): + root = DRIFT.resolve_plugins_dir(os.environ.get("LEDMATRIX_PLUGINS")) + if root is None: + pytest.skip("set LEDMATRIX_PLUGINS to a ledmatrix-plugins checkout to " + "compare this module against the plugin copies") + return root + + +def _class(tree, name): + return next(n for n in tree.body if isinstance(n, ast.ClassDef) and n.name == name) + + +def _method(cls): + return next((n for n in cls.body + if isinstance(n, ast.FunctionDef) and n.name == NAME), None) + + +def _fingerprint(node): + return (DRIFT._digest(node, DRIFT._Canonical()), + tuple(ast.unparse(d) for d in node.decorator_list)) + + +def _final_period(cls): + for node in cls.body: + if (isinstance(node, (ast.Assign, ast.AnnAssign)) and node.value is not None): + target = node.targets[0] if isinstance(node, ast.Assign) else node.target + if isinstance(target, ast.Name) and target.id == "FINAL_PERIOD": + return ast.literal_eval(node.value) + raise AssertionError("SportsLive declares no FINAL_PERIOD") + + +def _ours(): + tree = ast.parse(Path(sports_game_over.__file__).read_text(encoding="utf-8")) + return _class(tree, "SportsGameOverMixin") + + +def test_the_mixin_holds_one_method_and_the_default(): + names = sorted(n.name if isinstance(n, ast.FunctionDef) else n.target.id + for n in _ours().body if isinstance(n, (ast.FunctionDef, ast.AnnAssign)) + and (isinstance(n, ast.FunctionDef) or n.value is not None)) + assert names == ["FINAL_PERIOD", NAME] + assert _final_period(_ours()) is None + + +@pytest.mark.parametrize("sport", sorted(FINAL_PERIOD)) +def test_every_remaining_plugin_copy_matches(sport): + root = _plugins_root() + source = (root / f"{sport}-scoreboard" / "sports.py").read_text(encoding="utf-8") + live = _class(ast.parse(source), "SportsLive") + copy = _method(live) + if copy is None: + assert sports_game_over.__name__ in source, ( + f"{sport}: no {NAME} on SportsLive and no {sports_game_over.__name__} import") + else: + assert _fingerprint(copy) == _fingerprint(_method(_ours())), ( + f"{NAME} in {sport} differs from sports_game_over. " + f"Port the change to both, or stop treating it as shared.") + + +@pytest.mark.parametrize("sport", sorted(FINAL_PERIOD)) +def test_every_plugin_declares_its_final_period(sport): + root = _plugins_root() + source = (root / f"{sport}-scoreboard" / "sports.py").read_text(encoding="utf-8") + assert _final_period(_class(ast.parse(source), "SportsLive")) == FINAL_PERIOD[sport] + + +def test_the_drift_report_still_calls_it_identical(): + root = _plugins_root() + families = DRIFT.build(root, ("sports.py",)) + rows = {(r["file"], r["family"]): r + for r in (DRIFT.summarise(k, v) for k, v in families.items())} + row = rows.get(("sports.py", NAME)) + assert row is None or row["worst_class_variants"] == 1 From 6fb2dc35951de94740c64c08a11cfeb2f2a08600 Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Mon, 5 Oct 2026 09:52:22 -0400 Subject: [PATCH 2/3] fix(sports): honour every pending kickoff in the idle back-off, not just the first (#772) _note_scheduled_start_candidate kept one kickoff. While it was inside its 15-minute grace every later kickoff was refused, and by the time the grace ended the later one had passed and was refused again as already past. So of two favourites kicking off within 15 minutes of each other, the second lost its own grace: if the first game was not live by then (a rain delay, a postponement, ESPN slow to flip it) and ESPN had not flipped the second either, the back-off went straight back to its ceiling and the second game was noticed up to that late. Later kickoffs now wait in a short queue (_later_scheduled_starts, the earliest 8). When the current kickoff's grace ends, the earliest queued one still inside its own grace takes over -- including one that has already passed. A kickoff still holds the live cadence for at most its own grace, so a postponed game costs the same quarter of an hour as before, and _next_scheduled_start_ts keeps its meaning for anything that reads or sets it. The promotion is a module function, so the mixin's method set is unchanged. Table tests replay the idle loop on a fake clock over kickoff schedules; mutation-checked (the old code fails 10 of the new tests). Co-authored-by: Claude Opus 5.5 --- CHANGELOG.md | 14 ++++ src/common/sports_shared.py | 58 ++++++++++++++-- test/test_sports_shared.py | 130 ++++++++++++++++++++++++++++++++++++ 3 files changed, 196 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a260dad..2534fd02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -194,6 +194,20 @@ Internal; no behaviour change. Stage 3 of `docs/RUN_LOOP_REDESIGN.md`. (`refresh_registry_in_background()`, backing off for a minute after an offline failure), so a later load has them. The store, install and update paths still fetch as before. +- A sports live manager's idle back-off now honours every pending kickoff, + not just the first. `_note_scheduled_start_candidate()` kept one kickoff + and, while it was inside its 15-minute grace, refused every later one; by + the time the grace ended the later one had passed and was refused again. + So of two favourites kicking off within 15 minutes of each other, the + second lost its own grace: if the first game was not live by then (a rain + delay, a postponement, ESPN slow to flip it) and ESPN had not flipped the + second either, the back-off went back to its ceiling and the second game + was noticed up to the ceiling (15 minutes by default) late. Later + kickoffs now wait in a short queue (`_later_scheduled_starts`, the + earliest 8) and each takes over with a grace of its own when the one + before it expires. A kickoff still + holds the live cadence for at most its own grace, so a postponed game + costs the same quarter of an hour as before. ### ESPN date-range fetches: fewer requests, fewer at once diff --git a/src/common/sports_shared.py b/src/common/sports_shared.py index f1efbbd7..e6d6403d 100644 --- a/src/common/sports_shared.py +++ b/src/common/sports_shared.py @@ -122,6 +122,32 @@ _DEFAULT_LIVE_IDLE_MAX_SECONDS = 900 _KICKOFF_GRACE_SECONDS = 900 #: Fallback cadence around a kickoff when the manager has no update_interval. _KICKOFF_POLL_FLOOR = 30 +#: How many kickoffs after the current one a live manager remembers. Only the +#: earliest few can matter before the next look refreshes the list, so this +#: bounds the memory without dropping a kickoff the board would wait for. +_KICKOFF_QUEUE_MAX = 8 + + +def _current_scheduled_start(host: Any, now: float) -> Optional[float]: + """The kickoff a live manager is honouring now, promoting the next queued one. + + ``_next_scheduled_start_ts`` is the kickoff being honoured: the earliest + one ahead of us, or one that has just passed and is inside its grace. + Kickoffs behind it wait in ``_later_scheduled_starts``. When the current + one's grace runs out, the earliest queued kickoff that is not itself past + its grace takes over -- including one that has already passed, so a + second kickoff inside the first one's grace still gets a grace of its own. + """ + current: Optional[float] = getattr(host, "_next_scheduled_start_ts", None) + if current and current > now - _KICKOFF_GRACE_SECONDS: + return current + queued: Optional[List[float]] = getattr(host, "_later_scheduled_starts", None) + if queued: + alive = sorted(s for s in queued if s > now - _KICKOFF_GRACE_SECONDS) + current = alive.pop(0) if alive else None + host._later_scheduled_starts = alive + host._next_scheduled_start_ts = current + return current if current and current > now - _KICKOFF_GRACE_SECONDS else None def _resolve_font_path(path: str) -> str: @@ -1296,11 +1322,11 @@ class SportsLiveSharedMixin: otherwise look like another empty check and escalate the back-off again, right when the game is actually starting. """ - start = getattr(self, "_next_scheduled_start_ts", None) + now = time.time() + start = _current_scheduled_start(self, now) if not start: return interval live = getattr(self, "update_interval", None) or _KICKOFF_POLL_FLOOR - now = time.time() if now < start: return max(live, min(interval, int(start - now))) if now - start <= _KICKOFF_GRACE_SECONDS: @@ -1315,6 +1341,16 @@ class SportsLiveSharedMixin: already has. Self-correcting: a stored start that has passed is replaced by the next one offered, so a postponed game cannot pin the cadence to a kickoff that never happens. + + Every pending kickoff is honoured, not just the first. A kickoff that + arrives while an earlier one is inside its grace is queued in + ``_later_scheduled_starts`` (the earliest _KICKOFF_QUEUE_MAX of them) + and takes over when that grace ends, with a grace of its own. Keeping + only the one kickoff dropped the second of two favourites starting + within the grace of each other: it was refused while the first held + the slot, and refused again once it had passed, so if ESPN had not + flipped it live by the end of the first grace the back-off went + straight back to its ceiling and the game was noticed up to that late. """ if not isinstance(details, dict): return @@ -1331,7 +1367,7 @@ class SportsLiveSharedMixin: now = time.time() if candidate <= now: return - current = getattr(self, "_next_scheduled_start_ts", None) + current = _current_scheduled_start(self, now) # A kickoff that has only just passed is *kept*, not replaced by the # next one on the card. Replacing it immediately is what made the grace # window in _clamp_to_scheduled_start dead code: the moment 13:00 came @@ -1341,10 +1377,20 @@ class SportsLiveSharedMixin: # polled at 13:00:45, found nothing live because ESPN had not flipped # the status yet, and then went quiet for the next quarter of an hour, # which is the behaviour this whole clamp exists to prevent. - if (current is None - or current <= now - _KICKOFF_GRACE_SECONDS - or candidate < current): + # + # Nor is it forgotten: whichever kickoff loses is queued behind the + # one honoured now, so it gets its own grace when that one's ends. + if current is None: self._next_scheduled_start_ts = candidate + return + if candidate == current: + return + if candidate < current: + self._next_scheduled_start_ts, candidate = candidate, current + queued = getattr(self, "_later_scheduled_starts", None) or [] + if candidate not in queued: + self._later_scheduled_starts = sorted( + [*queued, candidate])[:_KICKOFF_QUEUE_MAX] #: How long a game that finished live is still reported by #: finished_games_snapshot(): long enough for the recent-games list, which diff --git a/test/test_sports_shared.py b/test/test_sports_shared.py index 1cdd6fc2..b9ee0a28 100644 --- a/test/test_sports_shared.py +++ b/test/test_sports_shared.py @@ -465,6 +465,136 @@ class TestLiveMixin: # The safety property that makes it correct: 30s beats 600s. assert h._idle_live_interval() == h.update_interval + # ---- every pending kickoff is honoured, not just the first ------------ + # + # One stored kickoff held the slot through its grace and refused every + # later one; a later one that had passed by the time the grace ended was + # refused again as "already past". So of two favourites kicking off ten + # minutes apart, the second lost its grace: if ESPN had not flipped it live + # by the end of the FIRST game's grace, the back-off returned to its + # ceiling and the game was noticed up to that late. That bites whenever the + # first game is not live by then -- a rain delay, a postponement, ESPN slow + # to flip it -- since a live first game keeps the live cadence anyway. + + @staticmethod + def _replay(monkeypatch, kickoffs, flips, until, poll=30, ceiling=900): + """Drive a live manager's idle loop over a schedule on a fake clock. + + ``kickoffs`` are start offsets in seconds from t=0 (the first look), + ``flips`` how long after its start ESPN reports each game live (None: + postponed, never live). Every + look offers each not-yet-live game, as the live loop does, then sleeps + for whatever the back-off returns. Returns, per game, how long after it + went live it was first seen live -- None if never. + """ + clock = [1_800_000_000.0] + monkeypatch.setattr(sports_shared.time, "time", lambda: clock[0]) + h = _LiveHost(no_data_interval=300) + h.live_idle_max_interval = ceiling + h.update_interval = poll + h._empty_live_streak = 30 # idle all morning: at the ceiling + t0 = clock[0] + seen = [None] * len(kickoffs) + while clock[0] - t0 < until: + now = clock[0] - t0 + live = [f is not None and k + f <= now for k, f in zip(kickoffs, flips)] + for i, is_live in enumerate(live): + if is_live and seen[i] is None: + seen[i] = now - (kickoffs[i] + flips[i]) + start = datetime.fromtimestamp(t0 + kickoffs[i], tz=timezone.utc) + h._note_scheduled_start_candidate( + {"is_live": is_live, "is_halftime": False, + "start_time_utc": start}) + # A real board keeps polling at the live cadence while anything is + # live; a game here stays live for an hour after it flips. + on = any(f is not None and k + f <= now < k + f + 3600 + for k, f in zip(kickoffs, flips)) + h._note_live_fetch(on) + clock[0] += poll if on else h._idle_live_interval() + assert len(getattr(h, "_later_scheduled_starts", None) or ()) <= sports_shared._KICKOFF_QUEUE_MAX + return seen + + @pytest.mark.parametrize("kickoffs,flips", [ + # (start offsets, ESPN's flip delay per game), both in seconds. + pytest.param([1800], [120], id="one kickoff, flipped 2 min late"), + pytest.param([1800, 2400], [0, 840], + id="first live on time, the second flipped 14 min late"), + pytest.param([1800, 2400], [None, 840], + id="first postponed, the second 10 min later flipped 14 min late"), + pytest.param([1800, 2400], [1200, 840], + id="first in a 20 min delay, the second flipped 14 min late"), + pytest.param([1800, 2100, 2520], [None, None, 600], + id="three inside one grace, the last flipped 10 min late"), + pytest.param([1800, 1800, 2400], [None, None, 700], + id="two at the same time, then one 10 min later"), + pytest.param([1800, 2700], [None, 840], + id="second kickoff 15 min later, flipped 14 min late"), + pytest.param([1800 + 60 * i for i in range(20)], + [None] * 19 + [840], + id="twenty kickoffs a minute apart overflow the queue"), + ]) + def test_every_pending_kickoff_gets_its_grace(self, monkeypatch, kickoffs, flips): + seen = self._replay(monkeypatch, kickoffs, flips, + until=max(kickoffs) + 3 * 3600) + late = [s for s, f in zip(seen, flips) + if f is not None and (s is None or s > 30)] + assert not late, "games noticed late (s after going live): %r" % (seen,) + + def test_a_kickoff_that_never_flips_costs_one_grace_then_backs_off(self, monkeypatch): + # A postponed game keeps the live cadence for its grace and no longer: + # remembering more kickoffs must not pin the poll to dead ones. + clock = [1_800_000_000.0] + monkeypatch.setattr(sports_shared.time, "time", lambda: clock[0]) + h = self._idle_host() + t0 = clock[0] + for offset in (600, 900): + h._note_scheduled_start_candidate( + {"start_time_utc": datetime.fromtimestamp(t0 + offset, tz=timezone.utc)}) + clock[0] = t0 + 900 + sports_shared._KICKOFF_GRACE_SECONDS - 1 + assert h._idle_live_interval() == h.update_interval + clock[0] = t0 + 900 + sports_shared._KICKOFF_GRACE_SECONDS + 1 + assert h._idle_live_interval() == 900 + assert not getattr(h, "_later_scheduled_starts", None) + + def test_a_queued_kickoff_past_its_own_grace_is_skipped(self, monkeypatch): + # After a long sleep (or a run of looks that never woke the manager) + # several queued kickoffs may have gone stale at once. The one still + # inside its grace must win, not the first stale one in the queue. + clock = [1_800_000_000.0] + monkeypatch.setattr(sports_shared.time, "time", lambda: clock[0]) + h = self._idle_host() + t0 = clock[0] + for offset in (600, 700, 1500): + h._note_scheduled_start_candidate( + {"start_time_utc": datetime.fromtimestamp(t0 + offset, tz=timezone.utc)}) + clock[0] = t0 + 1500 + 150 # 600 and 700 are past their grace + assert h._idle_live_interval() == h.update_interval + assert h._next_scheduled_start_ts == t0 + 1500 + + def test_the_queue_keeps_the_earliest_kickoffs(self, monkeypatch): + clock = [1_800_000_000.0] + monkeypatch.setattr(sports_shared.time, "time", lambda: clock[0]) + h = self._idle_host() + t0 = clock[0] + cap = sports_shared._KICKOFF_QUEUE_MAX + for offset in reversed(range(1, cap + 6)): # latest first + h._note_scheduled_start_candidate( + {"start_time_utc": datetime.fromtimestamp(t0 + 600 * offset, tz=timezone.utc)}) + assert h._next_scheduled_start_ts == t0 + 600 + assert h._later_scheduled_starts == [t0 + 600 * i for i in range(2, cap + 2)] + + def test_a_kickoff_offered_twice_is_kept_once(self, monkeypatch): + clock = [1_800_000_000.0] + monkeypatch.setattr(sports_shared.time, "time", lambda: clock[0]) + h = self._idle_host() + t0 = clock[0] + for _ in range(3): + for offset in (600, 1200): + h._note_scheduled_start_candidate( + {"start_time_utc": datetime.fromtimestamp(t0 + offset, tz=timezone.utc)}) + assert h._next_scheduled_start_ts == t0 + 600 + assert h._later_scheduled_starts == [t0 + 1200] + def test_finding_a_live_game_resets_the_streak(self): h = _LiveHost() h._note_live_fetch(False) From c20c0beac283fd3ebc7bc98edba348c8971a752d Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Mon, 5 Oct 2026 09:53:43 -0400 Subject: [PATCH 3/3] feat(web): the Display tab is an ES-module page, with a page-visibility service (stage 4) (#771) * feat(web): the Display tab is an ES-module page, with a page-visibility service (stage 4) - core/visibility.js: each page gets ctx.visibility (whileVisible, every, isVisible). Work registered there runs only while the page's tab is active and the browser tab visible, and ends when the page is swapped out. It reads the active tab from window.LEDVisibility, so it agrees with the classic partials. The registry gained a mountContext option for per-mount services. - pages/display.js replaces display.html's two inline scripts. The 5 s sync status poll runs through ctx.visibility.every; the status and scroll-speed hint requests go through ctx.api with ctx.signal, as does the Vegas order widget's plugin-list request. The Advanced toggle is a delegated data-action; window.updateSyncUI is a deprecated alias. - New DOM suites test_visibility_service.js and test_display_page.js; test_display_partial_ids.js imports the module. Co-Authored-By: Claude Opus 5.5 * refactor(web): no computed keys in the Display page's readout and destroy Codacy's object-injection rule flagged v[id] and ctx.state[name]. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- CHANGELOG.md | 28 ++ docs/WEB_FRONTEND_ARCHITECTURE.md | 42 ++- test/js/README.md | 4 +- test/js/dom/test_display_page.js | 325 ++++++++++++++++++ test/js/dom/test_visibility_service.js | 211 ++++++++++++ test/js/run_all.js | 3 +- test/js/unit/test_display_partial_ids.js | 144 ++++---- test/js/unit/test_html_escaping.js | 9 +- test/js/unit/test_page_registry.js | 40 +++ test/web_interface/test_es_modules.py | 5 +- web_interface/static/v3/js/core/boot.js | 6 + web_interface/static/v3/js/core/registry.js | 15 +- web_interface/static/v3/js/core/visibility.js | 144 ++++++++ web_interface/static/v3/js/pages/display.js | 324 +++++++++++++++++ .../templates/v3/partials/display.html | 301 +--------------- 15 files changed, 1223 insertions(+), 378 deletions(-) create mode 100644 test/js/dom/test_display_page.js create mode 100644 test/js/dom/test_visibility_service.js create mode 100644 web_interface/static/v3/js/core/visibility.js create mode 100644 web_interface/static/v3/js/pages/display.js diff --git a/CHANGELOG.md b/CHANGELOG.md index 2534fd02..f0ba87e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,34 @@ accepts both, but the store flags the old spelling as deprecated ## Unreleased +### Web UI: the Display tab is an ES-module page, with a page-visibility service (stage 4) + +- New `static/v3/js/core/visibility.js`: each page module gets + `ctx.visibility` with `whileVisible(start, stop)`, `every(ms, fn)` and + `isVisible()`. Work registered there runs only while the page's tab is the + active tab and the browser tab is visible, and ends when the page is + swapped out, with no teardown code in the page. It reads the active tab + from `window.LEDVisibility`, so it agrees with the classic partials that + still use that directly. The page registry gained a `mountContext` option + for services bound to one mounted page. +- The Display tab's inline scripts are now `static/v3/js/pages/display.js`. + The partial has no inline script, `onclick` or `onchange` any more. The + multi-display sync status poll (every 5 s) runs through + `ctx.visibility.every`; the status and scroll-speed hint requests go + through `core/api.js` with the page's abort signal, and so does the Vegas + order widget's plugin-list request. +- Behaviour differences: with sync on, opening the tab asks for the status + once instead of twice, and a Display tab loaded while not on screen waits + until it is. A login redirect during a poll no longer flashes "Sync status + unavailable". The `window.syncStatusInterval` timer id is gone (nothing + read it). A pending scroll-hint request or widget retry is dropped when + the partial is swapped out. +- `window.updateSyncUI` keeps working as a deprecated alias through + `window.LEDMatrix` (one console warning). +- New suites `test/js/dom/test_visibility_service.js` and + `dom/test_display_page.js`; `unit/test_display_partial_ids.js` imports the + module instead of slicing the template. + ### Plugins ask for the screen in-process: `request_on_demand()` / `end_on_demand()` The in-process way in that stage 5 of the control socket needed diff --git a/docs/WEB_FRONTEND_ARCHITECTURE.md b/docs/WEB_FRONTEND_ARCHITECTURE.md index b7ae12ba..962107da 100644 --- a/docs/WEB_FRONTEND_ARCHITECTURE.md +++ b/docs/WEB_FRONTEND_ARCHITECTURE.md @@ -42,7 +42,8 @@ static/v3/js/ registry.js page lifecycle: init/destroy on htmx swaps api.js fetch wrapper for /api/v3 (JSON envelope, login redirect) facade.js window.LEDMatrix and deprecated aliases - (later) escape.js, notify.js, dialog.js, streams.js, visibility.js, + visibility.js ctx.visibility: a page's timers run only while it is on screen + (later) escape.js, notify.js, dialog.js, streams.js, store.js (the one installed-plugin store), form/renderer.js pages/ one module per tab partial cache.js export init(root, ctx), destroy(root, ctx) @@ -81,6 +82,12 @@ The conventions the converted pages share: to the module's export of the same name and warns once. - **Timers are cleared in `destroy()`**, the one thing `ctx.signal` cannot undo by itself. +- **Polling goes through `ctx.visibility`.** A refresh that repeats + (`ctx.visibility.every(ms, fn)`) or work that should run only while the + page is on screen (`ctx.visibility.whileVisible(start, stop)`) is + registered there, never with a bare `setInterval`. It runs only while the + page's tab is the active tab and the browser tab is visible, and it ends + when the page is destroyed, with no code in `destroy()`. - **A page reports its own htmx saves.** A form whose result a page module shows (an `htmx:afterRequest` listener on the page root, in place of an `hx-on` attribute naming a global) carries `data-reports-result`. `app.js` @@ -111,6 +118,7 @@ Each mount gets a `ctx` object: | `ctx.state` | A per-mount object for the page's own state | | `ctx.api` | Shared service from `boot.js` | | `ctx.notify` | Shared service from `boot.js` | +| `ctx.visibility` | This page's handle on `core/visibility.js` (below), made per mount by `boot.js` through the registry's `mountContext` option | A page that passes `{ signal: ctx.signal }` to `addEventListener` and `fetch` needs no teardown code. Its listeners and in-flight requests go @@ -119,6 +127,30 @@ example: its delete buttons use one delegated listener, rows are built with `textContent` rather than markup strings, and a newer load supersedes an older one. +### Page visibility + +`core/visibility.js` gives each mounted page `ctx.visibility`: + +| Member | What it does | +|---|---| +| `whileVisible(start, stop)` | Runs `start()` when the page comes on screen (at once, if it mounts on screen) and `stop()` when it leaves. Returns a function that ends the registration, running `stop()` first if needed | +| `every(ms, fn)` | `fn()` at once, then every `ms` while on screen. The interval is cleared while hidden and restarted, with an immediate `fn()`, when the page is back. Returns the same kind of end function | +| `isVisible()` | True while the page is on screen | +| `tab` | The tab the page belongs to: its name, or `forPage(ctx, { tab })` | + +"On screen" means the page's tab is the active tab and the browser tab is +visible. Everything a page registered ends when its `ctx.signal` aborts, +after `destroy()`, so a swapped-out partial leaves no interval behind. + +The answer comes from `window.LEDVisibility` (`app-shell.js`), read at call +time, so the page modules and the classic partials that still call it +(Overview, Logs, Tools) agree on the active tab, and the SSE streams keep +pausing with them. Each registration takes its own `LEDVisibility` key, so +registrations never replace each other or a classic partial's. Without +`LEDVisibility` (a page outside `base.html`), the browser tab's visibility +alone decides. Moving the tracker itself into the module (the shell table +below) changes only `core/visibility.js`. + ### One facade `window.LEDMatrix` is the only global the module code adds: @@ -249,7 +281,7 @@ are the inline script in each partial today. | 5 | Backup & Restore | 232 lines, now 0 | **Done in stage 2.** Its 5 globals (`exportBackup`, `loadBackupList`, `validateRestoreFile`, `clearRestore`, `runRestore`) are deprecated aliases; the buttons are delegated `data-action`s. Uploads go through `ctx.api.request(..., { body: formData })` (`api.js` gained a raw `body` option) | | 6 | Schedule | 193 lines, now 0 | **Done in stage 3.** Its 2 `hx-on` response handlers (`handleScheduleResponse`, `handleDimScheduleResponse`) are one `htmx:afterRequest` listener on the page root, and deprecated aliases. The forms are marked `data-reports-result` so `app.js` does not repeat the server's message. The saved schedules reach the module as JSON in `data-schedule-config` / `data-dim-schedule-config` instead of being templated into the script | | 7 | General | 153 lines, now 0 | **Done in stage 3.** The Security section's three forms and two buttons are delegated `data-action`s (one submit and one click listener); `window.webLogin` is a deprecated alias of an object with its five methods. Login requests go through `ctx.api`, so the login redirect is quiet. The settings form keeps its `hx-on` call to the shared `showSaveResult`, as Rotation's does | -| 8 | Display | 231 | First page with `LEDVisibility` timers: those move to a `ctx.visibility` service that stops on destroy | +| 8 | Display | 292 lines (2 scripts), now 0 | **Done in stage 4.** The first page with a timer: the 5 s multi-display sync poll is `ctx.visibility.every(5000, ...)` (above), so it runs only while the tab is on screen and stops when the partial is swapped out. Its one global, `updateSyncUI` (the Role menu's `onchange`), is a deprecated alias; the Advanced section's `onclick` is a delegated `data-action="toggle-section"` that calls the shared `toggleSection`. The status poll and the scroll-speed hint go through `ctx.api` with `ctx.signal`, as does the Vegas order widget's plugin-list request. The settings form keeps its `hx-on` call to `showSaveResult` and its `onsubmit` call to `fixInvalidNumberInputs`, as Rotation's does | | 9 | Overview | 410 (4 scripts) | First-run surface: Getting Started, update banner, live preview. Five globals | | 10 | WiFi | 364 | `x-data="wifiSetup()"` is defined by its own script. Moves to `Alpine.data()` registered from the module. AP-mode first screen, so it needs the AP-mode test on a real device | | 11 | Fonts | 681 | Large, but self-contained (6 globals) | @@ -266,7 +298,7 @@ the order: | `showNotification` | 4 versions | `core/notify.js` | | The modal helper | `utils/dialog.js` | `core/dialog.js` | | SSE streams | `app-shell.js` | `core/streams.js` | -| `LEDVisibility` | `app-shell.js` | `core/visibility.js` | +| `LEDVisibility` | `app-shell.js` | `core/visibility.js` (the page-facing `ctx.visibility` is there since step 8; it reads the tracker from `app-shell.js`) | Each move leaves the old global as an alias. When the last inline script is gone, the script re-execution in `htmx-config.js` and the "HTMX never @@ -286,13 +318,15 @@ Unit suites need only node. They import the shipped modules directly: | Suite | Kind | What it covers | |---|---|---| -| `unit/test_page_registry.js` | Unit, minimal DOM shim | The lifecycle: one init per root, destroy on swap, a veto keeps the page, swaps elsewhere leave it alone, the sweep, lazy loading, a destroy while loading, error containment | +| `unit/test_page_registry.js` | Unit, minimal DOM shim | The lifecycle: one init per root, destroy on swap, a veto keeps the page, swaps elsewhere leave it alone, the sweep, lazy loading, a destroy while loading, error containment, `mountContext` fields per mount | +| `dom/test_visibility_service.js` | DOM: real `LEDVisibility` from `app-shell.js`, real registry, no server | `whileVisible` and `every` start and stop with the active tab and the browser tab's visibility; no interval runs while hidden or after a swap-out; one interval after five swaps; registrations never replace each other or a classic partial's; a destroyed page registers nothing; a throwing `start()` is contained; the no-`LEDVisibility` fallback | | `unit/test_core_modules.js` | Unit | `api.js` (envelope, errors, abort, login redirect, path check) and `facade.js` (facade, aliases) | | `dom/test_cache_page.js` | DOM: real partial, real API shape | No inline script; one request per swap and per Refresh after five swaps; a cancelled request draws nothing; hostile keys stay text; delete, empty, error, network and login states | | `dom/test_durations_page.js` | DOM: real partial, real widget, real API shape | One plugin-list request per swap; Move down moves one place after five swaps; the swap cancels a request in flight; a late-loading widget is waited for, and a page swapped away while waiting starts nothing; hostile names stay text | | `dom/test_operation_history_page.js` | DOM: real partial, real API shape | One history request per swap and per Refresh; the plugin filter filled once (from `PluginAPI`'s cache when loaded); paging, filters, debounced search, Clear (one DELETE), error/network/login states, cancel on swap; hostile ids, users and errors stay text | | `dom/test_raw_json_page.js` | DOM: real partial, real config | One POST per Save after five swaps, to the right file; Format and Validate act once; invalid JSON never sent and its message stays text; a save survives a swap and is still reported; the old globals' entry points | | `dom/test_schedule_page.js` | DOM: real partial, real widget | Both pickers drawn once per swap from the saved config; after five swaps each form's answer is one notification (message, fallback, refused, non-JSON, `null`), a request from outside the forms none; the brightness label; a late widget waited for, a page swapped away while waiting draws nothing; the old globals' entry points | +| `dom/test_display_page.js` | DOM: real partial, real widget, real `LEDVisibility`, real API shape | After five swaps one page, one sync interval, the Vegas order drawn once and each control acting once (brightness, resolution, the two show/hide toggles, the Advanced toggle, one debounced hint request); the sync poll only while on screen and never after a swap-out; sync states and hostile peer names as text, failure and login answers; a late widget waited for; `updateSyncUI`'s entry point | | `dom/test_general_page.js` | DOM: real partial, real widget, real API shape | The timezone picker drawn once per swap with the saved zone; the settings form left to htmx; after five swaps each Security action makes one request (create, copy, revoke and its cancel, password and its mismatch); hostile token names stay text; refused, network and login answers; a create made before a swap is still reported and draws nothing; `webLogin`'s entry points | | `dom/test_backup_restore_page.js` | DOM: real partial, real API shape | One request per Refresh, Delete, Export (busy button ignores a second click), Inspect and Restore after five swaps; the upload's fields and the six restore options; reads cancelled by a swap, writes not; hostile file and host names stay text; the old globals' entry points | | `test/web_interface/test_es_modules.py` | pytest | MIME type; `no-cache` without `?v` and immutable with it; `boot.js` loads last; every import resolves inside `core/` and `pages/`; the converted pages are exactly the registered ones, each with its module, `init`, and one root in the rendered partial; a converted partial has no ` @@ -830,7 +795,7 @@ With this off a live game takes over the whole display with the full-screen scor
- @@ -879,261 +844,3 @@ With this off a live game takes over the whole display with the full-screen scor
- -