Skip to content

chore: Refactor HttpJson Callables to include Tracing #2546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
package com.google.api.gax.httpjson;

import com.google.api.core.InternalApi;
import com.google.api.core.ObsoleteApi;
import com.google.api.gax.longrunning.OperationSnapshot;
import com.google.api.gax.rpc.BatchingCallSettings;
import com.google.api.gax.rpc.Callables;
Expand All @@ -41,11 +40,15 @@
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.ServerStreamingCallSettings;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.gax.tracing.SpanName;
import com.google.api.gax.tracing.TracedBatchingCallable;
import com.google.api.gax.tracing.TracedServerStreamingCallable;
import com.google.api.gax.tracing.TracedUnaryCallable;
import com.google.common.base.Preconditions;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nonnull;
Expand All @@ -59,8 +62,9 @@ public class HttpJsonCallableFactory {

private HttpJsonCallableFactory() {}

private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createDirectUnaryCallable(
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings) {
private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
Set<StatusCode.Code> retryableCodes) {
UnaryCallable<RequestT, ResponseT> callable =
new HttpJsonDirectCallable<>(
httpJsonCallSettings.getMethodDescriptor(), httpJsonCallSettings.getTypeRegistry());
Expand All @@ -70,33 +74,7 @@ private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createDi
new HttpJsonUnaryRequestParamCallable<>(
callable, httpJsonCallSettings.getParamsExtractor());
}
return callable;
}

/** Create httpJson UnaryCallable with request mutator. */
static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(
UnaryCallable<RequestT, ResponseT> innerCallable,
UnaryCallSettings<?, ?> callSettings,
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> callable =
new HttpJsonExceptionCallable<>(innerCallable, callSettings.getRetryableCodes());
callable =
Callables.retrying(
callable, callSettings, clientContext, httpJsonCallSettings.getRequestMutator());
return callable.withDefaultCallContext(clientContext.getDefaultCallContext());
}

/** Use {@link #createUnaryCallable createUnaryCallable} method instead. */
@ObsoleteApi("Please use other httpJson UnaryCallable method instead")
static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(
UnaryCallable<RequestT, ResponseT> innerCallable,
UnaryCallSettings<?, ?> callSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> callable =
new HttpJsonExceptionCallable<>(innerCallable, callSettings.getRetryableCodes());
callable = Callables.retrying(callable, callSettings, clientContext);
return callable.withDefaultCallContext(clientContext.getDefaultCallContext());
return new HttpJsonExceptionCallable<>(callable, retryableCodes);
}

/**
Expand All @@ -111,12 +89,15 @@ public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createBas
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
UnaryCallSettings<?, ?> callSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> callable = createDirectUnaryCallable(httpJsonCallSettings);
callable = new HttpJsonExceptionCallable<>(callable, callSettings.getRetryableCodes());
callable =
Callables.retrying(
callable, callSettings, clientContext, httpJsonCallSettings.getRequestMutator());

UnaryCallable<RequestT, ResponseT> callable =
createUnaryCallable(httpJsonCallSettings, callSettings.getRetryableCodes());
if (httpJsonCallSettings.getRequestMutator() != null) {
callable =
Callables.retrying(
callable, callSettings, clientContext, httpJsonCallSettings.getRequestMutator());
} else {
callable = Callables.retrying(callable, callSettings, clientContext);
}
return callable;
}

Expand All @@ -133,16 +114,15 @@ public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUna
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
UnaryCallSettings<RequestT, ResponseT> callSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> innerCallable =
createDirectUnaryCallable(httpJsonCallSettings);

innerCallable =
UnaryCallable<RequestT, ResponseT> callable =
createBaseUnaryCallable(httpJsonCallSettings, callSettings, clientContext);
callable =
new TracedUnaryCallable<>(
innerCallable,
callable,
clientContext.getTracerFactory(),
getSpanName(httpJsonCallSettings.getMethodDescriptor()));

return createUnaryCallable(innerCallable, callSettings, httpJsonCallSettings, clientContext);
return callable.withDefaultCallContext(clientContext.getDefaultCallContext());
}

/**
Expand All @@ -159,9 +139,8 @@ UnaryCallable<RequestT, PagedListResponseT> createPagedCallable(
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
PagedCallSettings<RequestT, ResponseT, PagedListResponseT> pagedCallSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> callable = createDirectUnaryCallable(httpJsonCallSettings);
callable =
createUnaryCallable(callable, pagedCallSettings, httpJsonCallSettings, clientContext);
UnaryCallable<RequestT, ResponseT> callable =
createUnaryCallable(httpJsonCallSettings, pagedCallSettings.getRetryableCodes());
UnaryCallable<RequestT, PagedListResponseT> pagedCallable =
Callables.paged(callable, pagedCallSettings);
return pagedCallable.withDefaultCallContext(clientContext.getDefaultCallContext());
Expand All @@ -181,9 +160,14 @@ public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createBat
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
BatchingCallSettings<RequestT, ResponseT> batchingCallSettings,
ClientContext clientContext) {
UnaryCallable<RequestT, ResponseT> callable = createDirectUnaryCallable(httpJsonCallSettings);
UnaryCallable<RequestT, ResponseT> callable =
createBaseUnaryCallable(httpJsonCallSettings, batchingCallSettings, clientContext);
callable =
createUnaryCallable(callable, batchingCallSettings, httpJsonCallSettings, clientContext);
new TracedBatchingCallable<>(
callable,
clientContext.getTracerFactory(),
getSpanName(httpJsonCallSettings.getMethodDescriptor()),
batchingCallSettings.getBatchingDescriptor());
callable = Callables.batching(callable, batchingCallSettings, clientContext);
return callable.withDefaultCallContext(clientContext.getDefaultCallContext());
}
Expand Down Expand Up @@ -224,6 +208,13 @@ ServerStreamingCallable<RequestT, ResponseT> createServerStreamingCallable(
}

callable = Callables.retrying(callable, streamingCallSettings, clientContext);

callable =
new TracedServerStreamingCallable<>(
callable,
clientContext.getTracerFactory(),
getSpanName(httpJsoncallSettings.getMethodDescriptor()));

return callable.withDefaultCallContext(clientContext.getDefaultCallContext());
}

Expand Down
Loading
Loading