-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy path_bridge.py
More file actions
379 lines (313 loc) · 13.5 KB
/
_bridge.py
File metadata and controls
379 lines (313 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
"""Chat bridge implementations for conversational agents."""
import asyncio
import json
import logging
import os
import uuid
from typing import Any
from urllib.parse import urlparse
from uipath.core.chat import (
UiPathConversationEvent,
UiPathConversationExchangeEndEvent,
UiPathConversationExchangeEvent,
UiPathConversationInterruptEvent,
UiPathConversationInterruptStartEvent,
UiPathConversationMessageEvent,
)
from uipath.runtime import UiPathRuntimeResult
from uipath.runtime.chat import UiPathChatProtocol
from uipath.runtime.context import UiPathRuntimeContext
logger = logging.getLogger(__name__)
class SocketIOChatBridge:
"""WebSocket-based chat bridge for streaming conversational events to CAS.
Implements UiPathChatBridgeProtocol using python-socketio library.
"""
def __init__(
self,
websocket_url: str,
websocket_path: str,
conversation_id: str,
exchange_id: str,
headers: dict[str, str],
auth: dict[str, Any] | None = None,
):
"""Initialize the WebSocket chat bridge.
Args:
websocket_url: The WebSocket server URL to connect to
conversation_id: The conversation ID for this session
exchange_id: The exchange ID for this session
headers: HTTP headers to send during connection
auth: Optional authentication data to send during connection
"""
self.websocket_url = websocket_url
self.websocket_path = websocket_path
self.conversation_id = conversation_id
self.exchange_id = exchange_id
self.auth = auth
self.headers = headers
self._client: Any | None = None
self._connected_event = asyncio.Event()
# Set CAS_WEBSOCKET_DISABLED when using the debugger to prevent websocket errors from
# interrupting the debugging session. Events will be logged instead of being sent.
self._websocket_disabled = os.environ.get("CAS_WEBSOCKET_DISABLED") == "true"
async def connect(self, timeout: float = 10.0) -> None:
"""Establish WebSocket connection to the server.
Args:
timeout: Connection timeout in seconds (default: 10.0)
Raises:
RuntimeError: If connection fails or times out
Example:
```python
manager = WebSocketManager("http://localhost:3000")
await manager.connect()
```
"""
if self._client is not None:
logger.warning("WebSocket client already connected")
return
# Create new SocketIO client
# Lazy import to avoid dependency if not used, improve startup time
from socketio import AsyncClient # type: ignore[import-untyped]
self._client = AsyncClient(
logger=logger,
engineio_logger=logger,
)
# Register connection event handlers
self._client.on("connect", self._handle_connect)
self._client.on("disconnect", self._handle_disconnect)
self._client.on("connect_error", self._handle_connect_error)
self._client.on("ConversationEvent", self._handle_conversation_event)
self._connected_event.clear()
if self._websocket_disabled:
logger.warning(
"SocketIOChatBridge is in debug mode. Not connecting websocket."
)
else:
try:
# Attempt to connect with timeout
await asyncio.wait_for(
self._client.connect(
url=self.websocket_url,
socketio_path=self.websocket_path,
headers=self.headers,
auth=self.auth,
transports=["websocket"],
),
timeout=timeout,
)
await asyncio.wait_for(self._connected_event.wait(), timeout=timeout)
except asyncio.TimeoutError as e:
error_message = (
f"Failed to connect to WebSocket server within {timeout}s timeout"
)
logger.error(error_message)
await self._cleanup_client()
raise RuntimeError(error_message) from e
except Exception as e:
error_message = f"Failed to connect to WebSocket server: {e}"
logger.error(error_message)
await self._cleanup_client()
raise RuntimeError(error_message) from e
async def disconnect(self) -> None:
"""Close the WebSocket connection gracefully.
Sends an exchange end event before disconnecting to signal that the
exchange is complete. Uses stored conversation/exchange IDs.
"""
if self._client is None:
logger.warning("WebSocket client not connected")
return
try:
await self._client.disconnect()
except Exception as e:
logger.error(f"Error during WebSocket disconnect: {e}")
finally:
await self._cleanup_client()
async def emit_message_event(
self, message_event: UiPathConversationMessageEvent
) -> None:
"""Wrap and send a message event to the WebSocket server.
Args:
message_event: UiPathConversationMessageEvent to wrap and send
Raises:
RuntimeError: If client is not connected
"""
if self._client is None:
raise RuntimeError("WebSocket client not connected. Call connect() first.")
if not self._connected_event.is_set() and not self._websocket_disabled:
raise RuntimeError("WebSocket client not in connected state")
try:
# Wrap message event with conversation/exchange IDs
wrapped_event = UiPathConversationEvent(
conversation_id=self.conversation_id,
exchange=UiPathConversationExchangeEvent(
exchange_id=self.exchange_id,
message=message_event,
),
)
event_data = wrapped_event.model_dump(
mode="json", exclude_none=True, by_alias=True
)
if self._websocket_disabled:
logger.info(
f"SocketIOChatBridge is in debug mode. Not sending event: {json.dumps(event_data)}"
)
else:
await self._client.emit("ConversationEvent", event_data)
# Store the current message ID, used for emitting interrupt events.
self._current_message_id = message_event.message_id
except Exception as e:
logger.error(f"Error sending conversation event to WebSocket: {e}")
raise RuntimeError(f"Failed to send conversation event: {e}") from e
async def emit_exchange_end_event(self) -> None:
"""Send an exchange end event.
Raises:
RuntimeError: If client is not connected
"""
if self._client is None:
raise RuntimeError("WebSocket client not connected. Call connect() first.")
if not self._connected_event.is_set() and not self._websocket_disabled:
raise RuntimeError("WebSocket client not in connected state")
try:
exchange_end_event = UiPathConversationEvent(
conversation_id=self.conversation_id,
exchange=UiPathConversationExchangeEvent(
exchange_id=self.exchange_id,
end=UiPathConversationExchangeEndEvent(),
),
)
event_data = exchange_end_event.model_dump(
mode="json", exclude_none=True, by_alias=True
)
if self._websocket_disabled:
logger.info(
f"SocketIOChatBridge is in debug mode. Not sending event: {json.dumps(event_data)}"
)
else:
await self._client.emit("ConversationEvent", event_data)
except Exception as e:
logger.error(f"Error sending conversation event to WebSocket: {e}")
raise RuntimeError(f"Failed to send conversation event: {e}") from e
async def emit_interrupt_event(self, runtime_result: UiPathRuntimeResult):
if self._client and self._connected_event.is_set():
try:
self._interrupt_id = str(uuid.uuid4())
interrupt_event = UiPathConversationEvent(
conversation_id=self.conversation_id,
exchange=UiPathConversationExchangeEvent(
exchange_id=self.exchange_id,
message=UiPathConversationMessageEvent(
message_id=self._current_message_id,
interrupt=UiPathConversationInterruptEvent(
interrupt_id=self._interrupt_id,
start=UiPathConversationInterruptStartEvent(
type="coded-agent-interrupt",
value=runtime_result.output,
),
),
),
),
)
event_data = interrupt_event.model_dump(
mode="json", exclude_none=True, by_alias=True
)
if self._websocket_disabled:
logger.info(
f"SocketIOChatBridge is in debug mode. Not sending event: {json.dumps(event_data)}"
)
else:
await self._client.emit("ConversationEvent", event_data)
except Exception as e:
logger.warning(f"Error sending interrupt event: {e}")
async def wait_for_resume(self) -> dict[str, Any]:
"""Wait for the interrupt_end event to be received.
Returns:
Resume data from the interrupt end event
"""
return {}
@property
def is_connected(self) -> bool:
"""Check if the WebSocket is currently connected.
Returns:
True if connected, False otherwise
"""
return self._client is not None and self._connected_event.is_set()
async def _handle_connect(self) -> None:
"""Handle successful connection event."""
logger.info("WebSocket connection established")
self._connected_event.set()
async def _handle_disconnect(self) -> None:
"""Handle disconnection event."""
logger.info("WebSocket connection closed")
self._connected_event.clear()
async def _handle_connect_error(self, data: Any) -> None:
"""Handle connection error event."""
logger.error(f"WebSocket connection error: {data}")
async def _handle_conversation_event(
self, event: dict[str, Any], _sid: str
) -> None:
"""Handle received ConversationEvent events."""
error_event = event.get("conversationError")
if error_event:
logger.error(f"Conversation error: {json.dumps(error_event)}")
async def _cleanup_client(self) -> None:
"""Clean up client resources."""
self._connected_event.clear()
self._client = None
def get_chat_bridge(
context: UiPathRuntimeContext,
) -> UiPathChatProtocol:
"""Factory to get WebSocket chat bridge for conversational agents.
Args:
context: The runtime context containing environment configuration
conversation_id: The conversation ID for this session
exchange_id: The exchange ID for this session
Returns:
WebSocketChatBridge instance configured for CAS
Raises:
RuntimeError: If UIPATH_URL is not set or invalid
Example:
```python
bridge = get_chat_bridge(context, "conv-123", "exch-456")
await bridge.connect()
await bridge.emit_message_event(message_event)
await bridge.disconnect(conversation_id, exchange_id)
```
"""
assert context.conversation_id is not None, "conversation_id must be set in context"
assert context.exchange_id is not None, "exchange_id must be set in context"
# Extract host from UIPATH_URL
base_url = os.environ.get("UIPATH_URL")
if not base_url:
raise RuntimeError(
"UIPATH_URL environment variable required for conversational mode"
)
parsed = urlparse(base_url)
if not parsed.netloc:
raise RuntimeError(f"Invalid UIPATH_URL format: {base_url}")
host = parsed.netloc
# Construct WebSocket URL for CAS
websocket_url = f"wss://{host}?conversationId={context.conversation_id}"
websocket_path = "autopilotforeveryone_/websocket_/socket.io"
if os.environ.get("CAS_WEBSOCKET_HOST"):
websocket_url = f"ws://{os.environ.get('CAS_WEBSOCKET_HOST')}?conversationId={context.conversation_id}"
websocket_path = "/socket.io"
logger.warning(
f"CAS_WEBSOCKET_HOST is set. Using websocket_url '{websocket_url}{websocket_path}'."
)
# Build headers from context
headers = {
"Authorization": f"Bearer {os.environ.get('UIPATH_ACCESS_TOKEN', '')}",
"X-UiPath-Internal-TenantId": f"{context.tenant_id}"
or os.environ.get("UIPATH_TENANT_ID", ""),
"X-UiPath-Internal-AccountId": f"{context.org_id}"
or os.environ.get("UIPATH_ORGANIZATION_ID", ""),
"X-UiPath-ConversationId": context.conversation_id,
}
return SocketIOChatBridge(
websocket_url=websocket_url,
websocket_path=websocket_path,
conversation_id=context.conversation_id,
exchange_id=context.exchange_id,
headers=headers,
)
__all__ = ["get_chat_bridge"]