Merge pull request #125 from livechat/API-13060/Configurable_timeouts

Enhanced timeouts for the WebsocketClient

changelog.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 ### Changed
 - Updated outdated packages.
 - Enhanced error logging for improved troubleshooting: Automatically includes response headers in the log for server errors, providing detailed information (such as x-debug-id) for more effective issue diagnosis.
+- Enhanced timeouts for the RTM and WEB clients.
 
 ### Bugfixes
 - Enabled instantiation for `CustomerRtmV36` within the 3.6 version of the Customer RTM API.

livechat/agent/rtm/api/v33.py

@@ -14,9 +14,26 @@ class AgentRtmV33:
     def __init__(self, url: str):
         self.ws = WebsocketClient(url=f'wss://{url}/v3.3/agent/rtm/ws')
 
-    def open_connection(self) -> None:
-        ''' Opens WebSocket connection. '''
-        self.ws.open()
+    def open_connection(self,
+                        origin: dict = None,
+                        ping_timeout: float = 3,
+                        ping_interval: float = 5,
+                        ws_conn_timeout: float = 10,
+                        keep_alive: bool = True) -> None:
+        ''' Opens WebSocket connection.
+
+            Args:
+                origin (dict): Specifies origin while creating websocket connection.
+                ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
+                    by default sets to 3 seconds.
+                ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
+                    If set to 0, no ping is sent periodically, by default sets to 5 seconds.
+                ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
+                    by default sets to 10 seconds.
+                keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+        '''
+        self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
+                     keep_alive)
 
     def close_connection(self) -> None:
         ''' Closes WebSocket connection. '''
@@ -378,7 +395,11 @@ def send_event(self,
             opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,

livechat/agent/rtm/api/v34.py

@@ -14,9 +14,26 @@ class AgentRtmV34:
     def __init__(self, url: str):
         self.ws = WebsocketClient(url=f'wss://{url}/v3.4/agent/rtm/ws')
 
-    def open_connection(self) -> None:
-        ''' Opens WebSocket connection. '''
-        self.ws.open()
+    def open_connection(self,
+                        origin: dict = None,
+                        ping_timeout: float = 3,
+                        ping_interval: float = 5,
+                        ws_conn_timeout: float = 10,
+                        keep_alive: bool = True) -> None:
+        ''' Opens WebSocket connection.
+
+            Args:
+                origin (dict): Specifies origin while creating websocket connection.
+                ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
+                    by default sets to 3 seconds.
+                ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
+                    If set to 0, no ping is sent periodically, by default sets to 5 seconds.
+                ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
+                    by default sets to 10 seconds.
+                keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+        '''
+        self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
+                     keep_alive)
 
     def close_connection(self) -> None:
         ''' Closes WebSocket connection. '''
@@ -344,7 +361,11 @@ def send_event(self,
             opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,

livechat/agent/rtm/api/v35.py

@@ -14,9 +14,26 @@ class AgentRtmV35:
     def __init__(self, url: str):
         self.ws = WebsocketClient(url=f'wss://{url}/v3.5/agent/rtm/ws')
 
-    def open_connection(self) -> None:
-        ''' Opens WebSocket connection. '''
-        self.ws.open()
+    def open_connection(self,
+                        origin: dict = None,
+                        ping_timeout: float = 3,
+                        ping_interval: float = 5,
+                        ws_conn_timeout: float = 10,
+                        keep_alive: bool = True) -> None:
+        ''' Opens WebSocket connection.
+
+            Args:
+                origin (dict): Specifies origin while creating websocket connection.
+                ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
+                    by default sets to 3 seconds.
+                ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
+                    If set to 0, no ping is sent periodically, by default sets to 5 seconds.
+                ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
+                    by default sets to 10 seconds.
+                keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+        '''
+        self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
+                     keep_alive)
 
     def close_connection(self) -> None:
         ''' Closes WebSocket connection. '''
@@ -344,7 +361,11 @@ def send_event(self,
             opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,

livechat/agent/rtm/api/v36.py

@@ -14,9 +14,26 @@ class AgentRtmV36:
     def __init__(self, url: str):
         self.ws = WebsocketClient(url=f'wss://{url}/v3.6/agent/rtm/ws')
 
-    def open_connection(self) -> None:
-        ''' Opens WebSocket connection. '''
-        self.ws.open()
+    def open_connection(self,
+                        origin: dict = None,
+                        ping_timeout: float = 3,
+                        ping_interval: float = 5,
+                        ws_conn_timeout: float = 10,
+                        keep_alive: bool = True) -> None:
+        ''' Opens WebSocket connection.
+
+            Args:
+                origin (dict): Specifies origin while creating websocket connection.
+                ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
+                    by default sets to 3 seconds.
+                ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
+                    If set to 0, no ping is sent periodically, by default sets to 5 seconds.
+                ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
+                    by default sets to 10 seconds.
+                keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+        '''
+        self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
+                     keep_alive)
 
     def close_connection(self) -> None:
         ''' Closes WebSocket connection. '''

