feat: add retry config customization in app init

Author: thiagomorales

etc/firebase-admin.api.md

@@ -72,8 +72,10 @@ export interface AppOptions {
     credential?: Credential;
     databaseAuthVariableOverride?: object | null;
     databaseURL?: string;
+    disableRetry?: boolean;
     httpAgent?: Agent;
     projectId?: string;
+    retryConfig?: RetryConfig;
     serviceAccountId?: string;
     storageBucket?: string;
 }
@@ -470,6 +472,15 @@ export namespace remoteConfig {
     export type Version = Version;
 }
 
+// @public
+export interface RetryConfig {
+    backOffFactor?: number;
+    ioErrorCodes?: string[];
+    maxDelayInMillis: number;
+    maxRetries: number;
+    statusCodes?: number[];
+}
+
 // @public (undocumented)
 export const SDK_VERSION: string;
 

etc/firebase-admin.app.api.md

@@ -22,8 +22,10 @@ export interface AppOptions {
     credential?: Credential;
     databaseAuthVariableOverride?: object | null;
     databaseURL?: string;
+    disableRetry?: boolean;
     httpAgent?: Agent;
     projectId?: string;
+    retryConfig?: RetryConfig;
     serviceAccountId?: string;
     storageBucket?: string;
 }
@@ -73,6 +75,15 @@ export function initializeApp(options?: AppOptions, appName?: string): App;
 // @public
 export function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;
 
+// @public
+export interface RetryConfig {
+    backOffFactor?: number;
+    ioErrorCodes?: string[];
+    maxDelayInMillis: number;
+    maxRetries: number;
+    statusCodes?: number[];
+}
+
 // @public (undocumented)
 export const SDK_VERSION: string;
 

src/app/core.ts

@@ -18,6 +18,7 @@
 import { Agent } from 'http';
 
 import { Credential } from './credential';
+import { RetryConfig } from '.'
 
 /**
  * Available options to pass to {@link firebase-admin.app#initializeApp}.
@@ -83,6 +84,16 @@ export interface AppOptions {
    * specifying an HTTP Agent in the corresponding factory methods.
    */
   httpAgent?: Agent;
+
+  /**
+   * The retry configuration that will be used in HttpClient for API Requests.
+   */
+  retryConfig?: RetryConfig;
+
+  /** 
+   * Completely disable the retry strategy in HttpClient. 
+  */
+  disableRetry?: boolean;
 }
 
 /**

src/app/index.ts

@@ -28,5 +28,6 @@ export { initializeApp, getApp, getApps, deleteApp } from './lifecycle';
 
 export { Credential, ServiceAccount, GoogleOAuthAccessToken } from './credential';
 export { applicationDefault, cert, refreshToken } from './credential-factory';
+export { RetryConfig } from '../utils/api-request'
 
 export const SDK_VERSION = getSdkVersion();

src/auth/auth-api-request.ts

@@ -48,7 +48,7 @@ const FIREBASE_AUTH_HEADER = {
   'X-Client-Version': `Node/Admin/${utils.getSdkVersion()}`,
 };
 /** Firebase Auth request timeout duration in milliseconds. */
-const FIREBASE_AUTH_TIMEOUT = 25000;
+const FIREBASE_AUTH_TIMEOUT = parseInt(process.env.FIREBASE_AUTH_TIMEOUT || '25000', 10);
 
 
 /** List of reserved claims which cannot be provided when creating a custom token. */

src/firebase-namespace-api.ts

@@ -91,6 +91,7 @@ export { projectManagement } from './project-management/project-management-names
 export { remoteConfig } from './remote-config/remote-config-namespace';
 export { securityRules } from './security-rules/security-rules-namespace';
 export { storage } from './storage/storage-namespace';
+export { RetryConfig } from './utils/api-request'
 
 // Declare other top-level members of the admin namespace below. Unfortunately, there's no
 // compile-time mechanism to ensure that the FirebaseNamespace class actually provides these

src/messaging/batch-request-internal.ts

