python-aidot-cameras 0.12.10__tar.gz → 0.12.12__tar.gz

{python_aidot_cameras-0.12.10/python_aidot_cameras.egg-info → python_aidot_cameras-0.12.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 0.12.10
+Version: 0.12.12
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-0.12.10 → python_aidot_cameras-0.12.12}/aidot_cameras/camera/client.py

@@ -2,6 +2,7 @@
 
 import json
 import logging
+from urllib.parse import urlparse
 import os
 import random
 import time
@@ -147,6 +148,13 @@ _BG_TASKS: set = set()
 # means refetching is not helping, so back off rather than loop.
 _MQTT_CREDENTIAL_REFETCH_FLOOR = 30.0
 
+# How often the "is anyone watching" question may actually reach go2rtc. The
+# watchdog loops tick twice a second; asking that often opens a fresh HTTP
+# session per camera per tick against the service that also has to serve the
+# video. Idle release is measured in minutes, so seconds of staleness here costs
+# nothing.
+_VIEWER_CHECK_INTERVAL_S = 10.0
+
 
 def _spawn_bg(coro):
     _t = asyncio.ensure_future(coro)
@@ -337,6 +345,22 @@ def _save_frame_as_jpeg(image_data: Any, output_path: str) -> bool:
     return False
 
 
