-
Notifications
You must be signed in to change notification settings - Fork 289
fix: Enabled automatic HTTP retries for FirebaseProjectManagement #356
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e260b9f
Enabled automatic HTTP retries for FirebaseProjectManagement
hiranya911 fffdae8
Added some test cases
hiranya911 78ff994
Added helper function for disabling exponential backoff during tests
hiranya911 8be0e06
Added util class for simplifying retry tests
hiranya911 e7742c3
Simplified test cases
hiranya911 666fa3c
Removed unused method
hiranya911 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
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
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
95 changes: 95 additions & 0 deletions
95
src/test/java/com/google/firebase/internal/TestApiClientUtils.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,95 @@ | ||
| /* | ||
| * Copyright 2020 Google Inc. | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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.firebase.internal; | ||
|
|
||
| import static com.google.firebase.internal.ApiClientUtils.DEFAULT_RETRY_CONFIG; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertFalse; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import com.google.api.client.http.GenericUrl; | ||
| import com.google.api.client.http.HttpRequest; | ||
| import com.google.api.client.http.HttpRequestFactory; | ||
| import com.google.api.client.http.HttpUnsuccessfulResponseHandler; | ||
| import com.google.api.client.testing.util.MockSleeper; | ||
| import com.google.firebase.FirebaseApp; | ||
| import com.google.firebase.internal.RetryInitializer.RetryHandlerDecorator; | ||
| import java.io.IOException; | ||
|
|
||
| public class TestApiClientUtils { | ||
|
|
||
| private static final RetryConfig TEST_RETRY_CONFIG = RetryConfig.builder() | ||
| .setMaxRetries(DEFAULT_RETRY_CONFIG.getMaxRetries()) | ||
| .setRetryStatusCodes(DEFAULT_RETRY_CONFIG.getRetryStatusCodes()) | ||
| .setMaxIntervalMillis(DEFAULT_RETRY_CONFIG.getMaxIntervalMillis()) | ||
| .setSleeper(new MockSleeper()) | ||
| .build(); | ||
|
|
||
| private static final GenericUrl TEST_URL = new GenericUrl("https://firebase.google.com"); | ||
|
|
||
| /** | ||
| * Creates a new {@code HttpRequestFactory} which provides authorization (OAuth2), timeouts and | ||
| * automatic retries. Bypasses exponential backoff between consecutive retries for faster | ||
| * execution during tests. | ||
| * | ||
| * @param app {@link FirebaseApp} from which to obtain authorization credentials. | ||
| * @return A new {@code HttpRequestFactory} instance. | ||
| */ | ||
| public static HttpRequestFactory delayBypassedRequestFactory(FirebaseApp app) { | ||
| return ApiClientUtils.newAuthorizedRequestFactory(app, TEST_RETRY_CONFIG); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new {@code HttpRequestFactory} which provides authorization (OAuth2), timeouts but | ||
| * no retries. | ||
| * | ||
| * @param app {@link FirebaseApp} from which to obtain authorization credentials. | ||
| * @return A new {@code HttpRequestFactory} instance. | ||
| */ | ||
| public static HttpRequestFactory retryDisabledRequestFactory(FirebaseApp app) { | ||
| return ApiClientUtils.newAuthorizedRequestFactory(app, null); | ||
| } | ||
|
|
||
| /** | ||
| * Checks whther the given HttpRequestFactory has been configured for authorization and | ||
| * automatic retries. | ||
| * | ||
| * @param requestFactory The HttpRequestFactory to check. | ||
| */ | ||
| public static void assertAuthAndRetrySupport(HttpRequestFactory requestFactory) { | ||
| assertTrue(requestFactory.getInitializer() instanceof FirebaseRequestInitializer); | ||
| HttpRequest request; | ||
| try { | ||
| request = requestFactory.buildGetRequest(TEST_URL); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException("Failed to initialize request", e); | ||
| } | ||
|
|
||
| // Verify authorization | ||
| assertTrue(request.getHeaders().getAuthorization().startsWith("Bearer ")); | ||
|
|
||
| // Verify retry support | ||
| HttpUnsuccessfulResponseHandler retryHandler = request.getUnsuccessfulResponseHandler(); | ||
| assertTrue(retryHandler instanceof RetryHandlerDecorator); | ||
| RetryConfig retryConfig = ((RetryHandlerDecorator) retryHandler).getRetryHandler() | ||
| .getRetryConfig(); | ||
| assertEquals(DEFAULT_RETRY_CONFIG.getMaxRetries(), retryConfig.getMaxRetries()); | ||
| assertEquals(DEFAULT_RETRY_CONFIG.getMaxIntervalMillis(), retryConfig.getMaxIntervalMillis()); | ||
| assertFalse(retryConfig.isRetryOnIOExceptions()); | ||
| assertEquals(DEFAULT_RETRY_CONFIG.getRetryStatusCodes(), retryConfig.getRetryStatusCodes()); | ||
| } | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At first I kind of want to say we should bake this assertion into the API infrastructure itself instead of directly verifying in a unit test that no one touched the code. But then the OO design I came up with to facilitate this turns out to be impossible due to various classes being
final. I was hoping that we can write a subclass ofHttpRequestcalledRetryingHttpRequestthat declares at compile time thatgetUnsuccessfulResponseHandlerwill returnRetryHandlerDecoratoror a suitable base class, but alas,HttpRequestis final. (And so isHttpRequestFactory, which is the other class I wanted to subclass.)Without the above OO structure, the only other way to structure the test to be more behavioural would be to treat the retrying mechanism completely like a black box, and empirically measure retry intervals and retry counts after forcing an unsuccessful response. This is going to be painfully flaky, so I think what you have is probably for the best.