@@ -20,7 +20,7 @@ import {
 import { FirebaseAppError, AppErrorCodes } from '../utils/error';
 
 const PART_BOUNDARY = '__END_OF_PART__';
-const TEN_SECONDS_IN_MILLIS = 10000;
+const FIREBASE_MESSAGING_BATCH_TIMEOUT = parseInt(process.env.FIREBASE_MESSAGING_BATCH_TIMEOUT || '10000', 10);
 
 /**
  * Represents a request that can be sent as part of an HTTP batch request.
@@ -72,7 +72,7 @@ export class BatchRequestClient {
       url: this.batchUrl,
       data: this.getMultipartPayload(requests),
       headers: Object.assign({}, this.commonHeaders, requestHeaders),
-      timeout: TEN_SECONDS_IN_MILLIS,
+      timeout: FIREBASE_MESSAGING_BATCH_TIMEOUT,
     };
     return this.httpClient.send(request).then((response) => {
       if (!response.multipart) {

src/messaging/messaging-api-request-internal.ts

@@ -27,7 +27,7 @@ import { SendResponse, BatchResponse } from './messaging-api';
 
 
 // FCM backend constants
-const FIREBASE_MESSAGING_TIMEOUT = 10000;
+const FIREBASE_MESSAGING_TIMEOUT = parseInt(process.env.FIREBASE_MESSAGING_TIMEOUT || '10000', 10);
 const FIREBASE_MESSAGING_BATCH_URL = 'https://fcm.googleapis.com/batch';
 const FIREBASE_MESSAGING_HTTP_METHOD: HttpMethod = 'POST';
 const FIREBASE_MESSAGING_HEADERS = {

src/project-management/project-management-api-request-internal.ts

@@ -36,7 +36,7 @@ const PROJECT_MANAGEMENT_HEADERS = {
   'X-Client-Version': `Node/Admin/${getSdkVersion()}`,
 };
 /** Project management request timeout duration in milliseconds. */
-const PROJECT_MANAGEMENT_TIMEOUT_MILLIS = 10000;
+const FIREBASE_PROJECT_MANAGEMENT_TIMEOUT = parseInt(process.env.FIREBASE_PROJECT_MANAGEMENT_TIMEOUT || '10000', 10);
 
 const LIST_APPS_MAX_PAGE_SIZE = 100;
 
@@ -315,7 +315,7 @@ export class ProjectManagementRequestHandler {
       url: `${baseUrlToUse}${path}`,
       headers: PROJECT_MANAGEMENT_HEADERS,
       data: requestData,
-      timeout: PROJECT_MANAGEMENT_TIMEOUT_MILLIS,
+      timeout: FIREBASE_PROJECT_MANAGEMENT_TIMEOUT,
     };
 
     return this.httpClient.send(request)

src/utils/api-request.ts

@@ -243,8 +243,13 @@ function validateRetryConfig(retry: RetryConfig): void {
 
 export class HttpClient {
 
-  constructor(private readonly retry: RetryConfig | null = defaultRetryConfig()) {
-    if (this.retry) {
+  constructor(
+    private readonly retry: RetryConfig | null = null, 
+    private readonly disableRetry: boolean = false
+  ) {
+    if (!this.disableRetry && !this.retry) {
+      this.retry = defaultRetryConfig();
+    } else if (!this.disableRetry && this.retry) {
       validateRetryConfig(this.retry);
     }
   }
@@ -345,7 +350,7 @@ export class HttpClient {
   }
 
   private isRetryEligible(retryAttempts: number, err: LowLevelError): boolean {
-    if (!this.retry) {
+    if (this.disableRetry || !this.retry) {
       return false;
     }
 
@@ -811,7 +816,7 @@ class HttpRequestConfigImpl implements HttpRequestConfig {
 
 export class AuthorizedHttpClient extends HttpClient {
   constructor(private readonly app: FirebaseApp) {
-    super();
+    super(app.options.retryConfig, app.options.disableRetry);
   }
 
   public send(request: HttpRequestConfig): Promise<HttpResponse> {