Skip to content

Commit 57b54a9

Browse files
fix: disable grpc compression by default (#2154)
1 parent d8094c3 commit 57b54a9

3 files changed

Lines changed: 12 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,7 @@ to docs, or any other relevant information.
4949
- avoid logging `NativeConnection` on worker startup
5050

5151
## [Unreleased]
52+
53+
### Changed
54+
55+
- gRPC compression is disabled by default. Pass `grpcCompression: { codec: 'gzip' }` to enable it.

packages/test/src/test-native-connection.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -511,12 +511,12 @@ test('NativeConnection: DNS load balancing config is converted to native millise
511511
t.deepEqual(options.dnsLoadBalancingConfig, { resolutionIntervalMillis: 5000 });
512512
});
513513

514-
test('NativeConnection: gRPC compression defaults to gzip', (t) => {
514+
test('NativeConnection: gRPC compression defaults to disabled', (t) => {
515515
const options = toNativeClientOptions({});
516-
t.deepEqual(options.grpcCompression, { codec: 'gzip' });
516+
t.deepEqual(options.grpcCompression, { codec: 'none' });
517517
});
518518

519-
test('NativeConnection: gRPC compression can be disabled', (t) => {
520-
const options = toNativeClientOptions({ grpcCompression: { codec: 'none' } });
521-
t.deepEqual(options.grpcCompression, { codec: 'none' });
519+
test('NativeConnection: gRPC compression can be enabled', (t) => {
520+
const options = toNativeClientOptions({ grpcCompression: { codec: 'gzip' } });
521+
t.deepEqual(options.grpcCompression, { codec: 'gzip' });
522522
});

packages/worker/src/connection-options.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ export interface NativeConnectionOptions {
8686
/**
8787
* Transport-level gRPC compression configuration for Core service requests.
8888
*
89-
* Defaults to gzip, which compresses outbound request bodies and accepts
90-
* gzip-compressed responses. Set to `{ codec: 'none' }` to opt out.
89+
* Defaults to no compression. Set to `{ codec: 'gzip' }` to compress outbound
90+
* request bodies and accept gzip-compressed responses.
9191
*/
9292
grpcCompression?: GrpcCompressionConfig;
9393

@@ -165,7 +165,7 @@ export function toNativeClientOptions(options: NativeConnectionOptions): native.
165165
}
166166
: null;
167167

168-
const grpcCompression: native.GrpcCompressionConfig = options.grpcCompression ?? { codec: 'gzip' };
168+
const grpcCompression: native.GrpcCompressionConfig = options.grpcCompression ?? { codec: 'none' };
169169
switch (grpcCompression.codec) {
170170
case 'gzip':
171171
case 'none':

0 commit comments

Comments
 (0)