bambuddy/backend/tests/unit/test_status_broadcast_ams_slot_config.py

"""Configuring an AMS slot must reach the printer card without a page reload.

`on_printer_status_change` deduplicates WebSocket broadcasts against a
`status_key`. Its AMS component used to carry only id / tray_type / state, so
re-configuring a slot to a different brand or colour of the SAME material
produced an identical key: the printer's pushall arrived with the new values,
the handler compared, found no change, and returned without broadcasting. The
card then showed the old filament until the 30s fallback poll or an F5.

Reset never had the bug — it clears tray_type, which was always in the key.
That asymmetry is what these tests pin: every field Configure Slot writes has
to move the key, and the fields that churn every second still must not.
"""

from types import SimpleNamespace
from unittest.mock import AsyncMock, MagicMock, patch

import pytest

from backend.app import main as main_module


def _spawn_patch():
    """Close the reconcile coroutine the handler builds as a call argument.

    Same reason as test_printer_offline_notification.py: a bare MagicMock keeps
    it alive in call_args and it finalises unawaited during a later test's GC.
    """
    return patch(
        "backend.app.main.spawn_background_task",
        side_effect=lambda coro, **kwargs: coro.close(),
    )


def _tray(**overrides) -> dict:
    """One AMS tray as the firmware reports it, mid-way through a print job.

    Defaults describe a configured slot: Bambu PLA Basic in black, bound to
    calibration slot 3.
    """
    tray = {
        "id": "0",
        "tray_type": "PLA",
        "state": 10,
        "tray_color": "000000FF",
        "tray_info_idx": "GFA00",
        "tray_sub_brands": "PLA Basic",
        "cali_idx": 3,
        "remain": 42,
    }
    tray.update(overrides)
    return tray


def _state(trays: list[dict], ams_extra: dict | None = None) -> SimpleNamespace:
    """Minimal PrinterState stub carrying one AMS unit.

    Idle and unheated, so the handler runs straight from the dedup check to the
    broadcast without touching progress milestones, HMS notifications or the DB.

    ``ams_extra`` sets unit-level (not per-tray) fields such as the drying pair
    ``dry_time`` / ``dry_countdown_stalled``.
    """
    ams_unit = {"id": "0", "dry_time": 0, "tray": trays}
    ams_unit.update(ams_extra or {})
    return SimpleNamespace(
        connected=True,
        state="IDLE",
        progress=0,
        layer_num=0,
        temperatures={},
        nozzles=[],
        raw_data={"ams": [ams_unit]},
        stg_cur=0,
        # Real PrinterState always carries these; the status-broadcast dedup
        # key reads them so a Filament Track Switch rebind reaches the card.
        fila_switch=None,
        ams_switch_inlet={},
        extruder_slots={},
        cooling_fan_speed=0,
        big_fan1_speed=0,
        big_fan2_speed=0,
        chamber_light="",
        active_extruder=0,
        tray_now=0,
        door_open=False,
        subtask_name="",
        gcode_file="",
        remaining_time=None,
        hms_errors=[],
        ams_filament_backup=None,
        firmware_version=None,
        developer_mode=None,
        print_ams_mapping=None,
        airduct_mode=0,
    )


@pytest.fixture(autouse=True)
def _reset_edge_state():
    main_module._last_status_broadcast.clear()
    main_module._printer_last_connected.clear()
    main_module._printer_reconciled_since_connect.clear()
    yield
    main_module._last_status_broadcast.clear()
    main_module._printer_last_connected.clear()
    main_module._printer_reconciled_since_connect.clear()


async def _push(ws_mgr, trays: list[dict], ams_extra: dict | None = None) -> None:
    """Deliver one status push to the handler."""
    relay = MagicMock()
    relay.on_printer_status = AsyncMock()
    pm = MagicMock()
    pm.get_printer.return_value = None  # Skip the relay payload branch.
    pm.get_model.return_value = ""

    with (
        patch("backend.app.main.ws_manager", ws_mgr),
        patch("backend.app.main.mqtt_relay", relay),
        patch("backend.app.main.printer_manager", pm),
        _spawn_patch(),
        patch("backend.app.main.printer_state_to_dict", return_value={}),
    ):
        await main_module.on_printer_status_change(1, _state(trays, ams_extra))


@pytest.fixture
def ws_mgr():
    mgr = MagicMock()
    mgr.send_printer_status = AsyncMock()
    return mgr