+def _is_self_referential_source(source: str, stream_name: str) -> bool:
+    """True when registering ``source`` under ``stream_name`` would loop.
+
+    A go2rtc stream whose source is its own RTSP address becomes its own
+    producer: the stream lists a producer, nothing feeds it, and every consumer
+    gets a connection with no media.  That is exactly the shape of a PUSH URL,
+    ``rtsp://host:8554/<stream name>`` - the address the keepalive publishes to.
+    """
+    if not source or not stream_name:
+        return False
+    if not source.lower().startswith(("rtsp://", "rtsps://")):
+        return False
+    path = urlparse(source).path.strip("/")
+    return path == stream_name
+
+
 def _build_sdes_serve_cmd(
     *,
     sdp_path: str,
@@ -2763,6 +2787,18 @@ class CameraMixin(_CameraControlsMixin, _WebRTCOpenMixin, _SdesOpenMixin):
         if not (self._streaming_active and self._go2rtc_url and self._keepalive_rtsp_url):
             return
         name = self._go2rtc_stream_name()
+        if _is_self_referential_source(self._keepalive_rtsp_url, name):
+            # PUSH mode: the keepalive publishes INTO go2rtc, so this URL is
+            # go2rtc's own address for this very stream.  Registering it as the
+            # stream's source makes go2rtc its own producer - a loop that yields
+            # a stream with a producer attached and no media coming out of it.
+            # In push mode the publisher already feeds the stream; there is
+            # nothing to register.
+            _LOGGER.debug(
+                "camera %s: not registering %s with go2rtc - the push URL is that "
+                "stream's own address", self.device_id, name,
+            )
+            return
         try:
             async with aiohttp.ClientSession() as _s2:
                 url = await prefer_go2rtc(
@@ -2908,6 +2944,10 @@ class CameraMixin(_CameraControlsMixin, _WebRTCOpenMixin, _SdesOpenMixin):
         register, deregister and viewer-count paths cannot drift apart."""
         return f"aidot_{self.device_id[:12]}"
 
+    # Cached answer to "is anyone watching", so the watchdog loops can ask on
+    # every tick without hammering go2rtc.
+    _viewer_cache: "tuple[float, Optional[bool]]" = (0.0, None)
+
     async def _viewer_present(self, port: int) -> "Optional[bool]":
         """Is anyone ACTUALLY watching?  True / False / None (unknown).
 
@@ -2923,6 +2963,17 @@ class CameraMixin(_CameraControlsMixin, _WebRTCOpenMixin, _SdesOpenMixin):
         Falls back to the TCP-table check when go2rtc is not in use, and returns
         None (never release) if neither can answer.
         """
+        # THROTTLE FIRST.  The DTLS watchdog calls this every 0.5s and the SDES
+        # one on a similar cadence, and the go2rtc query below opens a fresh HTTP
+        # session each time - so an unthrottled check is two requests per second
+        # per camera, forever, against the very service that has to serve the
+        # video.  On a small fleet that is enough load to stop go2rtc answering
+        # at all, which looks exactly like "no video anywhere".
+        _now_mono = time.monotonic()
+        _last, _cached = self._viewer_cache
+        if _now_mono - _last < _VIEWER_CHECK_INTERVAL_S:
+            return _cached
+
         name = self._go2rtc_stream_name()
         base = self._go2rtc_url
         if not base:
@@ -2939,6 +2990,7 @@ class CameraMixin(_CameraControlsMixin, _WebRTCOpenMixin, _SdesOpenMixin):
                     "no go2rtc url and the serve is an RTSP push to a shared "
                     "port; cannot tell whether anyone is watching",
                 )
+                self._viewer_cache = (_now_mono, None)
                 return None
         if base and name:
             try:
@@ -2948,10 +3000,14 @@ class CameraMixin(_CameraControlsMixin, _WebRTCOpenMixin, _SdesOpenMixin):
                 async with aiohttp.ClientSession() as _s:
                     viewers = await Go2rtcClient(_s, base).viewer_count(name)
                 if viewers is not None:
-                    return viewers > 0
+                    _answer = viewers > 0
+                    self._viewer_cache = (_now_mono, _answer)
+                    return _answer
             except Exception as exc:
                 _LOGGER.debug("go2rtc viewer check failed: %s", exc)
-        return self._sdes_serve_consumer_present(port)
+        _answer = self._sdes_serve_consumer_present(port)
+        self._viewer_cache = (_now_mono, _answer)
+        return _answer
 
     async def _sdes_keepalive_loop(self) -> None:
         """Keep the cold-start serve relay alive around the SDES keepalive loop.

{python_aidot_cameras-0.12.10 → python_aidot_cameras-0.12.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-aidot-cameras"
-version = "0.12.10"
+version = "0.12.12"
 description = "Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)"
 readme = "README.md"
 license = "MIT"

{python_aidot_cameras-0.12.10 → python_aidot_cameras-0.12.12/python_aidot_cameras.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 0.12.10
+Version: 0.12.12
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-0.12.10 → python_aidot_cameras-0.12.12}/python_aidot_cameras.egg-info/SOURCES.txt

@@ -98,6 +98,7 @@ tests/test_mqtt_credential_self_heal.py
 tests/test_mqtt_password_not_persisted.py
 tests/test_mqtt_session_reconnect.py
 tests/test_narrow_pc_ice.py
+tests/test_no_self_referential_go2rtc.py
 tests/test_no_undefined_names.py
 tests/test_offline_keepalive_pause.py
 tests/test_open_fail_logger.py
@@ -136,5 +137,6 @@ tests/test_terminal_ack.py
 tests/test_token_file_robustness.py
 tests/test_token_refresh.py
 tests/test_upstream_compat.py
+tests/test_viewer_check_throttle.py
 tests/test_viewer_presence.py
 tests/test_wait_or_event.py

python_aidot_cameras-0.12.12/tests/test_no_self_referential_go2rtc.py

@@ -0,0 +1,47 @@
+"""A go2rtc stream must never be registered as its own source.
+
+In PUSH mode the keepalive publishes INTO go2rtc, so the "keepalive rtsp url" is
+go2rtc's own address for that stream. Registering it as the stream's source makes
+go2rtc its own producer: the stream lists a producer, nothing feeds it, and every
+consumer gets a connection with no media.
+
+Seen live after the integration began passing go2rtc_url: one camera's stream had
+two producers, one of them `rtsp://127.0.0.1:8554/aidot_12b144cb12da` - its own
+address - and go2rtc returned HTTP 200 with a zero-byte frame for it.
+"""
+from aidot_cameras.camera.client import _is_self_referential_source as loops
+
+
+def test_push_url_for_the_same_stream_is_self_referential():
+    assert loops("rtsp://127.0.0.1:8554/aidot_12b144cb12da",
+                 "aidot_12b144cb12da") is True
+
+
+def test_push_url_for_a_different_stream_is_fine():
+    # Publishing camera A into stream B is odd but not a loop.
+    assert loops("rtsp://127.0.0.1:8554/aidot_other", "aidot_12b144cb12da") is False
+
+
+def test_the_http_serve_url_is_a_real_source():
+    # PULL mode: go2rtc fetches from the library's own serve. Must still register.
+    assert loops("http://127.0.0.1:18931/ecf4937b640c4c96a102ffdc9b51c2a0.ts",
+                 "aidot_ecf4937b640c") is False
+
+
+def test_rtsps_is_covered_too():
+    assert loops("rtsps://127.0.0.1:8554/aidot_x", "aidot_x") is True
+
+
+def test_trailing_slash_and_case_do_not_hide_it():
+    assert loops("RTSP://127.0.0.1:8554/aidot_x/", "aidot_x") is True
+
+
+def test_missing_values_are_not_self_referential():
+    assert loops("", "aidot_x") is False
+    assert loops("rtsp://127.0.0.1:8554/aidot_x", "") is False
+
+
+def test_a_remote_go2rtc_push_url_still_counts():
+    # The host does not matter; publishing into the stream you are registering is
+    # a loop wherever go2rtc lives.
+    assert loops("rtsp://go2rtc.lan:8554/aidot_x", "aidot_x") is True

python_aidot_cameras-0.12.12/tests/test_viewer_check_throttle.py

@@ -0,0 +1,71 @@
+"""The viewer check must not be asked of go2rtc on every watchdog tick.
+
+The DTLS watchdog loops twice a second, and the go2rtc query opens a fresh HTTP
+session per call - so an unthrottled check is two requests per second per camera,
+forever, aimed at the very service that also has to serve the video. On a small
+fleet that was enough to stop go2rtc answering at all, which presents as no video
+anywhere. Idle release is measured in minutes, so a few seconds of staleness in
+the answer costs nothing.
+"""
+import asyncio
+import time
+
+import aidot_cameras.camera.client as cc
+from aidot_cameras.device_client import CameraDeviceClient
+
+
+def _client(answer):
+    c = CameraDeviceClient.__new__(CameraDeviceClient)
+    c._go2rtc_url = None
+    c._keepalive_rtsp_url = "http://127.0.0.1:18931/x.ts"
+    c.device_id = "abc123abc123def"
+    c._viewer_cache = (0.0, None)
+    calls = []
+
+    def _probe(port):
+        calls.append(port)
+        return answer
+
+    c._sdes_serve_consumer_present = _probe
+    return c, calls
+
+
+def test_repeated_calls_hit_the_backend_once():
+    c, calls = _client(True)
+
+    async def go():
+        for _ in range(40):          # 40 watchdog ticks
+            await c._viewer_present(18931)
+    asyncio.run(go())
+    assert len(calls) == 1, f"backend hit {len(calls)} times, expected 1"
+
+
+def test_the_cached_answer_is_returned_verbatim():
+    for answer in (True, False, None):
+        c, _ = _client(answer)
+
+        async def go():
+            first = await c._viewer_present(18931)
+            second = await c._viewer_present(18931)
+            return first, second
+        first, second = asyncio.run(go())
+        assert first == answer and second == answer
+
+
+def test_the_cache_expires_so_the_answer_can_change():
+    c, calls = _client(True)
+
+    async def go():
+        await c._viewer_present(18931)
+        # Pretend the interval has elapsed.
+        stamp, cached = c._viewer_cache
+        c._viewer_cache = (stamp - cc._VIEWER_CHECK_INTERVAL_S - 1, cached)
+        await c._viewer_present(18931)
+    asyncio.run(go())
+    assert len(calls) == 2
+
+
+def test_the_interval_is_long_enough_to_matter():
+    # The watchdog ticks every 0.5s; anything under a couple of seconds would
+    # still be a request storm.
+    assert cc._VIEWER_CHECK_INTERVAL_S >= 5.0