-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: remodel unary callables as server streaming callables with an …
…adapter at the end Change-Id: I8708dff0e192d7647ef2cb361fc0992e1ddd2b24
- Loading branch information
1 parent
b40828c
commit ec03559
Showing
4 changed files
with
338 additions
and
10 deletions.
There are no files selected for viewing
183 changes: 183 additions & 0 deletions
183
.../src/main/java/com/google/cloud/bigtable/data/v2/stub/BigtableUnaryOperationCallable.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * 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 | ||
| * | ||
| * https://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 com.google.cloud.bigtable.data.v2.stub; | ||
|
|
||
| import com.google.api.core.AbstractApiFuture; | ||
| import com.google.api.core.ApiFuture; | ||
| import com.google.api.gax.grpc.GrpcStatusCode; | ||
| import com.google.api.gax.rpc.ApiCallContext; | ||
| import com.google.api.gax.rpc.InternalException; | ||
| import com.google.api.gax.rpc.ResponseObserver; | ||
| import com.google.api.gax.rpc.ServerStreamingCallable; | ||
| import com.google.api.gax.rpc.StreamController; | ||
| import com.google.api.gax.rpc.UnaryCallable; | ||
| import com.google.api.gax.tracing.ApiTracer; | ||
| import com.google.api.gax.tracing.ApiTracerFactory; | ||
| import com.google.api.gax.tracing.SpanName; | ||
| import com.google.common.base.Preconditions; | ||
| import io.grpc.Status; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Helper to convert a fake {@link ServerStreamingCallable} (ie only up to 1 response) into a {@link | ||
| * UnaryCallable}. It is intended to be the outermost callable of a chain. | ||
| * | ||
| * <p>Responsibilities: | ||
| * | ||
| * <ul> | ||
| * <li>Operation level metrics | ||
| * <li>Configuring the default call context | ||
| * <li>Converting the result to a future | ||
| */ | ||
| class BigtableUnaryOperationCallable<ReqT, RespT> extends UnaryCallable<ReqT, RespT> { | ||
| private static final Logger LOGGER = | ||
| Logger.getLogger(BigtableUnaryOperationCallable.class.getName()); | ||
|
|
||
| private final ServerStreamingCallable<ReqT, RespT> inner; | ||
| private final ApiCallContext defaultCallContext; | ||
| private final ApiTracerFactory tracerFactory; | ||
| private final SpanName spanName; | ||
| private final boolean allowNoResponse; | ||
|
|
||
| public BigtableUnaryOperationCallable( | ||
| ServerStreamingCallable<ReqT, RespT> inner, | ||
| ApiCallContext defaultCallContext, | ||
| ApiTracerFactory tracerFactory, | ||
| SpanName spanName, | ||
| boolean allowNoResponse) { | ||
| this.inner = inner; | ||
| this.defaultCallContext = defaultCallContext; | ||
| this.tracerFactory = tracerFactory; | ||
| this.spanName = spanName; | ||
| this.allowNoResponse = allowNoResponse; | ||
| } | ||
|
|
||
| @Override | ||
| public ApiFuture<RespT> futureCall(ReqT req, ApiCallContext apiCallContext) { | ||
| apiCallContext = defaultCallContext.merge(apiCallContext); | ||
|
|
||
| ApiTracer apiTracer = | ||
| tracerFactory.newTracer( | ||
| apiCallContext.getTracer(), spanName, ApiTracerFactory.OperationType.Unary); | ||
|
|
||
| apiCallContext = apiCallContext.withTracer(apiTracer); | ||
|
|
||
| UnaryFuture f = new UnaryFuture(apiTracer, allowNoResponse); | ||
| inner.call(req, f, apiCallContext); | ||
| return f; | ||
| } | ||
|
|
||
| class UnaryFuture extends AbstractApiFuture<RespT> implements ResponseObserver<RespT> { | ||
| private final ApiTracer tracer; | ||
| private final boolean allowNoResponse; | ||
|
|
||
| private StreamController controller; | ||
| private boolean responseReceived; | ||
| private @Nullable RespT response; | ||
|
|
||
| private UnaryFuture(ApiTracer tracer, boolean allowNoResponse) { | ||
| this.tracer = Preconditions.checkNotNull(tracer, "tracer can't be null"); | ||
| this.allowNoResponse = allowNoResponse; | ||
| this.responseReceived = false; | ||
| } | ||
|
|
||
| @Override | ||
| public void onStart(StreamController controller) { | ||
| this.controller = controller; | ||
| controller.disableAutoInboundFlowControl(); | ||
| // Request 2 to detect protocol bugs | ||
| controller.request(2); | ||
| } | ||
|
|
||
| /** | ||
| * Immediately cancel the future state and try to cancel the underlying operation. Will return | ||
| * false if the future is already resolved. | ||
| */ | ||
| @Override | ||
| public boolean cancel(boolean mayInterruptIfRunning) { | ||
| if (super.cancel(mayInterruptIfRunning)) { | ||
| controller.cancel(); | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void onResponse(RespT resp) { | ||
| tracer.responseReceived(); | ||
|
|
||
| if (responseReceived) { | ||
| String msg = | ||
| String.format( | ||
| "Received multiple responses for a %s unary operation. Previous: %s, New: %s", | ||
| spanName, resp, response); | ||
| LOGGER.log(Level.WARNING, msg); | ||
|
|
||
| InternalException error = | ||
| new InternalException(msg, null, GrpcStatusCode.of(Status.Code.INTERNAL), false); | ||
| if (setException(error)) { | ||
| tracer.operationFailed(error); | ||
| } | ||
|
|
||
| controller.cancel(); | ||
| return; | ||
| } | ||
|
|
||
| responseReceived = true; | ||
| this.response = resp; | ||
| this.tracer.responseReceived(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(Throwable throwable) { | ||
| if (this.setException(throwable)) { | ||
| tracer.operationFailed(throwable); | ||
| } else if (isCancelled()) { | ||
| tracer.operationCancelled(); | ||
| } | ||
| // The future might've been resolved due to double response | ||
| } | ||
|
|
||
| @Override | ||
| public void onComplete() { | ||
| // Sanity check server response counts | ||
| if (!allowNoResponse && !responseReceived) { | ||
| String msg = spanName + " unary operation completed without a response message"; | ||
| InternalException e = | ||
| new InternalException(msg, null, GrpcStatusCode.of(Status.Code.INTERNAL), false); | ||
|
|
||
| if (setException(e)) { | ||
| tracer.operationFailed(e); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| // check cancellation race | ||
| if (isCancelled()) { | ||
| tracer.operationCancelled(); | ||
| return; | ||
| } | ||
|
|
||
| // try to resolve the future | ||
| if (this.set(response)) { | ||
| tracer.operationSucceeded(); | ||
| return; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains 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
This file contains 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
Oops, something went wrong.