feat(browser-api): enhance WebSocket URL generation with header support by OhYee · Pull Request #78 · Serverless-Devs/agentrun-sdk-python

OhYee · 2026-04-01T09:20:30Z

Add overloads to get_cdp_url and get_vnc_url methods to support returning authentication headers along with URLs. Introduce Config parameter for optional configuration overrides and improve URL assembly logic with proper tenant ID and recording parameters.

The changes provide backward compatibility while enabling header-based authentication for WebSocket connections.

feat(browser-api): 增强WebSocket URL生成以支持头部信息

为get_cdp_url和get_vnc_url方法添加重载以支持返回认证头部与URL。
引入Config参数用于可选配置覆盖，并改进URL组装逻辑，包含适当的租户ID和录制参数。

这些更改提供向后兼容性，同时启用基于头部的WebSocket连接认证。

Change-Id: Id927aa50801374160670c13b8a4dfab37d302ad9

Thank you for creating a pull request to contribute to Serverless Devs agentrun-sdk-python code! Before you open the request please answer the following questions to help it be more easily integrated. Please check the boxes "[ ]" with "[x]" when done too.
Please select one of the PR types below to complete

Fix bugs

Bug detail

The specific manifestation of the bug or the associated issue.

Pull request tasks

Add test cases for the changes
Passed the CI test

Update docs

Reason for update

Why do you need to update your documentation?

Pull request tasks

Update Chinese documentation
Update English documentation

Add contributor

Contributed content

Code
Document

Content detail

if content_type == 'code' || content_type == 'document':
    please tell us `PR url`，like: https://github.com/Serverless-Devs/agentrun-sdk-python/pull/1
else:
    please describe your contribution in detail

Others

Reason for update

Why do you need to update your documentation?

Add overloads to get_cdp_url and get_vnc_url methods to support returning authentication headers along with URLs. Introduce Config parameter for optional configuration overrides and improve URL assembly logic with proper tenant ID and recording parameters. The changes provide backward compatibility while enabling header-based authentication for WebSocket connections. feat(browser-api): 增强WebSocket URL生成以支持头部信息为get_cdp_url和get_vnc_url方法添加重载以支持返回认证头部与URL。引入Config参数用于可选配置覆盖，并改进URL组装逻辑，包含适当的租户ID和录制参数。这些更改提供向后兼容性，同时启用基于头部的WebSocket连接认证。 Change-Id: Id927aa50801374160670c13b8a4dfab37d302ad9 Signed-off-by: OhYee <oyohyee@oyohyee.com>

Copilot

Pull request overview

This PR enhances the Python SDK’s browser-related WebSocket URL helpers to optionally return authentication headers alongside the URL, and refactors URL assembly to consistently include tenantId and optional recording=true query parameters while maintaining backward-compatible return types.

Changes:

Added with_headers overloads to get_cdp_url / get_vnc_url across sandbox high-level APIs and data APIs (returning either str or (url, headers)).
Refactored WebSocket URL construction into shared helpers and updated Playwright helpers to reuse the header-producing path.
Updated CustomSandbox.get_base_url() to return a non--ram endpoint URL and refreshed unit tests accordingly.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
agentrun/sandbox/api/browser_data.py	Refactors WS URL building; adds `with_headers` overloads returning `(url, headers)`
agentrun/sandbox/api/aio_data.py	Same WS URL/header overload changes for AIO data API
agentrun/sandbox/browser_sandbox.py	Adds overloads/params on high-level BrowserSandbox URL helpers
agentrun/sandbox/aio_sandbox.py	Adds overloads/params on high-level AioSandbox URL helpers
agentrun/sandbox/custom_sandbox.py	Changes custom sandbox base URL generation to use non-RAM data endpoint
agentrun/sandbox/api/__browser_data_async_template.py	Codegen template updated to match BrowserDataAPI changes
agentrun/sandbox/api/__aio_data_async_template.py	Codegen template updated to match AioDataAPI changes
agentrun/sandbox/__browser_sandbox_async_template.py	Codegen template updated for BrowserSandbox overloads
agentrun/sandbox/__aio_sandbox_async_template.py	Codegen template updated for AioSandbox overloads
tests/unittests/sandbox/api/test_browser_data.py	Updates/extends tests for WS URL generation and header-returning mode
tests/unittests/sandbox/api/test_aio_data.py	Updates/extends tests for WS URL generation and header-returning mode
tests/unittests/sandbox/test_browser_sandbox.py	Updates mock expectations for new parameters passed through
tests/unittests/sandbox/test_custom_sandbox.py	Updates tests to validate new non-RAM base URL behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

agentrun/sandbox/api/browser_data.py

agentrun/sandbox/api/aio_data.py

Copilot · 2026-04-01T09:28:32Z

tests/unittests/sandbox/api/test_browser_data.py

+        def _auth_side_effect(url="", headers=None, query=None, **kw):
+            return (
+                url,
+                {"Authorization": "Bearer tok", **(headers or {})},
+                query,
+            )


The production DataAPI.auth() returns RAM signature headers like Agentrun-Authorization/x-acs-date, not an Authorization: Bearer ... header. These tests stub auth() to return an Authorization header and then assert on that key, which doesn’t reflect the real contract and may miss regressions. Prefer asserting on the actual signature header keys (or patch get_agentrun_signed_headers for determinism and let auth() run) and use a config with AK/SK to exercise the header-based auth path.

tests/unittests/sandbox/api/test_aio_data.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: OhYee <oyohyee@oyohyee.com>

