|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import json |
| 4 | +import os |
| 5 | +import sys |
| 6 | +from importlib import metadata |
| 7 | +from typing import TYPE_CHECKING |
| 8 | + |
| 9 | +import pytest |
| 10 | +from werkzeug import Request, Response |
| 11 | + |
| 12 | +from apify_client import ApifyClient, ApifyClientAsync |
| 13 | +from apify_client._http_client import HTTPClient, HTTPClientAsync |
| 14 | + |
| 15 | +if TYPE_CHECKING: |
| 16 | + from pytest_httpserver import HTTPServer |
| 17 | + |
| 18 | + |
| 19 | +def _header_handler(request: Request) -> Response: |
| 20 | + return Response( |
| 21 | + status=200, |
| 22 | + headers={}, |
| 23 | + response=json.dumps({'received_headers': dict(request.headers)}), |
| 24 | + ) |
| 25 | + |
| 26 | + |
| 27 | +def _get_user_agent() -> str: |
| 28 | + is_at_home = 'APIFY_IS_AT_HOME' in os.environ |
| 29 | + python_version = '.'.join([str(x) for x in sys.version_info[:3]]) |
| 30 | + client_version = metadata.version('apify-client') |
| 31 | + return f'ApifyClient/{client_version} ({sys.platform}; Python/{python_version}); isAtHome/{is_at_home}' |
| 32 | + |
| 33 | + |
| 34 | +async def test_default_headers_async(httpserver: HTTPServer) -> None: |
| 35 | + """Test that default headers are sent with each request.""" |
| 36 | + |
| 37 | + client = HTTPClientAsync(token='placeholder_token') |
| 38 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 39 | + api_url = httpserver.url_for('/').removesuffix('/') |
| 40 | + |
| 41 | + response = await client.call(method='GET', url=f'{api_url}/') |
| 42 | + |
| 43 | + request_headers = json.loads(response.text)['received_headers'] |
| 44 | + |
| 45 | + assert request_headers == { |
| 46 | + 'User-Agent': _get_user_agent(), |
| 47 | + 'Accept': 'application/json, */*', |
| 48 | + 'Authorization': 'Bearer placeholder_token', |
| 49 | + 'Accept-Encoding': 'gzip, br, zstd, deflate', |
| 50 | + 'Host': f'{httpserver.host}:{httpserver.port}', |
| 51 | + } |
| 52 | + |
| 53 | + |
| 54 | +def test_default_headers_sync(httpserver: HTTPServer) -> None: |
| 55 | + """Test that default headers are sent with each request.""" |
| 56 | + |
| 57 | + client = HTTPClient(token='placeholder_token') |
| 58 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 59 | + api_url = httpserver.url_for('/').removesuffix('/') |
| 60 | + |
| 61 | + response = client.call(method='GET', url=f'{api_url}/') |
| 62 | + |
| 63 | + request_headers = json.loads(response.text)['received_headers'] |
| 64 | + |
| 65 | + assert request_headers == { |
| 66 | + 'User-Agent': _get_user_agent(), |
| 67 | + 'Accept': 'application/json, */*', |
| 68 | + 'Authorization': 'Bearer placeholder_token', |
| 69 | + 'Accept-Encoding': 'gzip, br, zstd, deflate', |
| 70 | + 'Host': f'{httpserver.host}:{httpserver.port}', |
| 71 | + } |
| 72 | + |
| 73 | + |
| 74 | +async def test_headers_async(httpserver: HTTPServer) -> None: |
| 75 | + """Test that custom headers are sent with each request.""" |
| 76 | + |
| 77 | + client = HTTPClientAsync( |
| 78 | + token='placeholder_token', |
| 79 | + headers={'Test-Header': 'blah', 'User-Agent': 'CustomUserAgent/1.0', 'Authorization': 'strange_value'}, |
| 80 | + ) |
| 81 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 82 | + api_url = httpserver.url_for('/').removesuffix('/') |
| 83 | + |
| 84 | + response = await client.call(method='GET', url=f'{api_url}/') |
| 85 | + |
| 86 | + request_headers = json.loads(response.text)['received_headers'] |
| 87 | + |
| 88 | + assert request_headers == { |
| 89 | + 'Test-Header': 'blah', |
| 90 | + 'User-Agent': 'CustomUserAgent/1.0', |
| 91 | + 'Accept': 'application/json, */*', |
| 92 | + 'Authorization': 'strange_value', |
| 93 | + 'Accept-Encoding': 'gzip, br, zstd, deflate', |
| 94 | + 'Host': f'{httpserver.host}:{httpserver.port}', |
| 95 | + } |
| 96 | + |
| 97 | + |
| 98 | +def test_headers_sync(httpserver: HTTPServer) -> None: |
| 99 | + """Test that custom headers are sent with each request.""" |
| 100 | + |
| 101 | + client = HTTPClient( |
| 102 | + token='placeholder_token', |
| 103 | + headers={ |
| 104 | + 'Test-Header': 'blah', |
| 105 | + 'User-Agent': 'CustomUserAgent/1.0', |
| 106 | + 'Authorization': 'strange_value', |
| 107 | + }, |
| 108 | + ) |
| 109 | + httpserver.expect_request('/').respond_with_handler(_header_handler) |
| 110 | + api_url = httpserver.url_for('/').removesuffix('/') |
| 111 | + |
| 112 | + response = client.call(method='GET', url=f'{api_url}/') |
| 113 | + |
| 114 | + request_headers = json.loads(response.text)['received_headers'] |
| 115 | + |
| 116 | + assert request_headers == { |
| 117 | + 'Test-Header': 'blah', |
| 118 | + 'User-Agent': 'CustomUserAgent/1.0', |
| 119 | + 'Accept': 'application/json, */*', |
| 120 | + 'Authorization': 'strange_value', |
| 121 | + 'Accept-Encoding': 'gzip, br, zstd, deflate', |
| 122 | + 'Host': f'{httpserver.host}:{httpserver.port}', |
| 123 | + } |
| 124 | + |
| 125 | + |
| 126 | +def test_warning_on_overridden_headers_sync() -> None: |
| 127 | + """Test that warning is raised when default headers are overridden.""" |
| 128 | + |
| 129 | + with pytest.warns(UserWarning, match='User-Agent, Authorization headers of ApifyClient'): |
| 130 | + ApifyClient( |
| 131 | + token='placeholder_token', |
| 132 | + headers={ |
| 133 | + 'User-Agent': 'CustomUserAgent/1.0', |
| 134 | + 'Authorization': 'strange_value', |
| 135 | + }, |
| 136 | + ) |
| 137 | + |
| 138 | + |
| 139 | +async def test_warning_on_overridden_headers_async() -> None: |
| 140 | + """Test that warning is raised when default headers are overridden.""" |
| 141 | + |
| 142 | + with pytest.warns(UserWarning, match='User-Agent, Authorization headers of ApifyClientAsync'): |
| 143 | + ApifyClientAsync( |
| 144 | + token='placeholder_token', |
| 145 | + headers={ |
| 146 | + 'User-Agent': 'CustomUserAgent/1.0', |
| 147 | + 'Authorization': 'strange_value', |
| 148 | + }, |
| 149 | + ) |
0 commit comments