#19945

Committed 18 Aug 2025 11:27AM UTC coverage: 88.564% (-0.04%) from 88.605%

Build # #19945

Build Type

push

github

Committed by

web-flow

Commit Message

Upgrade to Netty 4.1.124.Final (v1.75.x backport) (#12286)

Backport of #12274 to v1.75.x.
---
This implicitly disables NettyAdaptiveCumulator (#11284), which can have
a performance impact. We delayed upgrading Netty to give time to rework
the optimization, but we've gone too long already without upgrading
which causes problems for vulnerability tracking.

-----

Co-authored-by: Eric Anderson <ejona@google.com>

Run Details

34657 of 39132 relevant lines covered (88.56%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.45

/../okhttp/src/main/java/io/grpc/okhttp/OkHttpFrameLogger.java

/*
 * Copyright 2019 The gRPC Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.grpc.okhttp;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.annotations.VisibleForTesting;
import io.grpc.okhttp.internal.framed.ErrorCode;
import io.grpc.okhttp.internal.framed.Header;
import io.grpc.okhttp.internal.framed.Settings;
import java.util.EnumMap;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import okio.Buffer;
import okio.ByteString;

class OkHttpFrameLogger {
  private static final int BUFFER_LENGTH_THRESHOLD = 64;
  private final Logger logger;
  private final Level level;

  OkHttpFrameLogger(Level level, Class<?> clazz) {
    this(level, Logger.getLogger(clazz.getName()));
  }

  @VisibleForTesting
  OkHttpFrameLogger(Level level, Logger logger) {
    this.level = checkNotNull(level, "level");
    this.logger = checkNotNull(logger, "logger");
  }

  private static String toString(Settings settings) {
    EnumMap<SettingParams, Integer> map = new EnumMap<>(SettingParams.class);
    for (SettingParams p : SettingParams.values()) {
      // Only log set parameters.
      if (settings.isSet(p.getBit())) {
        map.put(p, settings.get(p.getBit()));
      }
    }
    return map.toString();
  }

  private static String toString(Buffer buf) {
    if (buf.size() <= BUFFER_LENGTH_THRESHOLD) {
      // Log the entire buffer.
      return buf.snapshot().hex();
    }

    // Otherwise just log the first 64 bytes.
    int length = (int) Math.min(buf.size(), BUFFER_LENGTH_THRESHOLD);
    return buf.snapshot(length).hex() + "...";
  }

  private boolean isEnabled() {
    return logger.isLoggable(level);
  }

  void logData(Direction direction, int streamId, Buffer data, int length, boolean endStream) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " DATA: streamId="
              + streamId
              + " endStream="
              + endStream
              + " length="
              + length
              + " bytes="
              + toString(data));
    }
  }

  void logHeaders(Direction direction, int streamId, List<Header> headers, boolean endStream) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " HEADERS: streamId="
              + streamId
              + " headers="
              + headers
              + " endStream="
              + endStream);
    }
  }

  public void logPriority(
      Direction direction, int streamId, int streamDependency, int weight, boolean exclusive) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " PRIORITY: streamId="
              + streamId
              + " streamDependency="
              + streamDependency
              + " weight="
              + weight
              + " exclusive="
              + exclusive);
    }
  }

  void logRstStream(Direction direction, int streamId, ErrorCode errorCode) {
    if (isEnabled()) {
      logger.log(
          level, direction + " RST_STREAM: streamId=" + streamId + " errorCode=" + errorCode);
    }
  }

  void logSettingsAck(Direction direction) {
    if (isEnabled()) {
      logger.log(level, direction + " SETTINGS: ack=true");
    }
  }

  void logSettings(Direction direction, Settings settings) {
    if (isEnabled()) {
      logger.log(level, direction + " SETTINGS: ack=false settings=" + toString(settings));
    }
  }

  void logPing(Direction direction, long data) {
    if (isEnabled()) {
      logger.log(level, direction + " PING: ack=false bytes=" + data);
    }
  }

  void logPingAck(Direction direction, long data) {
    if (isEnabled()) {
      logger.log(level, direction + " PING: ack=true bytes=" + data);
    }
  }

  void logPushPromise(
      Direction direction, int streamId, int promisedStreamId, List<Header> headers) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " PUSH_PROMISE: streamId="
              + streamId
              + " promisedStreamId="
              + promisedStreamId
              + " headers="
              + headers);
    }
  }

  void logGoAway(Direction direction, int lastStreamId, ErrorCode errorCode, ByteString debugData) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " GO_AWAY: lastStreamId="
              + lastStreamId
              + " errorCode="
              + errorCode
              + " length="
              + debugData.size()
              + " bytes="
              + toString(new Buffer().write(debugData)));
    }
  }

  void logWindowsUpdate(Direction direction, int streamId, long windowSizeIncrement) {
    if (isEnabled()) {
      logger.log(
          level,
          direction
              + " WINDOW_UPDATE: streamId="
              + streamId
              + " windowSizeIncrement="
              + windowSizeIncrement);
    }
  }

  enum Direction {
    INBOUND,
    OUTBOUND
  }

  // Note the set bits in OkHttp's Settings are different from HTTP2 Specifications.
  private enum SettingParams {
    HEADER_TABLE_SIZE(1),
    ENABLE_PUSH(2),
    MAX_CONCURRENT_STREAMS(4),
    MAX_FRAME_SIZE(5),
    MAX_HEADER_LIST_SIZE(6),
    INITIAL_WINDOW_SIZE(7);

    private final int bit;

    SettingParams(int bit) {
      this.bit = bit;
    }

    public int getBit() {
      return this.bit;
    }
  }
}

1	/*
2	* Copyright 2019 The gRPC Authors
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package io.grpc.okhttp;
18
19	import static com.google.common.base.Preconditions.checkNotNull;
20
21	import com.google.common.annotations.VisibleForTesting;
22	import io.grpc.okhttp.internal.framed.ErrorCode;
23	import io.grpc.okhttp.internal.framed.Header;
24	import io.grpc.okhttp.internal.framed.Settings;
25	import java.util.EnumMap;
26	import java.util.List;
27	import java.util.logging.Level;
28	import java.util.logging.Logger;
29	import okio.Buffer;
30	import okio.ByteString;
31
32	class OkHttpFrameLogger {
33	private static final int BUFFER_LENGTH_THRESHOLD = 64;
34	private final Logger logger;
35	private final Level level;
36
37	OkHttpFrameLogger(Level level, Class<?> clazz) {
38	this(level, Logger.getLogger(clazz.getName()));	1✔
39	}	1✔
40
41	@VisibleForTesting
42	OkHttpFrameLogger(Level level, Logger logger) {	1✔
43	this.level = checkNotNull(level, "level");	1✔
44	this.logger = checkNotNull(logger, "logger");	1✔
45	}	1✔
46
47	private static String toString(Settings settings) {
48	EnumMap<SettingParams, Integer> map = new EnumMap<>(SettingParams.class);	1✔
49	for (SettingParams p : SettingParams.values()) {	1✔
50	// Only log set parameters.
51	if (settings.isSet(p.getBit())) {	1✔
52	map.put(p, settings.get(p.getBit()));	1✔
53	}
54	}
55	return map.toString();	1✔
56	}
57
58	private static String toString(Buffer buf) {
59	if (buf.size() <= BUFFER_LENGTH_THRESHOLD) {	1✔
60	// Log the entire buffer.
61	return buf.snapshot().hex();	1✔
62	}
63
64	// Otherwise just log the first 64 bytes.
65	int length = (int) Math.min(buf.size(), BUFFER_LENGTH_THRESHOLD);	1✔
66	return buf.snapshot(length).hex() + "...";	1✔
67	}
68
69	private boolean isEnabled() {
70	return logger.isLoggable(level);	1✔
71	}
72
73	void logData(Direction direction, int streamId, Buffer data, int length, boolean endStream) {
74	if (isEnabled()) {	1✔
75	logger.log(	1✔
76	level,
77	direction
78	+ " DATA: streamId="
79	+ streamId
80	+ " endStream="
81	+ endStream
82	+ " length="
83	+ length
84	+ " bytes="
85	+ toString(data));	1✔
86	}
87	}	1✔
88
89	void logHeaders(Direction direction, int streamId, List<Header> headers, boolean endStream) {
90	if (isEnabled()) {	1✔
91	logger.log(	1✔
92	level,
93	direction
94	+ " HEADERS: streamId="
95	+ streamId
96	+ " headers="
97	+ headers
98	+ " endStream="
99	+ endStream);
100	}
101	}	1✔
102
103	public void logPriority(
104	Direction direction, int streamId, int streamDependency, int weight, boolean exclusive) {
105	if (isEnabled()) {	×
106	logger.log(	×
107	level,
108	direction
109	+ " PRIORITY: streamId="
110	+ streamId
111	+ " streamDependency="
112	+ streamDependency
113	+ " weight="
114	+ weight
115	+ " exclusive="
116	+ exclusive);
117	}
118	}	×
119
120	void logRstStream(Direction direction, int streamId, ErrorCode errorCode) {
121	if (isEnabled()) {	1✔
122	logger.log(	1✔
123	level, direction + " RST_STREAM: streamId=" + streamId + " errorCode=" + errorCode);
124	}
125	}	1✔
126
127	void logSettingsAck(Direction direction) {
128	if (isEnabled()) {	1✔
129	logger.log(level, direction + " SETTINGS: ack=true");	1✔
130	}
131	}	1✔
132
133	void logSettings(Direction direction, Settings settings) {
134	if (isEnabled()) {	1✔
135	logger.log(level, direction + " SETTINGS: ack=false settings=" + toString(settings));	1✔
136	}
137	}	1✔
138
139	void logPing(Direction direction, long data) {
140	if (isEnabled()) {	1✔
141	logger.log(level, direction + " PING: ack=false bytes=" + data);	1✔
142	}
143	}	1✔
144
145	void logPingAck(Direction direction, long data) {
146	if (isEnabled()) {	1✔
147	logger.log(level, direction + " PING: ack=true bytes=" + data);	1✔
148	}
149	}	1✔
150
151	void logPushPromise(
152	Direction direction, int streamId, int promisedStreamId, List<Header> headers) {
153	if (isEnabled()) {	1✔
154	logger.log(	1✔
155	level,
156	direction
157	+ " PUSH_PROMISE: streamId="
158	+ streamId
159	+ " promisedStreamId="
160	+ promisedStreamId
161	+ " headers="
162	+ headers);
163	}
164	}	1✔
165
166	void logGoAway(Direction direction, int lastStreamId, ErrorCode errorCode, ByteString debugData) {
167	if (isEnabled()) {	1✔
168	logger.log(	1✔
169	level,
170	direction
171	+ " GO_AWAY: lastStreamId="
172	+ lastStreamId
173	+ " errorCode="
174	+ errorCode
175	+ " length="
176	+ debugData.size()	1✔
177	+ " bytes="
178	+ toString(new Buffer().write(debugData)));	1✔
179	}
180	}	1✔
181
182	void logWindowsUpdate(Direction direction, int streamId, long windowSizeIncrement) {
183	if (isEnabled()) {	1✔
184	logger.log(	1✔
185	level,
186	direction
187	+ " WINDOW_UPDATE: streamId="
188	+ streamId
189	+ " windowSizeIncrement="
190	+ windowSizeIncrement);
191	}
192	}	1✔
193
194	enum Direction {	1✔
195	INBOUND,	1✔
196	OUTBOUND	1✔
197	}
198
199	// Note the set bits in OkHttp's Settings are different from HTTP2 Specifications.
200	private enum SettingParams {	1✔
201	HEADER_TABLE_SIZE(1),	1✔
202	ENABLE_PUSH(2),	1✔
203	MAX_CONCURRENT_STREAMS(4),	1✔
204	MAX_FRAME_SIZE(5),	1✔
205	MAX_HEADER_LIST_SIZE(6),	1✔
206	INITIAL_WINDOW_SIZE(7);	1✔
207
208	private final int bit;
209
210	SettingParams(int bit) {	1✔
211	this.bit = bit;	1✔
212	}	1✔
213
214	public int getBit() {
215	return this.bit;	1✔
216	}
217	}
218	}

grpc / grpc-java / #19945

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous