phoenix-channels-python-client 0.5.1__tar.gz → 0.5.2__tar.gz

{phoenix_channels_python_client-0.5.1/phoenix_channels_python_client.egg-info → phoenix_channels_python_client-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phoenix-channels-python-client
-Version: 0.5.1
+Version: 0.5.2
 Summary: A Python client library for connecting to Phoenix Channels
 Author: Phoenix Channels Python Client
 License-Expression: MIT
@@ -681,7 +681,9 @@ Expiry or heartbeat send failure force-closes that socket; the supervisor handle
 ## Logging
 
 The library uses loggers under `phoenix_channels_python_client`. Configure
-logging in your application; importing the package does not configure it:
+logging in your application; importing the package does not configure it.
+Connection log lines show `<omitted>` in place of values that may carry personal
+data (see [Authentication and diagnostic safety](#authentication-and-diagnostic-safety)):
 
 ```python
 import logging
@@ -736,10 +738,12 @@ exception objects, or socket metadata. `client.redact_diagnostic(text)` applies
 the credential policy to transport errors a caller needs to retain. Caller-visible
 errors may still contain personal data and should not be logged outside this policy.
 
-Connection diagnostics omit dynamic strings and transport payloads, including URLs,
-headers, frame bodies, user/topic identities, and untrusted server error details.
-Logs retain static lifecycle descriptions, native connection states,
-and exception types. Application data and caller-visible errors are not changed;
+Connection diagnostics omit dynamic values and transport payloads, including URLs,
+headers, frame bodies, user/topic identities, numbers, and untrusted server error
+details. Each omitted value appears as `<omitted>`, for example
+`No handler found for event <omitted> on topic <omitted>`. Logs retain static
+lifecycle descriptions, enum values such as connection states, booleans, and
+exception types. Application data and caller-visible errors are not changed;
 applications remain responsible for logs outside this connection-owned boundary.
 
 ---

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/README.md

@@ -648,7 +648,9 @@ Expiry or heartbeat send failure force-closes that socket; the supervisor handle
 ## Logging
 
 The library uses loggers under `phoenix_channels_python_client`. Configure
-logging in your application; importing the package does not configure it:
+logging in your application; importing the package does not configure it.
+Connection log lines show `<omitted>` in place of values that may carry personal
+data (see [Authentication and diagnostic safety](#authentication-and-diagnostic-safety)):
 
 ```python
 import logging
@@ -703,10 +705,12 @@ exception objects, or socket metadata. `client.redact_diagnostic(text)` applies
 the credential policy to transport errors a caller needs to retain. Caller-visible
 errors may still contain personal data and should not be logged outside this policy.
 
-Connection diagnostics omit dynamic strings and transport payloads, including URLs,
-headers, frame bodies, user/topic identities, and untrusted server error details.
-Logs retain static lifecycle descriptions, native connection states,
-and exception types. Application data and caller-visible errors are not changed;
+Connection diagnostics omit dynamic values and transport payloads, including URLs,
+headers, frame bodies, user/topic identities, numbers, and untrusted server error
+details. Each omitted value appears as `<omitted>`, for example
+`No handler found for event <omitted> on topic <omitted>`. Logs retain static
+lifecycle descriptions, enum values such as connection states, booleans, and
+exception types. Application data and caller-visible errors are not changed;
 applications remain responsible for logs outside this connection-owned boundary.
 
 ---

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/__init__.py

@@ -27,7 +27,7 @@ from phoenix_channels_python_client.messages import Message, Payload, SystemEven
 from phoenix_channels_python_client.protocol import ProtocolVersion
 from phoenix_channels_python_client.replies import Reply
 
-__version__ = "0.5.1"
+__version__ = "0.5.2"
 
 __all__ = [
     "Channel",

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/codec.py

@@ -120,7 +120,9 @@ def _decode_binary(raw: bytes) -> DecodedMessage:
         raise ValueError("Empty binary frame")
     kind = BinaryKind(raw[0])
     fields, payload = _binary_fields(raw, SERVER_HEADER_FIELDS[kind])
-    status = None
+    join_ref: str | None
+    ref: str | None
+    status: str | None = None
     match kind:
         case BinaryKind.PUSH:
             join_ref, topic, event = fields

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/diagnostics.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import json
 import logging
 import re
+from enum import Enum
 from urllib.parse import parse_qsl, quote, quote_plus, urlsplit
 
 from websockets.protocol import State
@@ -14,7 +15,34 @@ from phoenix_channels_python_client.authentication import (
 )
 
 REDACTED = "[REDACTED]"
+OMITTED = "<omitted>"
 PERCENT_ESCAPE = re.compile(r"%[0-9a-fA-F]{2}")
+# A printf-style conversion, as logging applies to a record's msg and args.
+PLACEHOLDER = re.compile(
+    r"%(?:\([^)]*\))?[#0 +-]*(?:\*|\d+)?(?:\.(?:\*|\d+))?[hlL]?[diouxXeEfFgGcrsa%]"
+)
+WEBSOCKET_STATE_MESSAGE = "= connection is %s"
+
+
+def render_value(value: object) -> str:
+    # Enum members and booleans are code-defined; any other value, numbers
+    # included, may carry personal data.
+    return str(value) if isinstance(value, Enum | bool) else OMITTED
+
+
+def render_message(record: logging.LogRecord) -> str:
+    """Fill a record's placeholders without exposing its arguments."""
+    message = str(record.msg)
+    if not record.args:
+        return message
+    args = record.args if isinstance(record.args, tuple) else ()
+    if message == WEBSOCKET_STATE_MESSAGE and args and args[0] in State.__members__:
+        return message % args[0]
+    values = iter(args)
+    return PLACEHOLDER.sub(
+        lambda match: "%" if match[0] == "%%" else render_value(next(values, None)),
+        message,
+    )
 
 
 AUTHENTICATION_NAMES = frozenset(
@@ -86,15 +114,7 @@ class ConnectionLogger(logging.Logger):
     def handle(self, record: logging.LogRecord) -> None:
         if self.target.disabled:
             return
-        message = str(record.msg)
-        if (
-            record.msg == "= connection is %s"
-            and isinstance(record.args, tuple)
-            and len(record.args) == 1
-            and isinstance(record.args[0], str)
-            and record.args[0] in State.__members__
-        ):
-            message = record.msg % record.args
+        message = render_message(record)
         if record.exc_info and record.exc_info[0]:
             message += " [" + record.exc_info[0].__name__ + "]"
         safe_record = logging.LogRecord(

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/messages.py

@@ -14,7 +14,7 @@ class SystemEvent(StrEnum):
     close = "phx_close"
     error = "phx_error"
     # The protocol event intentionally shadows str.join.
-    join = "phx_join"  # type: ignore[bad-override]
+    join = "phx_join"  # type: ignore[bad-override, assignment]
     reply = "phx_reply"
     leave = "phx_leave"
 

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/replies.py

@@ -20,13 +20,11 @@ def reply_from_message(message: Message, *, binary_status: str | None = None) ->
     if binary_status is not None:
         if type(message.payload) is not bytes:
             raise TypeError("Binary reply requires a bytes payload")
-        status, response = binary_status, message.payload
-    else:
-        payload = message.payload
-        if not isinstance(payload, dict):
-            raise TypeError("Text reply requires a response envelope")
-        status = payload.get("status")
-        response = payload.get("response")
-        if not isinstance(status, str) or not isinstance(response, dict):
-            raise TypeError("Reply must contain a string status and a response map")
+        return Reply(status=binary_status, response=message.payload)
+    payload = message.payload
+    if not isinstance(payload, dict):
+        raise TypeError("Text reply requires a response envelope")
+    status, response = payload.get("status"), payload.get("response")
+    if not isinstance(status, str) or not isinstance(response, dict):
+        raise TypeError("Reply must contain a string status and a response map")
     return Reply(status=status, response=response)

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/supervisor.py

@@ -27,6 +27,7 @@ from phoenix_channels_python_client.messages import (
     Message,
 )
 from phoenix_channels_python_client.protocol_handler import PHXProtocolHandler
+from phoenix_channels_python_client.send_session import SessionSends
 from phoenix_channels_python_client.shutdown_signals import handle_shutdown_signals
 from phoenix_channels_python_client.topic_subscription import (
     ChannelState,
@@ -102,6 +103,7 @@ class SupervisorMixin:
     heartbeat_interval_s: float | None
     heartbeat_task: asyncio.Task[None] | None
     pending_heartbeat_ref: str | None
+    send_session: SessionSends | None
     on_reconnect: Callable[[], Awaitable[None]] | None
     on_disconnect: Callable[[Exception | None], Awaitable[None]] | None
     on_heartbeat_ack: Callable[[], None] | None

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/phoenix_channels_python_client/topic_runtime.py

@@ -838,8 +838,9 @@ class TopicRuntimeMixin:
 
     def _validate_join_hook(self, topic: TopicSubscription) -> None:
         hook = topic.on_join_response
-        if inspect.iscoroutinefunction(hook) or inspect.iscoroutinefunction(
-            hook.__call__ if callable(hook) else None
+        if hook is not None and (
+            inspect.iscoroutinefunction(hook)
+            or inspect.iscoroutinefunction(type(hook).__call__)
         ):
             raise ChannelError("on_join_response must be synchronous")
 

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2/phoenix_channels_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phoenix-channels-python-client
-Version: 0.5.1
+Version: 0.5.2
 Summary: A Python client library for connecting to Phoenix Channels
 Author: Phoenix Channels Python Client
 License-Expression: MIT
@@ -681,7 +681,9 @@ Expiry or heartbeat send failure force-closes that socket; the supervisor handle
 ## Logging
 
 The library uses loggers under `phoenix_channels_python_client`. Configure
-logging in your application; importing the package does not configure it:
+logging in your application; importing the package does not configure it.
+Connection log lines show `<omitted>` in place of values that may carry personal
+data (see [Authentication and diagnostic safety](#authentication-and-diagnostic-safety)):
 
 ```python
 import logging
@@ -736,10 +738,12 @@ exception objects, or socket metadata. `client.redact_diagnostic(text)` applies
 the credential policy to transport errors a caller needs to retain. Caller-visible
 errors may still contain personal data and should not be logged outside this policy.
 
-Connection diagnostics omit dynamic strings and transport payloads, including URLs,
-headers, frame bodies, user/topic identities, and untrusted server error details.
-Logs retain static lifecycle descriptions, native connection states,
-and exception types. Application data and caller-visible errors are not changed;
+Connection diagnostics omit dynamic values and transport payloads, including URLs,
+headers, frame bodies, user/topic identities, numbers, and untrusted server error
+details. Each omitted value appears as `<omitted>`, for example
+`No handler found for event <omitted> on topic <omitted>`. Logs retain static
+lifecycle descriptions, enum values such as connection states, booleans, and
+exception types. Application data and caller-visible errors are not changed;
 applications remain responsible for logs outside this connection-owned boundary.
 
 ---

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "phoenix-channels-python-client"
-version = "0.5.1"
+version = "0.5.2"
 description = "A Python client library for connecting to Phoenix Channels"
 readme = "README.md"
 license = "MIT"

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/tests/test_channel_recovery.py

@@ -91,7 +91,7 @@ async def test_a_crashed_channel_rejoins_on_the_live_socket(
         assert (await expect_message(received)).event == EVENT
         assert reconnects.count == 0
 
-    assert "Recovered channel for topic %s" in caplog.text
+    assert "Recovered channel for topic <omitted>" in caplog.text
 
 
 @each_protocol
@@ -178,7 +178,7 @@ async def test_a_rejected_channel_rejoin_loses_the_topic(
         lost.only_error()
         assert TOPIC not in client.topic_subscriptions.copy()
         assert joins(phoenix_server) == REJOINED_ONCE
-    assert "Lost topic %s" in caplog.text
+    assert "Lost topic <omitted>" in caplog.text
 
 
 @each_protocol

{phoenix_channels_python_client-0.5.1 → phoenix_channels_python_client-0.5.2}/tests/test_security.py

@@ -15,6 +15,7 @@ from phoenix_channels_python_client import Client
 from phoenix_channels_python_client.client_types import ReconnectPolicy
 from phoenix_channels_python_client.diagnostics import ConnectionLogger
 from phoenix_channels_python_client.exceptions import SocketError
+from phoenix_channels_python_client.messages import SystemEvent
 from tests.fake_server import FakePhoenixServer
 
 URL_CREDENTIAL = "url/private+ credential?x=1&z=#[]"
@@ -199,6 +200,45 @@ class TestConnectionSecurity:
             target.disabled = previous_disabled
             target.removeFilter(reject)
 
+    @pytest.mark.parametrize(
+        ("message", "args", "rendered"),
+        [
+            (
+                "No handler found for event %s on topic %s",
+                ("user_join", "room:42"),
+                "No handler found for event <omitted> on topic <omitted>",
+            ),
+            (
+                "Channel %s is %s after %d attempts",
+                (SystemEvent.join, True, 3),
+                "Channel phx_join is True after <omitted> attempts",
+            ),
+            ("100%% of %s", ("room:42",), "100% of <omitted>"),
+            ("%s and %s", ("only-one",), "<omitted> and <omitted>"),
+            ("%d with text", ("not-a-number",), "<omitted> with text"),
+            ("%(topic)s by name", ({"topic": "room:42"},), "<omitted> by name"),
+        ],
+        ids=[
+            "strings",
+            "enum-bool-number",
+            "escape",
+            "too-few",
+            "type-mismatch",
+            "mapping",
+        ],
+    )
+    def test_placeholders_render_without_exposing_arguments(
+        self, message: str, args: tuple[object, ...], rendered: str
+    ) -> None:
+        client = Client("ws://127.0.0.1:1/socket", api_key="synthetic-key")
+        collector = BufferingHandler(10)
+        client.logger.addHandler(collector)
+        client.logger.setLevel(logging.WARNING)
+
+        client.logger.warning(message, *args)
+
+        assert [record.getMessage() for record in collector.buffer] == [rendered]
+
     @pytest.mark.parametrize(
         "header_names",
         [
@@ -395,6 +435,9 @@ class TestConnectionSecurity:
             "Parsing raw message:" in record.getMessage() for record in collector.buffer
         )
         assert any("OPEN" in record.getMessage() for record in collector.buffer)
+        messages = [record.getMessage() for record in collector.buffer]
+        assert "Connection callback failed: <omitted> [RuntimeError]" in messages
+        assert "Untrusted numeric identity: <omitted> <omitted> <omitted>" in messages
         for record in collector.buffer:
             assert identity not in repr(record.__dict__)
             assert session not in repr(record.__dict__)