class TestConfigureSlotBroadcasts:
    """Each field Configure Slot writes must break the dedup on its own —
    the user may change only the colour, or only the K-profile."""

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "field,new_value",
        [
            ("tray_color", "FF0000FF"),
            ("tray_info_idx", "GFA01"),
            ("tray_sub_brands", "PLA Matte"),
            ("cali_idx", 7),
        ],
    )
    async def test_a_changed_filament_field_broadcasts(self, ws_mgr, field, new_value):
        await _push(ws_mgr, [_tray()])
        assert ws_mgr.send_printer_status.await_count == 1

        await _push(ws_mgr, [_tray(**{field: new_value})])

        assert ws_mgr.send_printer_status.await_count == 2, (
            f"changing {field} did not reach the frontend — the card would keep "
            "showing the old filament until the fallback poll"
        )

    @pytest.mark.asyncio
    async def test_the_realistic_reconfigure_broadcasts(self, ws_mgr):
        """Black Bambu PLA Basic → red eSUN PLA+ with its own K-profile.

        The whole point of the report: same material, so every field the old key
        looked at is unchanged.
        """
        await _push(ws_mgr, [_tray()])

        await _push(
            ws_mgr,
            [
                _tray(
                    tray_color="C1121FFF",
                    tray_info_idx="GFL99",
                    tray_sub_brands="eSUN PLA+",
                    cali_idx=5,
                )
            ],
        )

        assert ws_mgr.send_printer_status.await_count == 2

    @pytest.mark.asyncio
    async def test_a_second_slot_is_watched_too(self, ws_mgr):
        """The key spans every tray, so configuring slot 2 must broadcast even
        though slot 1 is untouched."""
        trays = [_tray(id="0"), _tray(id="1", tray_type="PETG", tray_info_idx="GFG00")]
        await _push(ws_mgr, trays)

        changed = [_tray(id="0"), _tray(id="1", tray_type="PETG", tray_info_idx="GFG01")]
        await _push(ws_mgr, changed)

        assert ws_mgr.send_printer_status.await_count == 2


class TestDedupStillHolds:
    """The dedup exists to keep a printing machine from flooding the socket.
    Widening the key must not have cost that."""

    @pytest.mark.asyncio
    async def test_an_identical_push_is_still_suppressed(self, ws_mgr):
        await _push(ws_mgr, [_tray()])
        await _push(ws_mgr, [_tray()])

        assert ws_mgr.send_printer_status.await_count == 1

    @pytest.mark.asyncio
    async def test_remaining_filament_does_not_broadcast(self, ws_mgr):
        """`remain` ticks down throughout a print and is deliberately absent
        from the key. It sits in the same tray dict as the fields we added, so
        this pins that we widened the key rather than hashing the whole tray."""
        await _push(ws_mgr, [_tray(remain=42)])
        await _push(ws_mgr, [_tray(remain=41)])

        assert ws_mgr.send_printer_status.await_count == 1


class TestExistingBehaviourUnchanged:
    """The cases that already worked, kept working."""

    @pytest.mark.asyncio
    async def test_a_load_unload_transition_still_broadcasts(self, ws_mgr):
        """#784 — tray state 11→10."""
        await _push(ws_mgr, [_tray(state=11)])
        await _push(ws_mgr, [_tray(state=10)])

        assert ws_mgr.send_printer_status.await_count == 2

    @pytest.mark.asyncio
    async def test_resetting_a_slot_still_broadcasts(self, ws_mgr):
        """Reset clears the filament identity outright."""
        await _push(ws_mgr, [_tray()])
        await _push(
            ws_mgr,
            [_tray(tray_type="", tray_color="", tray_info_idx="", tray_sub_brands="", cali_idx=-1)],
        )

        assert ws_mgr.send_printer_status.await_count == 2

    @pytest.mark.asyncio
    async def test_a_printer_with_no_ams_still_broadcasts_once(self, ws_mgr):
        """The `else ()` branch — an AMS-less printer must not crash or
        double-broadcast."""
        relay = MagicMock()
        relay.on_printer_status = AsyncMock()
        pm = MagicMock()
        pm.get_printer.return_value = None
        pm.get_model.return_value = ""
        state = _state([])
        state.raw_data = {}

        for _ in range(2):
            with (
                patch("backend.app.main.ws_manager", ws_mgr),
                patch("backend.app.main.mqtt_relay", relay),
                patch("backend.app.main.printer_manager", pm),
                _spawn_patch(),
                patch("backend.app.main.printer_state_to_dict", return_value={}),
            ):
                await main_module.on_printer_status_change(1, state)

        assert ws_mgr.send_printer_status.await_count == 1


