Merge pull request #195 from j0j1j2/feat/verify-timeout

Add start_timeout property in ChromiumOptions

Author: thalissonvs

README.md

@@ -188,6 +188,7 @@ async def custom_automation():
     options.add_argument('--proxy-server=username:password@ip:port')
     options.add_argument('--window-size=1920,1080')
     options.binary_location = '/path/to/your/browser'
+    options.start_timeout = 20
 
     async with Chrome(options=options) as browser:
         tab = await browser.start()
@@ -311,6 +312,17 @@ options.binary_location = '/path/to/your/chrome'
 browser = Chrome(options=options)
 ```
 
+**Browser starts after a FailedToStartBrowser error?**
+```python
+from pydoll.browser import Chrome
+from pydoll.browser.options import ChromiumOptions
+
+options = ChromiumOptions()
+options.start_timeout = 20  # default is 10 seconds
+
+browser = Chrome(options=options)
+```
+
 **Need a proxy?**
 ```python
 options.add_argument('--proxy-server=your-proxy:port')

pydoll/browser/chromium/base.py

@@ -509,7 +509,7 @@ async def _verify_browser_running(self):
         Raises:
             FailedToStartBrowser: If the browser failed to start.
         """
-        if not await self._is_browser_running():
+        if not await self._is_browser_running(self.options.start_timeout):
             raise FailedToStartBrowser()
 
     async def _configure_proxy(

pydoll/browser/interfaces.py

@@ -12,6 +12,11 @@ def arguments(self) -> list[str]:
     def binary_location(self) -> str:
         pass
 
+    @property
+    @abstractmethod
+    def start_timeout(self) -> int:
+        pass
+
     @abstractmethod
     def add_argument(self, argument: str):
         pass

pydoll/browser/options.py

@@ -19,6 +19,7 @@ def __init__(self):
         """
         self._arguments = []
         self._binary_location = ''
+        self._start_timeout = 10
 
     @property
     def arguments(self) -> list[str]:
@@ -60,6 +61,26 @@ def binary_location(self, location: str):
         """
         self._binary_location = location
 
+    @property
+    def start_timeout(self) -> int:
+        """
+        Gets the timeout to verify the browser's running state.
+
+        Returns:
+            int: The timeout in seconds.
+        """
+        return self._start_timeout
+
+    @start_timeout.setter
+    def start_timeout(self, timeout: int):
+        """
+        Sets the timeout to verify the browser's running state.
+
+        Args:
+            timeout (int): The timeout in seconds.
+        """
+        self._start_timeout = timeout
+
     def add_argument(self, argument: str):
         """
         Adds a command-line argument to the options.

tests/test_browser/test_browser_base.py

@@ -1,3 +1,4 @@
+import asyncio
 import base64
 from unittest.mock import ANY, AsyncMock, MagicMock, patch
 
@@ -110,6 +111,53 @@ async def test_start_browser_failure(mock_browser):
         with pytest.raises(exceptions.FailedToStartBrowser):
             await mock_browser.start()
 
+@pytest.mark.asyncio 
+async def test_start_browser_failure_with_start_timeout(mock_browser):
+    browser_launched = False 
+
+    async def launch_browser_later():
+        nonlocal browser_launched
+        await asyncio.sleep(2)
+        browser_launched = True
+
+    def start_browser_process_side_effect(*args, **kwargs):
+        asyncio.create_task(launch_browser_later())
+
+    async def ping_side_effect():
+        nonlocal browser_launched
+        return browser_launched
+    
+    mock_browser.options.start_timeout = 1
+    mock_browser._get_valid_tab_id = AsyncMock(return_value='page1')
+    mock_browser._browser_process_manager.start_browser_process.side_effect = start_browser_process_side_effect
+    mock_browser._connection_handler.ping =  AsyncMock(side_effect=ping_side_effect)
+
+    with pytest.raises(exceptions.FailedToStartBrowser):
+        await mock_browser.start()
+
+@pytest.mark.asyncio 
+async def test_start_browser_success_with_start_timeout(mock_browser):
+    browser_launched = False 
+
+    async def launch_browser_later():
+        nonlocal browser_launched
+        await asyncio.sleep(2)
+        browser_launched = True
+
+    def start_browser_process_side_effect(*args, **kwargs):
+        asyncio.create_task(launch_browser_later())
+
+    async def ping_side_effect():
+        nonlocal browser_launched
+        return browser_launched
+    
+    mock_browser.options.start_timeout = 3
+    mock_browser._get_valid_tab_id = AsyncMock(return_value='page1')
+    mock_browser._browser_process_manager.start_browser_process.side_effect = start_browser_process_side_effect
+    mock_browser._connection_handler.ping =  AsyncMock(side_effect=ping_side_effect)
+
+    await mock_browser.start()
+
 @pytest.mark.asyncio
 async def test_proxy_configuration(mock_browser):
     mock_browser._proxy_manager.get_proxy_credentials = MagicMock(

tests/test_browser/test_browser_options.py

@@ -19,6 +19,10 @@ def test_set_binary_location():
     options.binary_location = '/path/to/browser'
     assert options.binary_location == '/path/to/browser'
 
+def test_set_start_timeout():
+    options = Options() 
+    options.start_timeout = 30 
+    assert options.start_timeout == 30 
 
 def test_add_argument():
     options = Options()