Merge pull request #358 from algoz098/main

feat: allow chrome cdp in env

Author: warmshao

.env.example

@@ -37,7 +37,7 @@ CHROME_DEBUGGING_PORT=9222
 CHROME_DEBUGGING_HOST=localhost
 # Set to true to keep browser open between AI tasks
 CHROME_PERSISTENT_SESSION=false
-
+CHROME_CDP=http://localhost:9222
 # Display settings
 # Format: WIDTHxHEIGHTxDEPTH
 RESOLUTION=1920x1080x24

src/utils/deep_research.py

@@ -44,7 +44,9 @@ async def deep_research(task, llm, agent_state=None, **kwargs):
 
     use_own_browser = kwargs.get("use_own_browser", False)
     extra_chromium_args = []
+    cdp_url = kwargs.get("chrome_cdp", None)
     if use_own_browser:
+        cdp_url = os.getenv("CHROME_CDP", kwargs.get("chrome_cdp", None))
         # TODO: if use own browser, max query num must be 1 per iter, how to solve it?
         max_query_num = 1
         chrome_path = os.getenv("CHROME_PATH", None)
@@ -57,6 +59,7 @@ async def deep_research(task, llm, agent_state=None, **kwargs):
         browser = CustomBrowser(
             config=BrowserConfig(
                 headless=kwargs.get("headless", False),
+                cdp_url=cdp_url,
                 disable_security=kwargs.get("disable_security", True),
                 chrome_instance_path=chrome_path,
                 extra_chromium_args=extra_chromium_args,

webui.py

@@ -143,7 +143,8 @@ async def run_browser_agent(
         max_steps,
         use_vision,
         max_actions_per_step,
-        tool_calling_method
+        tool_calling_method,
+        chrome_cdp
 ):
     global _global_agent_state
     _global_agent_state.clear_stop()  # Clear any previous stop requests
@@ -192,7 +193,8 @@ async def run_browser_agent(
                 max_steps=max_steps,
                 use_vision=use_vision,
                 max_actions_per_step=max_actions_per_step,
-                tool_calling_method=tool_calling_method
+                tool_calling_method=tool_calling_method,
+                chrome_cdp=chrome_cdp
             )
         elif agent_type == "custom":
             final_result, errors, model_actions, model_thoughts, trace_file, history_file = await run_custom_agent(
@@ -211,7 +213,8 @@ async def run_browser_agent(
                 max_steps=max_steps,
                 use_vision=use_vision,
                 max_actions_per_step=max_actions_per_step,
-                tool_calling_method=tool_calling_method
+                tool_calling_method=tool_calling_method,
+                chrome_cdp=chrome_cdp
             )
         else:
             raise ValueError(f"Invalid agent type: {agent_type}")
@@ -273,7 +276,8 @@ async def run_org_agent(
         max_steps,
         use_vision,
         max_actions_per_step,
-        tool_calling_method
+        tool_calling_method,
+        chrome_cdp
 ):
     try:
         global _global_browser, _global_browser_context, _global_agent_state, _global_agent
@@ -282,7 +286,10 @@ async def run_org_agent(
         _global_agent_state.clear_stop()
 
         extra_chromium_args = [f"--window-size={window_w},{window_h}"]
+        cdp_url = chrome_cdp
+
         if use_own_browser:
+            cdp_url = os.getenv("CHROME_CDP", chrome_cdp)
             chrome_path = os.getenv("CHROME_PATH", None)
             if chrome_path == "":
                 chrome_path = None
@@ -293,9 +300,11 @@ async def run_org_agent(
             chrome_path = None
 
         if _global_browser is None:
+
             _global_browser = Browser(
                 config=BrowserConfig(
                     headless=headless,
+                    cdp_url=cdp_url,
                     disable_security=disable_security,
                     chrome_instance_path=chrome_path,
                     extra_chromium_args=extra_chromium_args,
@@ -307,6 +316,7 @@ async def run_org_agent(
                 config=BrowserContextConfig(
                     trace_path=save_trace_path if save_trace_path else None,
                     save_recording_path=save_recording_path if save_recording_path else None,
+                    cdp_url=cdp_url,
                     no_viewport=False,
                     browser_window_size=BrowserContextWindowSize(
                         width=window_w, height=window_h
@@ -370,7 +380,8 @@ async def run_custom_agent(
         max_steps,
         use_vision,
         max_actions_per_step,
-        tool_calling_method
+        tool_calling_method,
+        chrome_cdp
 ):
     try:
         global _global_browser, _global_browser_context, _global_agent_state, _global_agent
@@ -379,7 +390,10 @@ async def run_custom_agent(
         _global_agent_state.clear_stop()
 
         extra_chromium_args = [f"--window-size={window_w},{window_h}"]
+        cdp_url = chrome_cdp
         if use_own_browser:
+            cdp_url = os.getenv("CHROME_CDP", chrome_cdp)
+
             chrome_path = os.getenv("CHROME_PATH", None)
             if chrome_path == "":
                 chrome_path = None
@@ -392,17 +406,19 @@ async def run_custom_agent(
         controller = CustomController()
 
         # Initialize global browser if needed
-        if _global_browser is None:
+        #if chrome_cdp not empty string nor None
+        if ((_global_browser is None) or (cdp_url and cdp_url != "" and cdp_url != None)) :
             _global_browser = CustomBrowser(
                 config=BrowserConfig(
                     headless=headless,
                     disable_security=disable_security,
+                    cdp_url=cdp_url,
                     chrome_instance_path=chrome_path,
                     extra_chromium_args=extra_chromium_args,
                 )
             )
 
-        if _global_browser_context is None:
+        if (_global_browser_context is None  or (chrome_cdp and cdp_url != "" and cdp_url != None)):
             _global_browser_context = await _global_browser.new_context(
                 config=BrowserContextConfig(
                     trace_path=save_trace_path if save_trace_path else None,
@@ -413,7 +429,8 @@ async def run_custom_agent(
                     ),
                 )
             )
-            
+
+
         # Create and run agent
         if _global_agent is None:
             _global_agent = CustomAgent(
@@ -482,7 +499,8 @@ async def run_with_stream(
     max_steps,
     use_vision,
     max_actions_per_step,
-    tool_calling_method
+    tool_calling_method,
+    chrome_cdp
 ):
     global _global_agent_state
     stream_vw = 80
@@ -511,7 +529,8 @@ async def run_with_stream(
             max_steps=max_steps,
             use_vision=use_vision,
             max_actions_per_step=max_actions_per_step,
-            tool_calling_method=tool_calling_method
+            tool_calling_method=tool_calling_method,
+            chrome_cdp=chrome_cdp
         )
         # Add HTML content at the start of the result array
         html_content = f"<h1 style='width:{stream_vw}vw; height:{stream_vh}vh'>Using browser...</h1>"
@@ -544,7 +563,8 @@ async def run_with_stream(
                     max_steps=max_steps,
                     use_vision=use_vision,
                     max_actions_per_step=max_actions_per_step,
-                    tool_calling_method=tool_calling_method
+                    tool_calling_method=tool_calling_method,
+                    chrome_cdp=chrome_cdp
                 )
             )
 
@@ -658,7 +678,7 @@ async def close_global_browser():
         await _global_browser.close()
         _global_browser = None
 
-async def run_deep_search(research_task, max_search_iteration_input, max_query_per_iter_input, llm_provider, llm_model_name, llm_num_ctx, llm_temperature, llm_base_url, llm_api_key, use_vision, use_own_browser, headless):
+async def run_deep_search(research_task, max_search_iteration_input, max_query_per_iter_input, llm_provider, llm_model_name, llm_num_ctx, llm_temperature, llm_base_url, llm_api_key, use_vision, use_own_browser, headless, chrome_cdp):
     from src.utils.deep_research import deep_research
     global _global_agent_state
 
@@ -678,7 +698,8 @@ async def run_deep_search(research_task, max_search_iteration_input, max_query_p
                                                         max_query_num=max_query_per_iter_input,
                                                         use_vision=use_vision,
                                                         headless=headless,
-                                                        use_own_browser=use_own_browser
+                                                        use_own_browser=use_own_browser,
+                                                        chrome_cdp=chrome_cdp
                                                         )
 
     return markdown_content, file_path, gr.update(value="Stop", interactive=True),  gr.update(interactive=True) 
@@ -854,6 +875,23 @@ def update_llm_num_ctx_visibility(llm_provider):
                             info="Browser window height",
                         )
 
+
+                    save_recording_path = gr.Textbox(
+                        label="Recording Path",
+                        placeholder="e.g. ./tmp/record_videos",
+                        value=config['save_recording_path'],
+                        info="Path to save browser recordings",
+                        interactive=True,  # Allow editing only if recording is enabled
+                    )
+
+                    chrome_cdp = gr.Textbox(
+                        label="CDP URL",
+                        placeholder="http://localhost:9222",
+                        value="",
+                        info="CDP for google remote debugging",
+                        interactive=True,  # Allow editing only if recording is enabled
+                    )
+
                     save_recording_path = gr.Textbox(
                         label="Recording Path",
                         placeholder="e.g. ./tmp/record_videos",
@@ -958,7 +996,7 @@ def update_llm_num_ctx_visibility(llm_provider):
                             agent_type, llm_provider, llm_model_name, llm_num_ctx, llm_temperature, llm_base_url, llm_api_key,
                             use_own_browser, keep_browser_open, headless, disable_security, window_w, window_h,
                             save_recording_path, save_agent_history_path, save_trace_path,  # Include the new path
-                            enable_recording, task, add_infos, max_steps, use_vision, max_actions_per_step, tool_calling_method
+                            enable_recording, task, add_infos, max_steps, use_vision, max_actions_per_step, tool_calling_method, chrome_cdp
                         ],
                     outputs=[
                         browser_view,           # Browser view
@@ -977,7 +1015,7 @@ def update_llm_num_ctx_visibility(llm_provider):
                 # Run Deep Research
                 research_button.click(
                         fn=run_deep_search,
-                        inputs=[research_task_input, max_search_iteration_input, max_query_per_iter_input, llm_provider, llm_model_name, llm_num_ctx, llm_temperature, llm_base_url, llm_api_key, use_vision, use_own_browser, headless],
+                        inputs=[research_task_input, max_search_iteration_input, max_query_per_iter_input, llm_provider, llm_model_name, llm_num_ctx, llm_temperature, llm_base_url, llm_api_key, use_vision, use_own_browser, headless, chrome_cdp],
                         outputs=[markdown_output_display, markdown_download, stop_research_button, research_button]
                 )
                 # Bind the stop button click event after errors_output is defined