OhYee · 2026-04-03T10:26:03Z

@copilot
=========================== short test summary info ============================
FAILED tests/unittests/sandbox/api/test_aio_data.py::TestAioCdpUrl::test_get_cdp_url_no_record - TypeError: AioDataAPI._build_ws_url() got an unexpected keyword argument 'config'
FAILED tests/unittests/sandbox/api/test_aio_data.py::TestAioCdpUrl::test_get_cdp_url_with_record - TypeError: AioDataAPI._build_ws_url() got an unexpected keyword argument 'config'
FAILED tests/unittests/sandbox/api/test_aio_data.py::TestAioVncUrl::test_get_vnc_url_no_record - TypeError: AioDataAPI._build_ws_url() got an unexpected keyword argument 'config'
FAILED tests/unittests/sandbox/api/test_aio_data.py::TestAioVncUrl::test_get_vnc_url_with_record - TypeError: AioDataAPI._build_ws_url() got an unexpected keyword argument 'config'
FAILED tests/unittests/sandbox/api/test_browser_data.py::TestVncUrl::test_get_vnc_url_no_record - TypeError: BrowserDataAPI._build_ws_url() got an unexpected keyword argument 'config'
FAILED tests/unittests/sandbox/api/test_browser_data.py::TestVncUrl::test_get_vnc_url_with_record - TypeError: BrowserDataAPI._build_ws_url() got an unexpected keyword argument 'config'
======= 6 failed, 2775 passed, 4 skipped, 9 warnings in 63.70s (0:01:03) =======

Updated the query parameter handling in get_agentrun_signed_headers to decode both keys and values using unquote. This ensures that the headers are correctly signed when special characters are present in the query string. 修复(ram_signature)：在签名头中解码查询参数更新 get_agentrun_signed_headers 中的查询参数处理，以使用 unquote 解码键和值。这确保在查询字符串中存在特殊字符时，头部能够正确签名。 Change-Id: If1ca01053877ec382044ffc84b4db0e81ecf0610 Signed-off-by: OhYee <oyohyee@oyohyee.com>

…ket URL methods Removed the config parameter from the _build_ws_url method calls in both AioDataAPI and BrowserDataAPI classes. This simplifies the method signature and improves code clarity by eliminating unnecessary arguments. --- 修复(aio_data, browser_data): 移除 WebSocket URL 方法中未使用的 config 参数在 AioDataAPI 和 BrowserDataAPI 类中移除了 _build_ws_url 方法调用中的 config 参数。这简化了方法签名，并通过消除不必要的参数提高了代码清晰度。 Change-Id: I657c950ed45ff35e830ad7601008cb05dad7ac38 Signed-off-by: OhYee <oyohyee@oyohyee.com>

Agent-Logs-Url: https://github.com/Serverless-Devs/agentrun-sdk-python/sessions/ccb9d142-e4b4-4b89-8280-17e38737b52b Co-authored-by: OhYee <13498329+OhYee@users.noreply.github.com>

Copilot · 2026-04-03T10:33:20Z

@copilot
=========================== short test summary info ============================
FAILED tests/unittests/sandbox/api/test_aio_data.py::TestAioCdpUrl::test_get_cdp_url_no_record - TypeError:...

Fixed in b49ff60. The root cause was that previous review suggestions passed config=config to _build_ws_url(), but that method didn't accept a config parameter. Updated _build_ws_url in both browser_data.py and aio_data.py (and their templates) to accept config: Optional[Config] = None and use Config.with_configs(self.config, config).get_data_endpoint() for the URL base — so the config override is now properly applied in the non-headers path too.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

astral.sh
- Triggering command: /usr/bin/curl curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

OhYee requested a review from Copilot April 1, 2026 09:20

Copilot started reviewing on behalf of OhYee April 1, 2026 09:21 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

OhYee and others added 3 commits April 1, 2026 18:11

Update agentrun/sandbox/api/browser_data.py

945368f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: OhYee <oyohyee@oyohyee.com>

Apply suggestion from @Copilot

e62b7cc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: OhYee <oyohyee@oyohyee.com>

Apply suggestions from code review

afcdfb1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: OhYee <oyohyee@oyohyee.com>

Copilot started work on behalf of OhYee April 3, 2026 10:26 View session

OhYee and others added 3 commits April 3, 2026 18:30

fix: add config parameter to _build_ws_url in browser and aio data APIs

b49ff60

Agent-Logs-Url: https://github.com/Serverless-Devs/agentrun-sdk-python/sessions/ccb9d142-e4b4-4b89-8280-17e38737b52b Co-authored-by: OhYee <13498329+OhYee@users.noreply.github.com>

Copilot finished work on behalf of OhYee April 3, 2026 10:34

OhYee merged commit 3c54da1 into main Apr 3, 2026
1 of 2 checks passed

OhYee deleted the fix-new-auth branch April 3, 2026 10:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(browser-api): enhance WebSocket URL generation with header support#78

feat(browser-api): enhance WebSocket URL generation with header support#78
OhYee merged 7 commits intomainfrom
fix-new-auth

OhYee commented Apr 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Uh oh!

OhYee commented Apr 3, 2026

Uh oh!

Copilot AI commented Apr 3, 2026 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

OhYee commented Apr 1, 2026

Fix bugs

Update docs

Add contributor

Others

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OhYee commented Apr 3, 2026

Uh oh!

Copilot AI commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 3, 2026 •

edited

Loading