jaxl-python 0.0.47__tar.gz → 0.0.49__tar.gz

{jaxl_python-0.0.47 → jaxl_python-0.0.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxl-python
-Version: 0.0.47
+Version: 0.0.49
 Summary: Official Python SDK and CLI for interfacing with the Jaxl API. Manage calls, messages, IVRs, devices, teams, payments, campaigns, streaming transcriptions and AI Agents. Built on OpenAPI, it offers both generated API clients and Pythonic wrappers for ease of use.
 Home-page: https://github.com/jaxl-innovations-private-limited/jaxl-python
 Download-URL: https://github.com/jaxl-innovations-private-limited/jaxl-python/archive/main.zip

{jaxl_python-0.0.47 → jaxl_python-0.0.49}/jaxl/api/base.py

@@ -113,8 +113,14 @@ class JaxlStreamMeta(BaseModel):
 class JaxlStreamRequest(BaseModel):
     # IVR ID
     pk: int
-    # Webhook state
+    # Webhook state (present on legacy streams that carry the full
+    # base64 state blob in the websocket URL; None on slim streams)
     state: Optional[JaxlWebhookState]
+    # Call ID for this stream — always populated by the SDK server.
+    # On slim streams (the `call_id=` query form) this is the ONLY
+    # call identity on the socket; apps needing the full state should
+    # take it from the SETUP webhook instead.
+    call_id: Optional[int] = None
 
 
 class JaxlPhoneCta(BaseModel):
@@ -176,6 +182,32 @@ class BaseJaxlApp:
     def websocket_routes(self) -> List[Tuple[str, WebsocketRouteFunc]]:
         return []
 
+    # pylint: disable=no-self-use,unused-argument
+    async def on_startup(self) -> None:
+        """Invoked ONCE, on the server's startup event, before any call.
+
+        This is the first point at which a running event loop exists —
+        ``__init__`` runs while the app object is constructed, which
+        happens synchronously before the server starts, so background
+        tasks cannot be scheduled there.
+
+        Use it to warm anything that would otherwise be paid on the
+        critical path of the first call: connection pools, model
+        clients, caches, on-disk asset checks. Keep it non-blocking and
+        never raise — an exception here is logged and ignored so a slow
+        or failing warm-up can never stop the server from serving.
+        """
+        return None
+
+    # pylint: disable=no-self-use,unused-argument
+    async def on_shutdown(self) -> None:
+        """Invoked ONCE, on the server's shutdown event.
+
+        Counterpart to :meth:`on_startup` — release anything it warmed
+        (open sockets, background tasks). Never raise.
+        """
+        return None
+
     # pylint: disable=no-self-use,unused-argument
     async def handle_configure(self, req: JaxlWebhookRequest) -> HANDLER_RESPONSE:
         """Invoked when a phone number gets assigned to IVR."""

{jaxl_python-0.0.47 → jaxl_python-0.0.49}/jaxl/api/client/_scm_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.47'
-__version_tuple__ = version_tuple = (0, 0, 47)
+__version__ = version = '0.0.49'
+__version_tuple__ = version_tuple = (0, 0, 49)

{jaxl_python-0.0.47 → jaxl_python-0.0.49}/jaxl/api/resources/apps.py

@@ -248,12 +248,23 @@ def _start_server(
         """Jaxl Streaming Unidirectional Websockets Endpoint."""
         _ivr_id = ws.query_params.get("ivr_id")
         _state = ws.query_params.get("state")
-        if _state is None or _ivr_id is None:
+        _call_id = ws.query_params.get("call_id")
+        # Exactly ONE of `state` (legacy: the full webhook-state blob,
+        # base64-encoded into the websocket URL) or `call_id` (slim
+        # form: only the call identity rides the URL; the full state
+        # travels via the SETUP webhook) must be present — never both,
+        # never neither.
+        if _ivr_id is None or (_state is None) == (_call_id is None):
             await ws.close(code=1008)
             return
 
         ivr_id = int(_ivr_id)
-        state = json.loads(base64.urlsafe_b64decode(_state))
+        if _state is not None:
+            state = json.loads(base64.urlsafe_b64decode(_state))
+            call_id = int(state["call_id"])
+        else:
+            state = None
+            call_id = int(_call_id)  # type: ignore[arg-type]
 
         # Speech detector, Speech state & Segment buffer
         sdetector = SilenceDetector(
@@ -265,10 +276,10 @@ def _start_server(
         slin16s: List[bytes] = []
 
         await ws.accept()
-        wss[state["call_id"]] = ws
+        wss[call_id] = ws
 
         # pylint: disable=too-many-nested-blocks
-        await app.on_stream_connect(state["call_id"])
+        await app.on_stream_connect(call_id)
         try:
             while True:
                 try:
@@ -284,7 +295,7 @@ def _start_server(
                 data = json.loads(raw)
                 ev = data["event"]
                 if ev == "media":
-                    req = JaxlStreamRequest(pk=ivr_id, state=state)
+                    req = JaxlStreamRequest(pk=ivr_id, state=state, call_id=call_id)
                     slin16 = base64.b64decode(data[ev]["payload"])
                     # Optional per-packet metadata (e.g. speaker attribution)
                     _meta = data[ev].get("meta")
@@ -296,7 +307,7 @@ def _start_server(
                     # Manage speech segments
                     if change is True:
                         speaking = change
-                        await app.handle_speech_detection(state["call_id"], speaking)
+                        await app.handle_speech_detection(call_id, speaking)
                         # Pull the detector's preroll — this contains the
                         # trigger frames (the `speech_frame_threshold` speech
                         # frames that fired speech-start) plus a few earlier
@@ -310,7 +321,7 @@ def _start_server(
                             await app.handle_speech_chunks(req, preroll_chunks)
                     elif change is False:
                         speaking = change
-                        await app.handle_speech_detection(state["call_id"], speaking)
+                        await app.handle_speech_detection(call_id, speaking)
                         if len(slin16s) > 0:
                             # Invoke speech segment handlers
                             await app.handle_speech_segment(req, slin16s)
@@ -341,14 +352,14 @@ def _start_server(
                             assert speaking is False
                 elif ev == "handoff":
                     await app.handle_handoff(
-                        state["call_id"],
+                        call_id,
                         int(data[ev]["call_id"]),
                         str(data[ev]["status"]),
                     )
                 elif ev == "mark":
                     # Echo envelope is {"event": "mark", "mark": {"name": ...}}
                     await app.handle_stream_mark(
-                        state["call_id"], str(data[ev]["name"])
+                        call_id, str(data[ev]["name"])
                     )
                 elif ev == "connected":
                     pass
@@ -358,8 +369,8 @@ def _start_server(
             pass
         finally:
             try:
-                if state["call_id"] in wss:
-                    del wss[state["call_id"]]
+                if call_id in wss:
+                    del wss[call_id]
                 if ws.client_state != WebSocketState.DISCONNECTED:
                     try:
                         await ws.close()
@@ -369,7 +380,27 @@ def _start_server(
                         # message has been sent." Nothing to do.
                         pass
             finally:
-                await app.on_stream_disconnect(state["call_id"])
+                await app.on_stream_disconnect(call_id)
+
+    async def _on_startup() -> None:
+        """Give the app its ONE pre-traffic moment with a live event
+        loop. The app object is constructed synchronously before the
+        server starts, so `__init__` cannot schedule background work —
+        this is where a pool/cache/client warm-up belongs. Guarded: a
+        slow or failing warm-up must never stop the server serving."""
+        try:
+            await app.on_startup()
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            logger.exception(f"on_startup failed, continuing: {exc!r}")
+
+    async def _on_shutdown() -> None:
+        try:
+            await app.on_shutdown()
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            logger.exception(f"on_shutdown failed, continuing: {exc!r}")
+
+    server.add_event_handler("startup", _on_startup)
+    server.add_event_handler("shutdown", _on_shutdown)
 
     for config, func in app.api_routes():
         server.add_api_route(

{jaxl_python-0.0.47 → jaxl_python-0.0.49}/jaxl_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxl-python
-Version: 0.0.47
+Version: 0.0.49
 Summary: Official Python SDK and CLI for interfacing with the Jaxl API. Manage calls, messages, IVRs, devices, teams, payments, campaigns, streaming transcriptions and AI Agents. Built on OpenAPI, it offers both generated API clients and Pythonic wrappers for ease of use.
 Home-page: https://github.com/jaxl-innovations-private-limited/jaxl-python
 Download-URL: https://github.com/jaxl-innovations-private-limited/jaxl-python/archive/main.zip