Skip to content

Automatically retrying on 503 errors #556

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.

Sign up for GitHub

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 6 commits into from
Jun 11, 2019
Merged

Automatically retrying on 503 errors #556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
412abb5
Automatically retrying on 503 errors
hiranya911 Jun 6, 2019
452a472
Using explicit RetryConfig for tests
hiranya911 Jun 7, 2019
de7396b
Added tests for defaultRetryConfig()
hiranya911 Jun 7, 2019
d7549e8
Merge branch 'master' into hkj-retry-503
hiranya911 Jun 7, 2019
c504de3
Merge branch 'master' into hkj-retry-503
hiranya911 Jun 7, 2019
e5e6a44
Using defaultRetryConfig() explicitly for clarity
hiranya911 Jun 10, 2019
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
apps in a Firebase project
- [added] `admin.projectManagement().setDisplayName()` method to update the display name of a
Firebase project
- [fixed] The SDK now automatically retries HTTP calls failing due to 503 errors.

# v8.0.0

Expand Down
20 changes: 13 additions & 7 deletions src/utils/api-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,19 @@ export interface RetryConfig {
}

/**
* Default retry configuration for HTTP requests. Retries once on connection reset and timeout errors.
* Default retry configuration for HTTP requests. Retries up to 4 times on connection reset and timeout errors
* as well as HTTP 503 errors. Exposed as a function to ensure that every HttpClient gets its own RetryConfig
* instance.
*/
const DEFAULT_RETRY_CONFIG: RetryConfig = {
maxRetries: 1,
ioErrorCodes: ['ECONNRESET', 'ETIMEDOUT'],
maxDelayInMillis: 60 * 1000,
};
export function defaultRetryConfig(): RetryConfig {
return {
maxRetries: 4,
statusCodes: [503],
ioErrorCodes: ['ECONNRESET', 'ETIMEDOUT'],
backOffFactor: 0.5,
maxDelayInMillis: 60 * 1000,
};
}

/**
* Ensures that the given RetryConfig object is valid.
Expand Down Expand Up @@ -233,7 +239,7 @@ function validateRetryConfig(retry: RetryConfig) {

export class HttpClient {

constructor(private readonly retry: RetryConfig = DEFAULT_RETRY_CONFIG) {
constructor(private readonly retry: RetryConfig = defaultRetryConfig()) {
if (this.retry) {
validateRetryConfig(this.retry);
}
Expand Down
8 changes: 8 additions & 0 deletions test/unit/messaging/messaging.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,9 @@ function mockTopicSubscriptionRequestWithError(
});
}

function disableRetries(messaging: Messaging) {
(messaging as any).messagingRequestHandler.httpClient.retry = null;
}

describe('Messaging', () => {
let mockApp: FirebaseApp;
Expand Down Expand Up @@ -1167,6 +1170,7 @@ describe('Messaging', () => {
_.forEach(STATUS_CODE_TO_ERROR_MAP, (expectedError, statusCode) => {
it(`should be rejected given a ${ statusCode } text server response`, () => {
mockedRequests.push(mockSendRequestWithError(parseInt(statusCode, 10), 'text'));
disableRetries(messaging);

return messaging.sendToDevice(
mocks.messaging.registrationToken,
Expand Down Expand Up @@ -1460,6 +1464,7 @@ describe('Messaging', () => {
_.forEach(STATUS_CODE_TO_ERROR_MAP, (expectedError, statusCode) => {
it(`should be rejected given a ${ statusCode } text server response`, () => {
mockedRequests.push(mockSendRequestWithError(parseInt(statusCode, 10), 'text'));
disableRetries(messaging);

return messaging.sendToDeviceGroup(
mocks.messaging.notificationKey,
Expand Down Expand Up @@ -1710,6 +1715,7 @@ describe('Messaging', () => {
_.forEach(STATUS_CODE_TO_ERROR_MAP, (expectedError, statusCode) => {
it(`should be rejected given a ${ statusCode } text server response`, () => {
mockedRequests.push(mockSendRequestWithError(parseInt(statusCode, 10), 'text'));
disableRetries(messaging);

return messaging.sendToTopic(
mocks.messaging.topic,
Expand Down Expand Up @@ -1928,6 +1934,7 @@ describe('Messaging', () => {
_.forEach(STATUS_CODE_TO_ERROR_MAP, (expectedError, statusCode) => {
it(`should be rejected given a ${ statusCode } text server response`, () => {
mockedRequests.push(mockSendRequestWithError(parseInt(statusCode, 10), 'text'));
disableRetries(messaging);

return messaging.sendToCondition(
mocks.messaging.condition,
Expand Down Expand Up @@ -3398,6 +3405,7 @@ describe('Messaging', () => {
_.forEach(STATUS_CODE_TO_ERROR_MAP, (expectedError, statusCode) => {
it(`should be rejected given a ${ statusCode } text server response`, () => {
mockedRequests.push(mockTopicSubscriptionRequestWithError(methodName, parseInt(statusCode, 10), 'text'));
disableRetries(messaging);

return messagingService[methodName](
mocks.messaging.registrationToken,
Expand Down
Loading