Repository navigation
feat!: make request-body compression configurable - #1065
Merged
Merged
Conversation
BREAKING CHANGE: The client runs only the configured compressor (brotli by default) and lets its error fail the request. It no longer falls back to gzip, or to an uncompressed body, when brotli fails. Pass `compression: 'gzip'` on a runtime whose `node:zlib` lacks brotli.
vdusek
added
the
t-tooling
Contributor
|
See more at https://github.com/apify/apify-client-js/actions/runs/35016412232#summary-104540847859 |
# Conflicts: # rsbuild.config.ts # src/http_client.ts # src/interceptors.ts # src/utils.ts # test/utils.test.ts
janbuchar
approved these changes
Sep 14, 2026
Contributor
There was a problem hiding this comment.
I'm still not convinced that this matters enough to warrant a fully-fledged guide.
Contributor
Author
There was a problem hiding this comment.
let's review the whole docs as part of #851 and align it with the Python version
| * const client = new ApifyClient({ token: 'my-token', compression: new IdentityCompressor() }); | ||
| * ``` | ||
| */ | ||
| export abstract class HttpCompressor { |
Contributor
There was a problem hiding this comment.
Abstract class with abstract methods only sounds like an interface.
Member
There was a problem hiding this comment.
Not really, instanceof HttpCompressor works but you can't check with code if something implements an interface (without zod et al)
Contributor
There was a problem hiding this comment.
True that, but we don't really do instanceof much here, do we? I'd say that pitfalls such as breaking if you have multiple versions of apify-client in your node_modules or when crossing realms (service workers) still apply here. Typescript + a rough-shape-check via zod is preferable IMO.
Contributor
Author
There was a problem hiding this comment.
changed to interface
vdusek
added a commit
that referenced
this pull request
Sep 16, 2026
The configurable request compression from #1065 moves into the shared pipeline of the new `HttpClient` base, where the compression step lives now that `http_client.ts` and `interceptors.ts` are gone. `compression` becomes an `HttpClientOptions` field resolved in the base constructor, so `ApifyClient` forwards the option instead of resolving it, and a custom HTTP client gets the same compression as `AxiosHttpClient`. The new HTTP clients concept page moves to `08_http-clients.md`, since #1065 took the `07_` slot for HTTP compression.
B4nan
pushed a commit
that referenced
this pull request
Sep 30, 2026
### TLDR - Ports the `http_compressors` design of the Python client (apify/apify-client-python#927) to the JS client. - Closes: #1064 ### Description Request compression was hard-wired in `maybeCompressValue()`: brotli at quality 6, a silent fallback to gzip, and no way to pick the algorithm, tune the quality, or plug in a custom compressor. The client now has an abstract `HttpCompressor` (`contentEncoding` plus an async `compress()`), a `GzipHttpCompressor` (quality 1 to 9, default 9) and a `BrotliHttpCompressor` (quality 0 to 11, default 6), all exported from the package. `ApifyClient` takes a `compression` option: `'brotli'` (the default), `'gzip'`, or an `HttpCompressor` instance. The option is validated by shape, so an instance from a second copy of the package passes too. `HttpClient` holds the resolved compressor and the compress interceptor uses it. The rules for which bodies get compressed are unchanged: at least 1 KiB, a compressible content type, no caller-set `Content-Encoding`, Node.js only. Two deliberate differences from Python. Brotli stays the default, since Node ships it in `node:zlib` and the dependency reason for Python's gzip default doesn't apply. Streams are never compressed, where Python reads file-likes into memory. `setRecord()` still has no `contentEncoding` option, so the docs route pre-compressed bodies through `client.httpClient.call()`. Docs: a new `HTTP compression` concepts page adapted from the Python one, a section in the v3 upgrade guide, and the regenerated api-extractor report. ### Breaking change The silent fallback from #990 is gone. The configured compressor is the only one the client runs, and its error fails the request, as in Python. A runtime whose `node:zlib` lacks brotli used to get a gzipped or uncompressed body and now needs `compression: 'gzip'`. A client constructed without the option sends the same requests as before. *✍️ Drafted by Claude Code*
janbuchar
pushed a commit
that referenced
this pull request
Nov 10, 2026
…1179) Adds `ActorClient.server()`, which returns an `ActorServerClient` for Server Actors (formerly Actor Standby): ```ts const actorServerClient = client.actor('username/actor-name').server(); const response = await actorServerClient.request('/search', { params: { q: 'apify' } }); const url = await actorServerClient.getUrl(); const spec = await actorServerClient.getOpenApiSpec(); ``` - `request()` sends a request to the Actor's server. The host always comes from the Actor's `standbyUrl`. The token goes in the `X-Apify-Authorization` header, which the platform strips, so headers the caller passes, `Authorization` included, reach the Actor as they are. It doesn't follow redirects and returns a redirect response as it is, so the token can't reach a host the Actor's code picked. - `request()` returns the server's response whatever its status. Only 429 and 503 are retried, since other statuses may come from the Actor's code. Network errors and timeouts aren't retried, since the Actor may have already handled the request. It throws only when it gets no response: the Actor doesn't exist or isn't a Server Actor, or the request fails or times out. - `request()` sends bodies uncompressed unless `compression` is set, returns the body parsed, as a buffer, or as a stream depending on `responseType`, and defaults to the `long` timeout to cover a cold start. - `getUrl()` returns the server URL. It's fetched once per `ActorClient`, by `getUrl()` or `getOpenApiSpec()`. - `getOpenApiSpec()` returns the web server schema from the build that serves the server (`actorStandby.build`, or `latest`), or `undefined` if there's none. `ActorClient.standby()` is a deprecated alias of `server()` and will be removed in v4. Other changes: - `ApifyRequestConfig` takes new per-request options: `compression`, `authorizationHeader`, `throwOnErrorStatus`, `retryStatusCodes`, `retryTransportErrors`, and `followRedirects`. A custom HTTP client that overrides `call()` should honor them, and one that overrides `sendRequest()` must honor the new `HttpRequest.followRedirects` field, or it would follow a redirect with the token. - A Server Actors concepts page, unit tests, and an integration test against a temporary echo Server Actor. Port of apify/apify-client-python#1153. Closes: #1159 *✍️ Drafted by Claude Code* 2.x backport: Built on the 2.x axios `HttpClient`, which gains opt-in `throwOnErrorStatus`, `retryStatusCodes`, `retryTransportErrors` and `doNotCompress` request options. There is no `compression` option, since it depends on the pluggable compressors from #1065. The request body is always sent uncompressed. The `AbortSignal` support and the timeout tiers are not ported, and errors are plain `Error`s.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TLDR
http_compressorsdesign of the Python client (feat: Add request body compression with optional brotli apify-client-python#927) to the JS client.Description
Request compression was hard-wired in
maybeCompressValue(): brotli at quality 6, a silent fallback to gzip, and no way to pick the algorithm, tune the quality, or plug in a custom compressor.The client now has an abstract
HttpCompressor(contentEncodingplus an asynccompress()), aGzipHttpCompressor(quality 1 to 9, default 9) and aBrotliHttpCompressor(quality 0 to 11, default 6), all exported from the package.ApifyClienttakes acompressionoption:'brotli'(the default),'gzip', or anHttpCompressorinstance. The option is validated by shape, so an instance from a second copy of the package passes too.HttpClientholds the resolved compressor and the compress interceptor uses it. The rules for which bodies get compressed are unchanged: at least 1 KiB, a compressible content type, no caller-setContent-Encoding, Node.js only.Two deliberate differences from Python. Brotli stays the default, since Node ships it in
node:zliband the dependency reason for Python's gzip default doesn't apply. Streams are never compressed, where Python reads file-likes into memory.setRecord()still has nocontentEncodingoption, so the docs route pre-compressed bodies throughclient.httpClient.call().Docs: a new
HTTP compressionconcepts page adapted from the Python one, a section in the v3 upgrade guide, and the regenerated api-extractor report.Breaking change
The silent fallback from #990 is gone. The configured compressor is the only one the client runs, and its error fails the request, as in Python. A runtime whose
node:zliblacks brotli used to get a gzipped or uncompressed body and now needscompression: 'gzip'. A client constructed without the option sends the same requests as before.✍️ Drafted by Claude Code