Repository navigation
fix(gax): make CompositeTracer completion-callback scoping best-effort #15121
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
Open
jinseopkim0
wants to merge
1
commit into
main
Choose a base branch
from
fix-composite-tracer-callback-scope-errors
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
134 changes: 134 additions & 0 deletions
134
...ava/gax-java/gax/src/test/java/com/google/api/gax/rpc/RetryingTracerScopeFailureTest.java
This file contains hidden or 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,134 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * * Neither the name of Google LLC nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package com.google.api.gax.rpc; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
|
|
||
| import com.google.api.core.ApiFuture; | ||
| import com.google.api.core.ApiFutures; | ||
| import com.google.api.core.NanoClock; | ||
| import com.google.api.gax.retrying.RetrySettings; | ||
| import com.google.api.gax.rpc.testing.FakeCallContext; | ||
| import com.google.api.gax.rpc.testing.FakeStatusCode; | ||
| import com.google.api.gax.tracing.ApiTracer; | ||
| import com.google.api.gax.tracing.ApiTracerFactory; | ||
| import com.google.api.gax.tracing.BaseApiTracer; | ||
| import com.google.api.gax.tracing.BaseApiTracerFactory; | ||
| import com.google.api.gax.tracing.CompositeTracerFactory; | ||
| import com.google.api.gax.tracing.SpanName; | ||
| import com.google.api.gax.tracing.TracedUnaryCallable; | ||
| import com.google.common.collect.ImmutableList; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| /** | ||
| * End-to-end regression test verifying that a retrying traced RPC future completes with the | ||
| * original RPC error instead of hanging when a child tracer's {@link ApiTracer#inScope()} throws. | ||
| */ | ||
| class RetryingTracerScopeFailureTest { | ||
| private ScheduledExecutorService executor; | ||
| private ClientContext clientContext; | ||
|
|
||
| /** Initializes a scheduled executor and {@link ClientContext} for retrying callable tests. */ | ||
| @BeforeEach | ||
| void setUp() { | ||
| executor = Executors.newSingleThreadScheduledExecutor(); | ||
| clientContext = | ||
| ClientContext.newBuilder() | ||
| .setExecutor(executor) | ||
| .setClock(NanoClock.getDefaultClock()) | ||
| .setDefaultCallContext(FakeCallContext.createDefault()) | ||
| .build(); | ||
| } | ||
|
|
||
| /** Shuts down the test executor. */ | ||
| @AfterEach | ||
| void tearDown() { | ||
| executor.shutdownNow(); | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that the retrying future completes immediately with the original RPC error even when a | ||
| * child tracer's {@link ApiTracer#inScope()} throws during completion callbacks. | ||
| */ | ||
| @Test | ||
| void retryingFutureCompletes_whenTracerScopeThrows() { | ||
| ApiException rpcError = | ||
| new InvalidArgumentException( | ||
| null, FakeStatusCode.of(StatusCode.Code.INVALID_ARGUMENT), false); | ||
|
|
||
| UnaryCallable<Integer, Integer> transport = | ||
| new UnaryCallable<Integer, Integer>() { | ||
| @Override | ||
| public ApiFuture<Integer> futureCall(Integer request, ApiCallContext context) { | ||
| return ApiFutures.immediateFailedFuture(rpcError); | ||
| } | ||
| }; | ||
|
|
||
| ApiTracer brokenScopeTracer = | ||
| new BaseApiTracer() { | ||
| @Override | ||
| public Scope inScope() { | ||
| throw new IllegalStateException("broken inScope()"); | ||
| } | ||
| }; | ||
|
|
||
| ApiTracerFactory tracerFactory = | ||
| new CompositeTracerFactory( | ||
| ImmutableList.of( | ||
| BaseApiTracerFactory.getInstance(), | ||
| (parent, spanName, operationType) -> brokenScopeTracer)); | ||
|
|
||
| UnaryCallSettings<Integer, Integer> callSettings = | ||
| UnaryCallSettings.<Integer, Integer>newUnaryCallSettingsBuilder() | ||
| .setRetryableCodes(StatusCode.Code.UNAVAILABLE) | ||
| .setRetrySettings(RetrySettings.newBuilder().setMaxAttempts(3).build()) | ||
| .build(); | ||
|
|
||
| UnaryCallable<Integer, Integer> callable = | ||
| new TracedUnaryCallable<>( | ||
| Callables.retrying(transport, callSettings, clientContext), | ||
| tracerFactory, | ||
| SpanName.of("FakeClient", "FakeMethod")); | ||
|
|
||
| ApiFuture<Integer> future = callable.futureCall(1, FakeCallContext.createDefault()); | ||
|
|
||
| // If the exception from inScope() escapes BasicRetryingFuture.handleAttempt, Guava's listener | ||
| // loop swallows it and the retrying future is never completed. | ||
| assertThat(future.isDone()).isTrue(); | ||
| ExecutionException e = assertThrows(ExecutionException.class, future::get); | ||
|
jinseopkim0 marked this conversation as resolved.
Resolved
|
||
| assertThat(e).hasCauseThat().isSameInstanceAs(rpcError); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.