如何用Playwright Python验证出站请求中的指定参数值？

我正在使用Playwright Python（搭配pytest-playwright）进行站点测试。测试页面会向分析合作伙伴（如Google Analytics）发起带长查询字符串的GET请求，查询字符串中包含分析数据。
我希望验证该请求中是否存在特定值（例如foo=bar），本次示例使用analytics.example.com作为目标地址。

我编写了如下测试代码：

import re
r = re.compile('https://analytics.example.com/.*foo=bar.*')
with page.expect_request(r, timeout=15000) as analytics_call:
    print('got expected analytics call')

运行测试时，虽然打印了“got expected analytics call”，但测试因超时失败，报错信息为：
playwright._impl._api_types.TimeoutError: Timeout 15000ms exceeded while waiting for event "request"

我也考虑过使用page.on("request", my_event_handler)，事件处理函数会被调用，但不确定如何根据处理结果判断测试通过或失败。

请问应如何编写测试来验证出站请求中是否包含指定值？

方法1：修复page.expect_request的用法 #

你当前的代码问题在于，page.expect_request的上下文管理器需要等待请求实际触发，但你只是在块内打印信息，没有先执行触发请求的页面操作，也没等待请求对象返回。正确的流程是：先启动请求监听，再触发页面动作（比如打开页面、点击按钮），最后验证捕获到的请求。

示例代码：

import re
from playwright.sync_api import Page

def test_analytics_request(page: Page):
    # 定义匹配规则：匹配目标域名且URL包含foo=bar
    request_pattern = re.compile(r"https://analytics.example.com/.*foo=bar.*")
    
    # 启动监听的同时，触发会发起分析请求的页面操作
    with page.expect_request(request_pattern, timeout=15000) as request_info:
        page.goto("https://your-test-page.com")  # 替换为实际触发请求的操作
    
    # 获取匹配到的请求对象，做额外验证
    analytics_request = request_info.value
    assert "foo=bar" in analytics_request.url, "分析请求未包含预期参数foo=bar"

方法2：使用page.on结合断言标记 #

如果需要监听多个请求或更灵活的逻辑，可以注册事件处理器，用一个标记记录是否匹配到目标请求，最后断言标记状态。

示例代码：

from playwright.sync_api import Page

def test_analytics_request_with_event(page: Page):
    found_target = False
    
    def check_request(request):
        nonlocal found_target
        # 检查请求域名和查询参数
        if request.url.startswith("https://analytics.example.com/") and "foo=bar" in request.url:
            found_target = True
            # 可选：如果不需要实际发送请求给分析平台，可终止请求
            request.abort()
    
    # 注册请求监听器
    page.on("request", check_request)
    
    # 触发页面操作
    page.goto("https://your-test-page.com")
    
    # 等待足够时间确保请求完成（根据实际情况调整时长）
    page.wait_for_timeout(5000)
    
    # 断言目标请求已被捕获
    assert found_target, "未捕获到包含foo=bar的analytics请求"

额外优化建议 #

• 优先使用请求的query_params解析参数，比匹配整个URL更可靠：

  if request.url.startswith("https://analytics.example.com/"):
      assert request.query_params.get("foo") == "bar"
  

• 确保监听请求的代码在触发页面操作之前执行，避免错过请求。
• 超时时间根据页面实际加载速度调整，避免过短导致误判。

内容的提问来源于stack exchange，提问作者Doug Harris