class TestFilamentTrackSwitchBroadcasts:
    """Moving an AMS to the other switch inlet has to reach the printer card.

    The inlet binding lives in AMS ``info`` bits, so it is in neither the tray
    component of this key nor the AMS change-hash (which covers tray fields only
    — widening that would fire spurious Spoolman syncs). Without its own term
    here, "Join IN-B" on the printer's Manual AMS Setup screen moved no key at
    all and the card's inlet badges stayed stale until a page reload.
    """

    @staticmethod
    def _fts_state(inlets: dict[str, str], installed: bool = True):
        from backend.app.services.bambu_mqtt import FilaSwitchState

        state = _state([_tray()])
        state.fila_switch = FilaSwitchState(installed=installed)
        state.ams_switch_inlet = inlets
        return state

    async def _push_state(self, ws_mgr, state) -> None:
        relay = MagicMock()
        relay.on_printer_status = AsyncMock()
        pm = MagicMock()
        pm.get_printer.return_value = None
        pm.get_model.return_value = ""
        with (
            patch("backend.app.main.ws_manager", ws_mgr),
            patch("backend.app.main.mqtt_relay", relay),
            patch("backend.app.main.printer_manager", pm),
            _spawn_patch(),
            patch("backend.app.main.printer_state_to_dict", return_value={}),
        ):
            await main_module.on_printer_status_change(1, state)

    @pytest.mark.asyncio
    async def test_a_rebind_broadcasts(self, ws_mgr):
        await self._push_state(ws_mgr, self._fts_state({"0": "A", "1": "B"}))
        assert ws_mgr.send_printer_status.await_count == 1

        await self._push_state(ws_mgr, self._fts_state({"0": "B", "1": "B"}))

        assert ws_mgr.send_printer_status.await_count == 2, (
            "moving an AMS to the other inlet did not reach the frontend — the "
            "card would keep showing the old inlet badge until a page reload"
        )

    @pytest.mark.asyncio
    async def test_fitting_the_accessory_broadcasts(self, ws_mgr):
        await self._push_state(ws_mgr, self._fts_state({}, installed=False))
        await self._push_state(ws_mgr, self._fts_state({}, installed=True))

        assert ws_mgr.send_printer_status.await_count == 2

    @pytest.mark.asyncio
    async def test_an_unchanged_binding_is_still_suppressed(self, ws_mgr):
        """The binding only moves when someone reconfigures the machine, so it
        must not add a broadcast to every push mid-print."""
        for _ in range(3):
            await self._push_state(ws_mgr, self._fts_state({"0": "A", "1": "B"}))

        assert ws_mgr.send_printer_status.await_count == 1

    @pytest.mark.asyncio
    async def test_key_order_does_not_matter(self, ws_mgr):
        """Dict iteration order must not masquerade as a rebind."""
        await self._push_state(ws_mgr, self._fts_state({"0": "A", "1": "B"}))
        await self._push_state(ws_mgr, self._fts_state({"1": "B", "0": "A"}))

        assert ws_mgr.send_printer_status.await_count == 1


class TestDryCountdownStallBroadcasts:
    """#2896: a parked drying command must be able to reach the card.

    ``dry_countdown_stalled`` is the one drying signal the countdown cannot
    carry, because the MQTT layer raises it exactly when ``dry_time`` has
    STOPPED moving. On the frame that flips it, every other member of the dedup
    key is identical, so unless the flag is itself in the key the handler
    returns before broadcasting. Mid-print a temperature change would eventually
    break the tie, but a command parked on an idle machine moves nothing else —
    AMS temp and humidity are not in the key — so the grey "Drying not started"
    badge would sit unreachable.
    """

    @pytest.mark.asyncio
    async def test_the_stall_flip_broadcasts(self, ws_mgr):
        await _push(ws_mgr, [_tray()], {"dry_time": 720})
        assert ws_mgr.send_printer_status.await_count == 1

        # Same frozen countdown again: genuinely nothing changed.
        await _push(ws_mgr, [_tray()], {"dry_time": 720})
        assert ws_mgr.send_printer_status.await_count == 1

        # 150s of no tick later the MQTT layer stamps the stall. dry_time is
        # unchanged by definition — only the flag can break the key.
        await _push(ws_mgr, [_tray()], {"dry_time": 720, "dry_countdown_stalled": True})

        assert ws_mgr.send_printer_status.await_count == 2, (
            "the stall flag did not reach the frontend — the card would keep "
            "claiming an active 12h drying cycle that is not running"
        )

    @pytest.mark.asyncio
    async def test_clearing_the_stall_broadcasts(self, ws_mgr):
        """The recovery edge matters too: the firmware finally starts the cycle,
        the countdown ticks, and the badge must go back to amber."""
        await _push(ws_mgr, [_tray()], {"dry_time": 720, "dry_countdown_stalled": True})

        await _push(ws_mgr, [_tray()], {"dry_time": 719})

        assert ws_mgr.send_printer_status.await_count == 2

    @pytest.mark.asyncio
    async def test_a_steady_stalled_unit_does_not_reflood(self, ws_mgr):
        """Once flagged, repeats of the flagged frame stay deduplicated — the
        flag flips once per cycle, so widening the key costs no traffic."""
        await _push(ws_mgr, [_tray()], {"dry_time": 720, "dry_countdown_stalled": True})
        await _push(ws_mgr, [_tray()], {"dry_time": 720, "dry_countdown_stalled": True})

        assert ws_mgr.send_printer_status.await_count == 1