livechat/agent/web/api/v33.py

@@ -19,9 +19,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(access_token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.3/agent/action'
 
     # Chats

livechat/agent/web/api/v34.py

@@ -21,9 +21,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(access_token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.4/agent/action'
 
     # Chats

livechat/agent/web/api/v35.py

@@ -21,9 +21,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(access_token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.5/agent/action'
 
     # Chats

livechat/agent/web/api/v36.py

@@ -21,9 +21,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(access_token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.6/agent/action'
 
     # Chats

livechat/agent/web/base.py

@@ -5,6 +5,8 @@
 
 from typing import Union
 
+import httpx
+
 from livechat.agent.web.api.v33 import AgentWebV33
 from livechat.agent.web.api.v34 import AgentWebV34
 from livechat.agent.web.api.v35 import AgentWebV35
@@ -27,6 +29,7 @@ def get_client(
         proxies: dict = None,
         verify: bool = True,
         disable_logging: bool = False,
+        timeout: float = httpx.Timeout(15)
     ) -> Union[AgentWebV33, AgentWebV34, AgentWebV35, AgentWebV36]:
         ''' Returns client for specific API version.
 
@@ -43,6 +46,8 @@ def get_client(
                                a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                                (which will disable verification). Defaults to `True`.
                 disable_logging (bool): indicates if logging should be disabled.
+                timeout (float): The timeout configuration to use when sending requests.
+                                 Defaults to 15 seconds.
 
             Returns:
                 API client object for specified version.
@@ -53,16 +58,16 @@ def get_client(
         client = {
             '3.3':
             AgentWebV33(access_token, base_url, http2, proxies, verify,
-                        disable_logging),
+                        disable_logging, timeout),
             '3.4':
             AgentWebV34(access_token, base_url, http2, proxies, verify,
-                        disable_logging),
+                        disable_logging, timeout),
             '3.5':
             AgentWebV35(access_token, base_url, http2, proxies, verify,
-                        disable_logging),
+                        disable_logging, timeout),
             '3.6':
             AgentWebV36(access_token, base_url, http2, proxies, verify,
-                        disable_logging),
+                        disable_logging, timeout),
         }.get(version)
         if not client:
             raise ValueError('Provided version does not exist.')

livechat/billing/api/v1.py

@@ -14,9 +14,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v1'
 
     # direct_charge

livechat/billing/base.py

@@ -5,6 +5,8 @@
 
 from __future__ import annotations
 
+import httpx
+
 from livechat.config import CONFIG
 
 from .api import BillingApiV1
@@ -25,6 +27,7 @@ def get_client(
         proxies: dict = None,
         verify: bool = True,
         disable_logging: bool = False,
+        timeout: float = httpx.Timeout(15)
     ) -> BillingApiV1:
         ''' Returns client for specific Billing API version.
 
@@ -41,6 +44,8 @@ def get_client(
                                a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                                (which will disable verification). Defaults to `True`.
                 disable_logging (bool): indicates if logging should be disabled.
+                timeout (float): The timeout configuration to use when sending requests.
+                                 Defaults to 15 seconds.
 
             Returns:
                 BillingApi: API client object for specified version.
@@ -51,7 +56,7 @@ def get_client(
         client = {
             '1':
             BillingApiV1(token, base_url, http2, proxies, verify,
-                         disable_logging),
+                         disable_logging, timeout),
         }.get(version)
         if not client:
             raise ValueError('Provided version does not exist.')

livechat/configuration/api/v33.py

@@ -14,9 +14,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.3/configuration/action'
 
 # Agents

livechat/configuration/api/v34.py

@@ -14,9 +14,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.4/configuration/action'
 
 # Agents

livechat/configuration/api/v35.py

@@ -16,9 +16,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.5/configuration/action'
 
 # Agents

livechat/configuration/api/v36.py

@@ -18,9 +18,10 @@ def __init__(self,
                  http2: bool,
                  proxies=None,
                  verify: bool = True,
-                 disable_logging: bool = False):
+                 disable_logging: bool = False,
+                 timeout: float = httpx.Timeout(15)):
         super().__init__(token, base_url, http2, proxies, verify,
-                         disable_logging)
+                         disable_logging, timeout)
         self.api_url = f'https://{base_url}/v3.6/configuration/action'
 
 # Agents