|
7 | 7 | from typing import TYPE_CHECKING |
8 | 8 |
|
9 | 9 | import httpx2 |
| 10 | +import pytest |
10 | 11 | from werkzeug import Request, Response |
11 | 12 |
|
| 13 | +from apify_client import ApifyClient, ApifyClientAsync |
12 | 14 | from apify_client.http_clients import Httpx2HttpClient, Httpx2HttpClientAsync, ImpitHttpClient, ImpitHttpClientAsync |
13 | 15 |
|
14 | 16 | if TYPE_CHECKING: |
@@ -149,6 +151,81 @@ def test_headers_sync(httpserver: HTTPServer, http_client_class: type[HttpClient |
149 | 151 | assert _parse_accept_encoding(request_headers['Accept-Encoding']) == expected_encodings |
150 | 152 |
|
151 | 153 |
|
| 154 | +user_agent_suffix_cases = [ |
| 155 | + pytest.param(None, '', id='no suffix'), |
| 156 | + pytest.param('MyTool/1.0', '; MyTool/1.0', id='string suffix'), |
| 157 | + pytest.param(['SDK/3.0.0', 'Crawlee/1.0.0'], '; SDK/3.0.0; Crawlee/1.0.0', id='list suffix'), |
| 158 | +] |
| 159 | + |
| 160 | + |
| 161 | +@pytest.mark.parametrize(('user_agent_suffix', 'expected_suffix'), user_agent_suffix_cases) |
| 162 | +async def test_user_agent_suffix_async( |
| 163 | + httpserver: HTTPServer, |
| 164 | + http_client_async_class: type[HttpClientAsync], |
| 165 | + user_agent_suffix: str | list[str] | None, |
| 166 | + expected_suffix: str, |
| 167 | +) -> None: |
| 168 | + """The HTTP client appends `user_agent_suffix` to the default `User-Agent` header.""" |
| 169 | + client = http_client_async_class(user_agent_suffix=user_agent_suffix) |
| 170 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 171 | + |
| 172 | + response = await client.call(method='GET', url=httpserver.url_for('/')) |
| 173 | + |
| 174 | + request_headers = json.loads(response.text)['received_headers'] |
| 175 | + assert request_headers['User-Agent'] == f'{_get_user_agent()}{expected_suffix}' |
| 176 | + |
| 177 | + |
| 178 | +@pytest.mark.parametrize(('user_agent_suffix', 'expected_suffix'), user_agent_suffix_cases) |
| 179 | +def test_user_agent_suffix_sync( |
| 180 | + httpserver: HTTPServer, |
| 181 | + http_client_class: type[HttpClient], |
| 182 | + user_agent_suffix: str | list[str] | None, |
| 183 | + expected_suffix: str, |
| 184 | +) -> None: |
| 185 | + """The HTTP client appends `user_agent_suffix` to the default `User-Agent` header.""" |
| 186 | + client = http_client_class(user_agent_suffix=user_agent_suffix) |
| 187 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 188 | + |
| 189 | + response = client.call(method='GET', url=httpserver.url_for('/')) |
| 190 | + |
| 191 | + request_headers = json.loads(response.text)['received_headers'] |
| 192 | + assert request_headers['User-Agent'] == f'{_get_user_agent()}{expected_suffix}' |
| 193 | + |
| 194 | + |
| 195 | +@pytest.mark.usefixtures('http_client_classes') |
| 196 | +@pytest.mark.parametrize(('user_agent_suffix', 'expected_suffix'), user_agent_suffix_cases) |
| 197 | +async def test_apify_client_user_agent_suffix_async( |
| 198 | + httpserver: HTTPServer, |
| 199 | + user_agent_suffix: str | list[str] | None, |
| 200 | + expected_suffix: str, |
| 201 | +) -> None: |
| 202 | + """`ApifyClientAsync` passes `user_agent_suffix` to its default HTTP client.""" |
| 203 | + client = ApifyClientAsync(token='placeholder_token', user_agent_suffix=user_agent_suffix) |
| 204 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 205 | + |
| 206 | + response = await client.http_client.call(method='GET', url=httpserver.url_for('/')) |
| 207 | + |
| 208 | + request_headers = json.loads(response.text)['received_headers'] |
| 209 | + assert request_headers['User-Agent'] == f'{_get_user_agent()}{expected_suffix}' |
| 210 | + |
| 211 | + |
| 212 | +@pytest.mark.usefixtures('http_client_classes') |
| 213 | +@pytest.mark.parametrize(('user_agent_suffix', 'expected_suffix'), user_agent_suffix_cases) |
| 214 | +def test_apify_client_user_agent_suffix_sync( |
| 215 | + httpserver: HTTPServer, |
| 216 | + user_agent_suffix: str | list[str] | None, |
| 217 | + expected_suffix: str, |
| 218 | +) -> None: |
| 219 | + """`ApifyClient` passes `user_agent_suffix` to its default HTTP client.""" |
| 220 | + client = ApifyClient(token='placeholder_token', user_agent_suffix=user_agent_suffix) |
| 221 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 222 | + |
| 223 | + response = client.http_client.call(method='GET', url=httpserver.url_for('/')) |
| 224 | + |
| 225 | + request_headers = json.loads(response.text)['received_headers'] |
| 226 | + assert request_headers['User-Agent'] == f'{_get_user_agent()}{expected_suffix}' |
| 227 | + |
| 228 | + |
152 | 229 | async def test_per_request_headers_override_defaults_async( |
153 | 230 | httpserver: HTTPServer, http_client_async_class: type[HttpClientAsync] |
154 | 231 | ) -> None: |
|
0 commit comments