resolve

Author: Mantisus

src/apify_client/_http_client.py

@@ -214,6 +214,9 @@ def _make_request(stop_retrying: Callable, attempt: int) -> httpx.Response:
             if response.status_code < 500 and response.status_code != HTTPStatus.TOO_MANY_REQUESTS:  # noqa: PLR2004
                 logger.debug('Status code is not retryable', extra={'status_code': response.status_code})
                 stop_retrying()
+
+            # Read the response in case it is a stream, so we can raise the error properly
+            response.read()
             raise ApifyApiError(response, attempt)
 
         return retry_with_exp_backoff(
@@ -304,6 +307,9 @@ async def _make_request(stop_retrying: Callable, attempt: int) -> httpx.Response
             if response.status_code < 500 and response.status_code != HTTPStatus.TOO_MANY_REQUESTS:  # noqa: PLR2004
                 logger.debug('Status code is not retryable', extra={'status_code': response.status_code})
                 stop_retrying()
+
+            # Read the response in case it is a stream, so we can raise the error properly
+            await response.aread()
             raise ApifyApiError(response, attempt)
 
         return await retry_with_exp_backoff_async(

tests/unit/test_client_errors.py

@@ -1,13 +1,18 @@
 from __future__ import annotations
 
+import json
 from typing import TYPE_CHECKING
 
+import httpx
 import pytest
+import respx
 
 from apify_client._errors import ApifyApiError
 from apify_client._http_client import HTTPClient, HTTPClientAsync
 
 if TYPE_CHECKING:
+    from collections.abc import AsyncIterator, Iterator
+
     from pytest_httpserver import HTTPServer
 
 _TEST_PATH = '/errors'
@@ -17,6 +22,16 @@
     'invalidItems': {'0': ["should have required property 'name'"], '1': ["should have required property 'name'"]}
 }
 
+RAW_ERROR = (
+    b'{\n'
+    b'  "error": {\n'
+    b'    "type": "insufficient-permissions",\n'
+    b'    "message": "Insufficient permissions for the Actor run. Make sure you\''
+    b're passing a correct API token and that it has the required permissions."\n'
+    b'  }\n'
+    b'}'
+)
+
 
 @pytest.fixture
 def test_endpoint(httpserver: HTTPServer) -> str:
@@ -48,3 +63,53 @@ async def test_async_client_apify_api_error_with_data(test_endpoint: str) -> Non
     assert e.value.message == _EXPECTED_MESSAGE
     assert e.value.type == _EXPECTED_TYPE
     assert e.value.data == _EXPECTED_DATA
+
+
+def test_client_apify_api_error_streamed() -> None:
+    """Test that client correctly throws ApifyApiError when the response has stream."""
+
+    error = json.loads(RAW_ERROR.decode())
+
+    class ByteStream(httpx._types.SyncByteStream):
+        def __iter__(self) -> Iterator[bytes]:
+            yield RAW_ERROR
+
+        def close(self) -> None:
+            pass
+
+    stream_url = 'http://some-stream-url.com'
+
+    client = HTTPClient()
+
+    with respx.mock() as respx_mock:
+        respx_mock.get(url=stream_url).mock(return_value=httpx.Response(stream=ByteStream(), status_code=403))
+        with pytest.raises(ApifyApiError) as e:
+            client.call(method='GET', url=stream_url, stream=True, parse_response=False)
+
+    assert e.value.message == error['error']['message']
+    assert e.value.type == error['error']['type']
+
+
+async def test_async_client_apify_api_error_streamed() -> None:
+    """Test that async client correctly throws ApifyApiError when the response has stream."""
+
+    error = json.loads(RAW_ERROR.decode())
+
+    class AsyncByteStream(httpx._types.AsyncByteStream):
+        async def __aiter__(self) -> AsyncIterator[bytes]:
+            yield RAW_ERROR
+
+        async def aclose(self) -> None:
+            pass
+
+    stream_url = 'http://some-stream-url.com'
+
+    client = HTTPClientAsync()
+
+    with respx.mock() as respx_mock:
+        respx_mock.get(url=stream_url).mock(return_value=httpx.Response(stream=AsyncByteStream(), status_code=403))
+        with pytest.raises(ApifyApiError) as e:
+            await client.call(method='GET', url=stream_url, stream=True, parse_response=False)
+
+    assert e.value.message == error['error']['message']
+    assert e.value.type == error['error']['type']

website/docusaurus.config.js

@@ -1,8 +1,9 @@
-/* eslint-disable global-require,import/no-extraneous-dependencies */
+const path = require('path');
+
 const { config } = require('@apify/docs-theme');
+
 const { externalLinkProcessor } = require('./tools/utils/externalLink');
 const { groupSort } = require('./transformDocs.js');
-const path = require('path');
 
 const { absoluteUrl } = config;
 
@@ -29,9 +30,8 @@ module.exports = {
     trailingSlash: false,
     organizationName: 'apify',
     projectName: 'apify-client-python',
-    scripts: ['/js/custom.js'],
     favicon: 'img/favicon.ico',
-    scripts: [...(config.scripts ?? [])],
+    scripts: ['/js/custom.js', ...(config.scripts ?? [])],
     onBrokenLinks:
     /** @type {import('@docusaurus/types').ReportingSeverity} */ ('warn'),
     onBrokenMarkdownLinks:
@@ -106,6 +106,19 @@ module.exports = {
                 },
             },
         ],
+        [
+            '@signalwire/docusaurus-plugin-llms-txt',
+            {
+                content: {
+                    includeVersionedDocs: false,
+                    enableLlmsFullTxt: true,
+                    includeBlog: true,
+                    includeGeneratedIndex: false,
+                    includePages: true,
+                    relativePaths: false,
+                },
+            },
+        ],
         ...config.plugins,
     ],
     themeConfig: {