feat(realtime): add explicit REST API call for broadcast

grdsdev · claude · grdsdev · commit ae960ad99c5d · 2025-10-09T13:59:26.000-03:00
Added new public method `http_send` for explicit usage of REST API for broadcast messages. This method always uses the REST API endpoint regardless of WebSocket connection state, giving users more control over message delivery. Changes: - Add `http_send()` method to AsyncRealtimeChannel for explicit REST delivery - Add deprecation warning to `send_broadcast()` when falling back to REST - Add httpx dependency for REST API calls - Add comprehensive test suite for http_send functionality Ported from supabase-js PR #1751 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/src/realtime/pyproject.toml b/src/realtime/pyproject.toml
@@ -17,6 +17,7 @@ dependencies = [
   "websockets >=11,<16",
   "typing-extensions >=4.14.0",
   "pydantic (>=2.11.7,<3.0.0)",
+  "httpx[http2] >=0.26,<0.29",
 ]
 
 [project.urls]
diff --git a/src/realtime/src/realtime/_async/channel.py b/src/realtime/src/realtime/_async/channel.py
@@ -3,8 +3,9 @@
 import asyncio
 import json
 import logging
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Mapping, Optional
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Mapping, Optional, Union
 
+import httpx
 from typing_extensions import assert_never
 
 from realtime.types import (
@@ -488,11 +489,96 @@ async def send_broadcast(self, event: str, data: Any) -> None:
         :param event: The name of the broadcast event
         :param data: The payload to broadcast
         """
+        if not self._can_push():
+            logger.warning(
+                "Realtime send_broadcast() is automatically falling back to REST API. "
+                "This behavior will be deprecated in the future. "
+                "Please use http_send() explicitly for REST delivery."
+            )
+
         await self.push(
             ChannelEvents.broadcast,
             {"type": "broadcast", "event": event, "payload": data},
         )
 
+    async def http_send(
+        self,
+        event: str,
+        payload: Any,
+        timeout: Optional[int] = None,
+    ) -> Dict[str, Union[bool, int, str]]:
+        """
+        Sends a broadcast message explicitly via REST API.
+
+        This method always uses the REST API endpoint regardless of WebSocket connection state.
+        Useful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.
+
+        :param event: The name of the broadcast event
+        :param payload: Payload to be sent (required)
+        :param timeout: Optional timeout in milliseconds
+        :return: Dictionary with success status, and error details if failed
+        :raises ValueError: If payload is None or undefined
+        :raises Exception: If the HTTP request fails
+        """
+        if payload is None:
+            raise ValueError("Payload is required for http_send()")
+
+        authorization = (
+            f"Bearer {self.socket.access_token}" if self.socket.access_token else ""
+        )
+
+        headers = {
+            "Authorization": authorization,
+            "apikey": self.socket.apikey or "",
+            "Content-Type": "application/json",
+        }
+
+        config: RealtimeChannelConfig = self.params["config"]
+        private = config.get("private", False)
+
+        body = {
+            "messages": [
+                {
+                    "topic": self.topic,
+                    "event": event,
+                    "payload": payload,
+                    "private": private,
+                }
+            ]
+        }
+
+        timeout_ms = timeout or self.timeout
+        timeout_seconds = timeout_ms / 1000.0
+
+        try:
+            async with httpx.AsyncClient(timeout=timeout_seconds) as client:
+                response = await client.post(
+                    self.broadcast_endpoint_url,
+                    headers=headers,
+                    json=body,
+                )
+
+                if response.status_code == 202:
+                    return {"success": True}
+
+                error_message = response.reason_phrase
+                try:
+                    error_body = response.json()
+                    error_message = (
+                        error_body.get("error")
+                        or error_body.get("message")
+                        or error_message
+                    )
+                except Exception:
+                    pass
+
+                raise Exception(error_message)
+
+        except httpx.TimeoutException as e:
+            raise Exception(f"Request timeout: {str(e)}")
+        except Exception as e:
+            raise
+
     # Internal methods
 
     async def _resubscribe(self) -> None:
diff --git a/src/realtime/tests/test_http_send.py b/src/realtime/tests/test_http_send.py
@@ -0,0 +1,261 @@
+import os
+from unittest.mock import AsyncMock, patch
+
+import httpx
+import pytest
+from dotenv import load_dotenv
+
+from realtime import AsyncRealtimeChannel, AsyncRealtimeClient
+
+load_dotenv()
+
+URL = os.getenv("SUPABASE_URL") or "http://127.0.0.1:54321"
+ANON_KEY = (
+    os.getenv("SUPABASE_ANON_KEY")
+    or "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0"
+)
+
+
+@pytest.fixture
+def socket() -> AsyncRealtimeClient:
+    url = f"{URL}/realtime/v1"
+    key = ANON_KEY
+    return AsyncRealtimeClient(url, key)
+
+
+def create_mock_response(status_code: int, reason_phrase: str = "OK", body: dict = None):
+    """Create a mock HTTP response."""
+    from unittest.mock import Mock
+
+    mock_response = Mock()
+    mock_response.status_code = status_code
+    mock_response.reason_phrase = reason_phrase
+    if body:
+        mock_response.json = Mock(return_value=body)
+    else:
+        mock_response.json = Mock(side_effect=Exception("No JSON body"))
+    return mock_response
+
+
+@pytest.mark.asyncio
+async def test_http_send_without_access_token():
+    """Test http_send with no access token."""
+    # Create a client without setting access_token
+    url = f"{URL}/realtime/v1"
+    socket_no_token = AsyncRealtimeClient(url, None)
+    channel: AsyncRealtimeChannel = socket_no_token.channel("test-topic")
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response) as mock_post:
+        result = await channel.http_send("test-event", {"data": "test"})
+
+        assert result == {"success": True}
+        assert mock_post.called
+        call_args = mock_post.call_args
+
+        # Verify headers
+        headers = call_args.kwargs["headers"]
+        assert headers["Authorization"] == ""
+        assert headers["apikey"] == ""
+        assert headers["Content-Type"] == "application/json"
+
+        # Verify body
+        body = call_args.kwargs["json"]
+        assert body["messages"][0]["topic"] == "realtime:test-topic"
+        assert body["messages"][0]["event"] == "test-event"
+        assert body["messages"][0]["payload"] == {"data": "test"}
+        assert body["messages"][0]["private"] is False
+
+
+@pytest.mark.asyncio
+async def test_http_send_with_access_token(socket: AsyncRealtimeClient):
+    """Test http_send with access token."""
+    await socket.set_auth("token123")
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response) as mock_post:
+        result = await channel.http_send("test-event", {"data": "test"})
+
+        assert result == {"success": True}
+        assert mock_post.called
+        call_args = mock_post.call_args
+
+        # Verify Authorization header includes token
+        headers = call_args.kwargs["headers"]
+        assert headers["Authorization"] == "Bearer token123"
+        assert headers["apikey"] == ANON_KEY
+
+
+@pytest.mark.asyncio
+async def test_http_send_rejects_when_payload_is_none(socket: AsyncRealtimeClient):
+    """Test http_send raises ValueError when payload is None."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    with pytest.raises(ValueError, match="Payload is required for http_send"):
+        await channel.http_send("test-event", None)
+
+
+@pytest.mark.asyncio
+async def test_http_send_handles_timeout_error(socket: AsyncRealtimeClient):
+    """Test http_send handles timeout errors."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    with patch(
+        "httpx.AsyncClient.post", side_effect=httpx.TimeoutException("Request timeout")
+    ):
+        with pytest.raises(Exception, match="Request timeout"):
+            await channel.http_send("test-event", {"data": "test"})
+
+
+@pytest.mark.asyncio
+async def test_http_send_handles_non_202_status(socket: AsyncRealtimeClient):
+    """Test http_send handles non-202 status codes."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(
+        500, "Internal Server Error", {"error": "Server error"}
+    )
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response):
+        with pytest.raises(Exception, match="Server error"):
+            await channel.http_send("test-event", {"data": "test"})
+
+
+@pytest.mark.asyncio
+async def test_http_send_uses_error_message_from_body(socket: AsyncRealtimeClient):
+    """Test http_send uses error message from response body."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(
+        400, "Bad Request", {"message": "Invalid request"}
+    )
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response):
+        with pytest.raises(Exception, match="Invalid request"):
+            await channel.http_send("test-event", {"data": "test"})
+
+
+@pytest.mark.asyncio
+async def test_http_send_falls_back_to_reason_phrase(socket: AsyncRealtimeClient):
+    """Test http_send falls back to reason phrase when JSON parsing fails."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(503, "Service Unavailable")
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response):
+        with pytest.raises(Exception, match="Service Unavailable"):
+            await channel.http_send("test-event", {"data": "test"})
+
+
+@pytest.mark.asyncio
+async def test_http_send_respects_custom_timeout(socket: AsyncRealtimeClient):
+    """Test http_send respects custom timeout option."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient") as mock_client_class:
+        mock_client = AsyncMock()
+        mock_client.__aenter__.return_value = mock_client
+        mock_client.__aexit__.return_value = None
+        mock_client.post.return_value = mock_response
+        mock_client_class.return_value = mock_client
+
+        await channel.http_send("test-event", {"data": "test"}, timeout=3000)
+
+        # Verify timeout was passed correctly (3000ms = 3.0s)
+        assert mock_client_class.called
+        call_args = mock_client_class.call_args
+        assert call_args.kwargs["timeout"] == 3.0
+
+
+@pytest.mark.asyncio
+async def test_http_send_with_private_channel(socket: AsyncRealtimeClient):
+    """Test http_send with a private channel."""
+    channel: AsyncRealtimeChannel = socket.channel(
+        "test-topic", params={"config": {"private": True}}
+    )
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response) as mock_post:
+        result = await channel.http_send("test-event", {"data": "test"})
+
+        assert result == {"success": True}
+        assert mock_post.called
+
+        # Verify private flag is set
+        body = mock_post.call_args.kwargs["json"]
+        assert body["messages"][0]["private"] is True
+
+
+@pytest.mark.asyncio
+async def test_http_send_uses_default_timeout(socket: AsyncRealtimeClient):
+    """Test http_send uses default timeout when not specified."""
+    socket_with_custom_timeout = AsyncRealtimeClient(
+        f"{URL}/realtime/v1", ANON_KEY, timeout=5000
+    )
+    channel: AsyncRealtimeChannel = socket_with_custom_timeout.channel("test-topic")
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient") as mock_client_class:
+        mock_client = AsyncMock()
+        mock_client.__aenter__.return_value = mock_client
+        mock_client.__aexit__.return_value = None
+        mock_client.post.return_value = mock_response
+        mock_client_class.return_value = mock_client
+
+        await channel.http_send("test-event", {"data": "test"})
+
+        # Verify default timeout was used (5000ms = 5.0s)
+        assert mock_client_class.called
+        call_args = mock_client_class.call_args
+        assert call_args.kwargs["timeout"] == 5.0
+
+
+@pytest.mark.asyncio
+async def test_http_send_sends_correct_payload(socket: AsyncRealtimeClient):
+    """Test http_send sends the correct payload structure."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    mock_response = create_mock_response(202, "Accepted")
+
+    with patch("httpx.AsyncClient.post", return_value=mock_response) as mock_post:
+        test_payload = {"key": "value", "nested": {"data": 123}}
+        result = await channel.http_send("test-payload-event", test_payload)
+
+        assert result == {"success": True}
+        assert mock_post.called
+
+        # Verify the exact payload structure
+        body = mock_post.call_args.kwargs["json"]
+        assert body["messages"][0]["topic"] == "realtime:test-topic"
+        assert body["messages"][0]["event"] == "test-payload-event"
+        assert body["messages"][0]["payload"] == test_payload
+
+
+@pytest.mark.asyncio
+async def test_send_broadcast_shows_warning_when_not_connected(
+    socket: AsyncRealtimeClient, caplog
+):
+    """Test send_broadcast shows deprecation warning when not connected."""
+    channel: AsyncRealtimeChannel = socket.channel("test-topic")
+
+    # Don't connect the socket, so _can_push() returns False
+    # This will trigger the warning
+
+    with pytest.raises(Exception):
+        # send_broadcast will fail because we're not subscribed, but we want to check the warning
+        await channel.send_broadcast("test-event", {"data": "test"})
+
+    # Check that the warning was logged
+    warning_found = any(
+        "falling back to REST API" in record.message
+        for record in caplog.records
+        if record.levelname == "WARNING"
+    )
+    assert warning_found, "Expected deprecation warning was not logged"
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ dependencies = [`
`17`	`17`	`"websockets >=11,<16",`
`18`	`18`	`"typing-extensions >=4.14.0",`
`19`	`19`	`"pydantic (>=2.11.7,<3.0.0)",`
	`20`	`+ "httpx[http2] >=0.26,<0.29",`
`20`	`21`	`]`
`21`	`22`
`22`	`23`	`[project.urls]`