Fix: send connection-level WINDOW_UPDATE at session start by KoenRijpstra · Pull Request #2971 · grpc/grpc-node

KoenRijpstra · 2025-06-27T12:57:33Z

Overview

@grpc/grpc-js previously opened every HTTP/2 connection with the RFC‑default 65 535‑byte connection window, then waited until after the first DATA frames were received before enlarging it. On fast, high‑volume streams this small initial window causes the sender (or any intermediate HTTP/2 proxy) to buffer excess data, creating avoidable latency.

This change immediately enlarges the connection‑level window as soon as the session is created when the application has requested a larger value via

'grpc-node.flow_control_window'

This aligns the Node implementation with other gRPC language stacks that send the larger window before any payload is transmitted.

Core change (single patch)

// createSession() — directly after http2.connect()
const defaultWin = http2.getDefaultSettings().initialWindowSize; // 65 535
const connWin = options["grpc-node.flow_control_window"] as number | undefined;

// Apply user‑requested window immediately so the first DATA burst is not throttled
if (connWin && connWin > defaultWin) {
  try {
    // Node ≥ 14.18
    (session as any).setLocalWindowSize(connWin);
  } catch {
    // Older Node fallback
    const delta = connWin - (session.state.localWindowSize ?? defaultWin);
    if (delta > 0) (session as any).incrementWindowSize(delta);
  }
}

No public API changes. Clients that do not set the option keep the existing behaviour.

Impact

	Before	After
Initial flow‑control	Sender stalls after 65 KB	Full requested window available at once
Latency under load	Can grow as buffers back up	Remains stable
Compatibility	–	Behaviour now matches Go/C/C++/Rust gRPC

Works on Node 14 → 20 (fallback path covers older Node versions).

Changelog entry

### Fixed
* http2: enlarge connection‑level flow‑control window at session start when a larger
  'grpc-node.flow_control_window' is configured.

If the user sets `grpc-node.connection_flow_control_window` to a value > 65 535 B, we now send a WINDOW_UPDATE (or setLocalWindowSize) right after `http2.connect()` returns. This removes the 65 KB start-window stall that caused large initial backlogs on high-throughput streams, especially when an H2 proxy (e.g. HAProxy) sat between client and server. Behaviour now matches Go/Rust gRPC; no API changes.

linux-foundation-easycla · 2025-06-27T12:57:39Z

The committers listed above are authorized under a signed CLA.

✅ login: KoenRijpstra / name: Koen Rijpstra (d872278, aeb7a5f, 0e09b9c, b69bcad, a8d22dc)

….flow_control_window

murgatroid99 · 2025-06-27T17:33:25Z

The setLocalWindowSize documentation indicates that it should be called in the handler for the 'connect' or 'remoteSettings' event. There is already a 'remoteSettings' handler, so it should be moved there. This change should still work as intended because the session isn't used until after that event is handled anyway.

KoenRijpstra · 2025-06-27T19:44:16Z

@murgatroid99

The setLocalWindowSize documentation indicates that it should be called in the handler for the 'connect' or 'remoteSettings' event. There is already a 'remoteSettings' handler, so it should be moved there. This change should still work as intended because the session isn't used until after that event is handled anyway.

I’ve moved it to remoteSettings, and it still works as expected 🚀. Mind giving it another review?

KoenRijpstra · 2025-07-06T07:47:14Z

@murgatroid99 When you have a moment, could you take another look and let me know if it’s good to go?

bernardoVale · 2025-08-06T20:07:52Z

any updates here? We need the same fix

murgatroid99 · 2025-08-06T22:45:49Z

packages/grpc-js/src/transport.ts

      });
+
+      // Prepare window size configuration for remoteSettings handler
+      const defaultWin = http2.getDefaultSettings().initialWindowSize ?? 65535; // 65 535 B


In what situation would http2.getDefaultSettings().initialWindowSize not have a value? Either way, this line should be consistent with the equivalent usage on line 722: either both should have a hardcoded default value, or neither.

@KoenRijpstra are you planning on addressing this feedback? If you don't have time I can do it for you

Yes will address this today.

@murgatroid99 The ?? 65535 fallback is purely for TypeScript compliance and defensive programming. In practice, http2.getDefaultSettings().initialWindowSize will always be 65535, but the fallback ensures type safety and makes the code more robust.

@murgatroid99 Both now have the hardcoded value.

murgatroid99

Thank you for the contribution.

KoenRijpstra added 2 commits June 27, 2025 14:09

fix(http2): handle default initial window size correctly

aeb7a5f

fix(http2): rename connection flow control window option to grpc-node…

b69bcad

….flow_control_window

fix(http2): move WINDOW_UPDATE handling to remoteSettings event

0e09b9c

murgatroid99 added the kokoro:run label Jul 11, 2025

kokoro-team removed the kokoro:run label Jul 11, 2025

murgatroid99 added the kokoro:rebuild label Aug 6, 2025

kokoro-team removed the kokoro:rebuild label Aug 6, 2025

murgatroid99 reviewed Aug 6, 2025

View reviewed changes

fix(http2): set default initial window size to 65535 if not specified

a8d22dc

murgatroid99 added the kokoro:run label Aug 11, 2025

kokoro-team removed the kokoro:run label Aug 11, 2025

murgatroid99 approved these changes Aug 11, 2025

View reviewed changes

murgatroid99 merged commit 6573a0e into grpc:master Aug 11, 2025
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: send connection-level WINDOW_UPDATE at session start#2971

Fix: send connection-level WINDOW_UPDATE at session start#2971
murgatroid99 merged 5 commits intogrpc:masterfrom
KoenRijpstra:fix/early-connection-window-update

KoenRijpstra commented Jun 27, 2025 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Jun 27, 2025 •

edited

Loading

Uh oh!

murgatroid99 commented Jun 27, 2025

Uh oh!

KoenRijpstra commented Jun 27, 2025 •

edited

Loading

Uh oh!

KoenRijpstra commented Jul 6, 2025

Uh oh!

bernardoVale commented Aug 6, 2025

Uh oh!

murgatroid99 Aug 6, 2025

Uh oh!

bernardoVale Aug 8, 2025

Uh oh!

KoenRijpstra Aug 10, 2025

Uh oh!

KoenRijpstra Aug 10, 2025

Uh oh!

KoenRijpstra Aug 10, 2025

Uh oh!

murgatroid99 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

KoenRijpstra commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Core change (single patch)

Impact

Changelog entry

Uh oh!

linux-foundation-easycla bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

murgatroid99 commented Jun 27, 2025

Uh oh!

KoenRijpstra commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KoenRijpstra commented Jul 6, 2025

Uh oh!

bernardoVale commented Aug 6, 2025

Uh oh!

murgatroid99 Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

bernardoVale Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

KoenRijpstra Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

KoenRijpstra Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

KoenRijpstra Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

murgatroid99 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

KoenRijpstra commented Jun 27, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jun 27, 2025 •

edited

Loading

KoenRijpstra commented Jun 27, 2025 •

edited

Loading