feat: add retryOptions passing to underlying Service class (#1390)

alvarowolfx · web-flow · commit a7cd3af419a1 · 2024-07-16T16:19:39.000-04:00
diff --git a/src/bigquery.ts b/src/bigquery.ts
@@ -43,7 +43,10 @@ import {
   JobResponse,
   RowMetadata,
 } from './table';
-import {GoogleErrorBody} from '@google-cloud/common/build/src/util';
+import {
+  GoogleErrorBody,
+  RetryOptions,
+} from '@google-cloud/common/build/src/util';
 import bigquery from './types';
 import {logger, setLogFunction} from './logger';
 
@@ -216,16 +219,35 @@ export interface BigQueryOptions extends GoogleAuthOptions {
    * We will exponentially backoff subsequent requests by default.
    *
    * Defaults to `true`.
+   *
+   * @deprecated Use retryOptions.
    */
   autoRetry?: boolean;
   /**
    * Maximum number of automatic retries
    * attempted before returning the error.
    *
    * Defaults to 3.
+   *
+   * @deprecated Use retryOptions.
    */
   maxRetries?: number;
 
+  /**
+   * Customize retry configuration for all requests in the SDK.
+   * By default, a request is retried if the response is related to rate limits
+   * or certain intermittent server errors.
+   * We will exponentially backoff subsequent requests by default.
+   *
+   * More on the default retry predicate on the `shouldRetryRequest` method:
+   * https://github.com/googleapis/nodejs-common/blob/main/src/util.ts
+   *
+   * Defaults:
+   * - retryOptions.autoRetry: true
+   * - retryOptions.maxRetries: 3
+   */
+  retryOptions?: RetryOptions;
+
   /**
    * The geographic location of all datasets and
    * jobs referenced and created through the client.
@@ -388,6 +410,7 @@ export class BigQuery extends Service {
       packageJson: require('../../package.json'),
       autoRetry: options.autoRetry,
       maxRetries: options.maxRetries,
+      retryOptions: options.retryOptions,
     };
 
     if (options.scopes) {
diff --git a/test/bigquery.ts b/test/bigquery.ts
@@ -325,6 +325,19 @@ describe('BigQuery', () => {
       assert.deepStrictEqual(calledWith.maxRetries, retryVal);
     });
 
+    it('should pass retryOptions from options', () => {
+      const retryOptions = {
+        autoRetry: true,
+        maxRetries: 3,
+      };
+      const bq = new BigQuery({
+        retryOptions: retryOptions,
+      });
+
+      const calledWith = bq.calledWith_[0];
+      assert.deepStrictEqual(calledWith.retryOptions, retryOptions);
+    });
+
     it('should not modify options argument', () => {
       const options = {
         projectId: PROJECT_ID,
