|
| 1 | +/* |
| 2 | + * Copyright 2026 Google LLC |
| 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 | + * https://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 | +package com.google.cloud.bigtable.data.v2.stub; |
| 17 | + |
| 18 | +import com.google.api.core.InternalApi; |
| 19 | +import com.google.api.gax.grpc.GrpcCallContext; |
| 20 | +import com.google.bigtable.v2.PeerInfo; |
| 21 | +import com.google.bigtable.v2.ResponseParams; |
| 22 | +import com.google.common.base.Strings; |
| 23 | +import com.google.protobuf.InvalidProtocolBufferException; |
| 24 | +import io.grpc.Attributes; |
| 25 | +import io.grpc.CallOptions; |
| 26 | +import io.grpc.Channel; |
| 27 | +import io.grpc.ClientCall; |
| 28 | +import io.grpc.ClientInterceptor; |
| 29 | +import io.grpc.ClientInterceptors; |
| 30 | +import io.grpc.ForwardingClientCall; |
| 31 | +import io.grpc.ForwardingClientCallListener; |
| 32 | +import io.grpc.Metadata; |
| 33 | +import io.grpc.MethodDescriptor; |
| 34 | +import io.grpc.Status; |
| 35 | +import io.grpc.alts.AltsContextUtil; |
| 36 | +import java.util.Base64; |
| 37 | +import java.util.regex.Matcher; |
| 38 | +import java.util.regex.Pattern; |
| 39 | +import javax.annotation.Nullable; |
| 40 | + |
| 41 | +@InternalApi |
| 42 | +public class MetadataExtractorInterceptor implements ClientInterceptor { |
| 43 | + private final SidebandData sidebandData = new SidebandData(); |
| 44 | + |
| 45 | + public GrpcCallContext injectInto(GrpcCallContext ctx) { |
| 46 | + // TODO: migrate to using .withTransportChannel |
| 47 | + // This will require a change on gax's side to expose the underlying ManagedChannel in |
| 48 | + // GrpcTransportChannel (its currently package private). |
| 49 | + return ctx.withChannel(ClientInterceptors.intercept(ctx.getChannel(), this)) |
| 50 | + .withCallOptions(ctx.getCallOptions().withOption(SidebandData.KEY, sidebandData)); |
| 51 | + } |
| 52 | + |
| 53 | + @Override |
| 54 | + public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall( |
| 55 | + MethodDescriptor<ReqT, RespT> methodDescriptor, CallOptions callOptions, Channel channel) { |
| 56 | + return new ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT>( |
| 57 | + channel.newCall(methodDescriptor, callOptions)) { |
| 58 | + @Override |
| 59 | + public void start(Listener<RespT> responseListener, Metadata headers) { |
| 60 | + sidebandData.reset(); |
| 61 | + |
| 62 | + super.start( |
| 63 | + new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>( |
| 64 | + responseListener) { |
| 65 | + @Override |
| 66 | + public void onHeaders(Metadata headers) { |
| 67 | + sidebandData.onResponseHeaders(headers, getAttributes()); |
| 68 | + super.onHeaders(headers); |
| 69 | + } |
| 70 | + |
| 71 | + @Override |
| 72 | + public void onClose(Status status, Metadata trailers) { |
| 73 | + sidebandData.onClose(status, trailers); |
| 74 | + super.onClose(status, trailers); |
| 75 | + } |
| 76 | + }, |
| 77 | + headers); |
| 78 | + } |
| 79 | + }; |
| 80 | + } |
| 81 | + |
| 82 | + public SidebandData getSidebandData() { |
| 83 | + return sidebandData; |
| 84 | + } |
| 85 | + |
| 86 | + public static class SidebandData { |
| 87 | + private static final CallOptions.Key<SidebandData> KEY = |
| 88 | + CallOptions.Key.create("bigtable-sideband"); |
| 89 | + |
| 90 | + private static final Metadata.Key<String> SERVER_TIMING_HEADER_KEY = |
| 91 | + Metadata.Key.of("server-timing", Metadata.ASCII_STRING_MARSHALLER); |
| 92 | + private static final Pattern SERVER_TIMING_HEADER_PATTERN = |
| 93 | + Pattern.compile(".*dur=(?<dur>\\d+)"); |
| 94 | + private static final Metadata.Key<byte[]> LOCATION_METADATA_KEY = |
| 95 | + Metadata.Key.of("x-goog-ext-425905942-bin", Metadata.BINARY_BYTE_MARSHALLER); |
| 96 | + private static final Metadata.Key<String> PEER_INFO_KEY = |
| 97 | + Metadata.Key.of("bigtable-peer-info", Metadata.ASCII_STRING_MARSHALLER); |
| 98 | + |
| 99 | + @Nullable private volatile ResponseParams responseParams; |
| 100 | + @Nullable private volatile PeerInfo peerInfo; |
| 101 | + @Nullable private volatile Long gfeTiming; |
| 102 | + |
| 103 | + @Nullable |
| 104 | + public ResponseParams getResponseParams() { |
| 105 | + return responseParams; |
| 106 | + } |
| 107 | + |
| 108 | + @Nullable |
| 109 | + public PeerInfo getPeerInfo() { |
| 110 | + return peerInfo; |
| 111 | + } |
| 112 | + |
| 113 | + @Nullable |
| 114 | + public Long getGfeTiming() { |
| 115 | + return gfeTiming; |
| 116 | + } |
| 117 | + |
| 118 | + private void reset() { |
| 119 | + responseParams = null; |
| 120 | + peerInfo = null; |
| 121 | + gfeTiming = null; |
| 122 | + } |
| 123 | + |
| 124 | + void onResponseHeaders(Metadata md, Attributes attributes) { |
| 125 | + responseParams = extractResponseParams(md); |
| 126 | + gfeTiming = extractGfeLatency(md); |
| 127 | + peerInfo = extractPeerInfo(md, gfeTiming, attributes); |
| 128 | + } |
| 129 | + |
| 130 | + void onClose(Status status, Metadata trailers) { |
| 131 | + if (responseParams == null) { |
| 132 | + responseParams = extractResponseParams(trailers); |
| 133 | + } |
| 134 | + } |
| 135 | + |
| 136 | + @Nullable |
| 137 | + private static Long extractGfeLatency(Metadata metadata) { |
| 138 | + String serverTiming = metadata.get(SERVER_TIMING_HEADER_KEY); |
| 139 | + if (serverTiming == null) { |
| 140 | + return null; |
| 141 | + } |
| 142 | + Matcher matcher = SERVER_TIMING_HEADER_PATTERN.matcher(serverTiming); |
| 143 | + // this should always be true |
| 144 | + if (matcher.find()) { |
| 145 | + return Long.parseLong(matcher.group("dur")); |
| 146 | + } |
| 147 | + return null; |
| 148 | + } |
| 149 | + |
| 150 | + @Nullable |
| 151 | + private static PeerInfo extractPeerInfo( |
| 152 | + Metadata metadata, Long gfeTiming, Attributes attributes) { |
| 153 | + String encodedStr = metadata.get(PEER_INFO_KEY); |
| 154 | + if (Strings.isNullOrEmpty(encodedStr)) { |
| 155 | + return null; |
| 156 | + } |
| 157 | + |
| 158 | + try { |
| 159 | + byte[] decoded = Base64.getUrlDecoder().decode(encodedStr); |
| 160 | + PeerInfo peerInfo = PeerInfo.parseFrom(decoded); |
| 161 | + PeerInfo.TransportType effectiveTransport = peerInfo.getTransportType(); |
| 162 | + |
| 163 | + // TODO: remove this once transport_type is being sent by the server |
| 164 | + // This is a temporary workaround to detect directpath until its available from the server |
| 165 | + if (effectiveTransport == PeerInfo.TransportType.TRANSPORT_TYPE_UNKNOWN) { |
| 166 | + boolean isAlts = AltsContextUtil.check(attributes); |
| 167 | + if (isAlts) { |
| 168 | + effectiveTransport = PeerInfo.TransportType.TRANSPORT_TYPE_DIRECT_ACCESS; |
| 169 | + } else if (gfeTiming != null) { |
| 170 | + effectiveTransport = PeerInfo.TransportType.TRANSPORT_TYPE_CLOUD_PATH; |
| 171 | + } |
| 172 | + } |
| 173 | + if (effectiveTransport != PeerInfo.TransportType.TRANSPORT_TYPE_UNKNOWN) { |
| 174 | + peerInfo = peerInfo.toBuilder().setTransportType(effectiveTransport).build(); |
| 175 | + } |
| 176 | + return peerInfo; |
| 177 | + } catch (Exception e) { |
| 178 | + throw new IllegalArgumentException( |
| 179 | + "Failed to parse " |
| 180 | + + PEER_INFO_KEY.name() |
| 181 | + + " from the response header value: " |
| 182 | + + encodedStr); |
| 183 | + } |
| 184 | + } |
| 185 | + |
| 186 | + @Nullable |
| 187 | + private static ResponseParams extractResponseParams(Metadata metadata) { |
| 188 | + byte[] responseParams = metadata.get(LOCATION_METADATA_KEY); |
| 189 | + if (responseParams != null) { |
| 190 | + try { |
| 191 | + return ResponseParams.parseFrom(responseParams); |
| 192 | + } catch (InvalidProtocolBufferException e) { |
| 193 | + } |
| 194 | + } |
| 195 | + return null; |
| 196 | + } |
| 197 | + } |
| 198 | +} |
0 commit comments