Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: improve information on CancellationException for LROs (#2236)
* fix: point to documentation on LRO CancelledException * mvn fmt:format * add test for http IT in LRO * format code * use final variable on LRO cancellation * Wrap guava's CancellationException in our own Exception * reset test and basic retry future * use logging to inform of failed LRO * add license and comment to fake log handler * format code * fix license * format souce * decrease LRO timeout logging level to WARNING * fix logging threshold check * use common log handler setup for ITLongRunningOperation * fix license header year * format source * reset lro it * change to unit tests * reset testjar exports * simplify unit test * use instance variables in test
- Loading branch information
1 parent
9d30ed9
commit 741e40c
Showing
5 changed files
with
193 additions
and
22 deletions.
There are no files selected for viewing
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
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
114 changes: 114 additions & 0 deletions
114
...ava/gax/src/test/java/com/google/api/gax/longrunning/OperationTimedPollAlgorithmTest.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,114 @@ | ||
| /* | ||
| * Copyright 2023 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.longrunning; | ||
|
|
||
| import static org.junit.Assert.assertThrows; | ||
| import static org.junit.Assert.assertTrue; | ||
| import static org.junit.Assert.fail; | ||
|
|
||
| import com.google.api.gax.core.FakeApiClock; | ||
| import com.google.api.gax.retrying.RetrySettings; | ||
| import com.google.api.gax.retrying.TimedAttemptSettings; | ||
| import com.google.api.gax.util.FakeLogHandler; | ||
| import java.util.concurrent.CancellationException; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.threeten.bp.Duration; | ||
|
|
||
| public class OperationTimedPollAlgorithmTest { | ||
|
|
||
| private static final RetrySettings FAST_RETRY_SETTINGS = | ||
| RetrySettings.newBuilder() | ||
| .setInitialRetryDelay(Duration.ofMillis(1L)) | ||
| .setRetryDelayMultiplier(1) | ||
| .setMaxRetryDelay(Duration.ofMillis(1L)) | ||
| .setInitialRpcTimeout(Duration.ofMillis(1L)) | ||
| .setMaxAttempts(0) | ||
| .setJittered(false) | ||
| .setRpcTimeoutMultiplier(1) | ||
| .setMaxRpcTimeout(Duration.ofMillis(1L)) | ||
| .setTotalTimeout(Duration.ofMillis(5L)) | ||
| .build(); | ||
| private TimedAttemptSettings timedAttemptSettings; | ||
| private FakeApiClock clock; | ||
|
|
||
| private FakeLogHandler logHandler; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| logHandler = new FakeLogHandler(); | ||
| OperationTimedPollAlgorithm.LOGGER.addHandler(logHandler); | ||
| clock = new FakeApiClock(System.nanoTime()); | ||
| timedAttemptSettings = | ||
| TimedAttemptSettings.newBuilder() | ||
| .setGlobalSettings(FAST_RETRY_SETTINGS) | ||
| .setRetryDelay(Duration.ofMillis(1l)) | ||
| .setRpcTimeout(Duration.ofMillis(1l)) | ||
| .setRandomizedRetryDelay(Duration.ofMillis(1l)) | ||
| .setAttemptCount(0) | ||
| .setFirstAttemptStartTimeNanos(clock.nanoTime()) | ||
| .build(); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| OperationTimedPollAlgorithm.LOGGER.removeHandler(logHandler); | ||
| // redundant null assignment for readability - a new log handler will be used | ||
| logHandler = null; | ||
| } | ||
|
|
||
| @Test | ||
| public void testAlgorithmThatShouldRetry_doesNotLogTimeoutHelpMessage() { | ||
| OperationTimedPollAlgorithm algorithm = | ||
| OperationTimedPollAlgorithm.create(FAST_RETRY_SETTINGS, clock); | ||
| try { | ||
| algorithm.shouldRetry(timedAttemptSettings); | ||
| } catch (CancellationException ex) { | ||
| fail("Unexpected unsuccessful shouldRetry()"); | ||
| } | ||
| assertTrue( | ||
| logHandler.getAllMessages().stream() | ||
| .noneMatch( | ||
| entry -> entry.contains(OperationTimedPollAlgorithm.LRO_TROUBLESHOOTING_LINK))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testAlgorithmThatShouldNotRetry_logsTimeoutHelpMessage() { | ||
| OperationTimedPollAlgorithm algorithm = | ||
| OperationTimedPollAlgorithm.create(FAST_RETRY_SETTINGS, clock); | ||
| clock.incrementNanoTime(1 * 1000 * 1000 * 1000); // force rpc timeout | ||
| assertThrows(CancellationException.class, () -> algorithm.shouldRetry(timedAttemptSettings)); | ||
| assertTrue( | ||
| logHandler.getAllMessages().stream() | ||
| .anyMatch( | ||
| entry -> entry.contains(OperationTimedPollAlgorithm.LRO_TROUBLESHOOTING_LINK))); | ||
| } | ||
| } |
59 changes: 59 additions & 0 deletions
59
gax-java/gax/src/test/java/com/google/api/gax/util/FakeLogHandler.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,59 @@ | ||
| /* | ||
| * Copyright 2023 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.util; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.logging.Handler; | ||
| import java.util.logging.LogRecord; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /* | ||
| * Convenience class that stores the log entries produced by any logger | ||
| * It can then be inspected - its entries are a list log records | ||
| */ | ||
| public class FakeLogHandler extends Handler { | ||
| List<LogRecord> records = new ArrayList<>(); | ||
|
|
||
| @Override | ||
| public void publish(LogRecord record) { | ||
| records.add(record); | ||
| } | ||
|
|
||
| @Override | ||
| public void flush() {} | ||
|
|
||
| @Override | ||
| public void close() throws SecurityException {} | ||
|
|
||
| public List<String> getAllMessages() { | ||
| return records.stream().map(LogRecord::getMessage).collect(Collectors.toList()); | ||
| } | ||
| } |