feat: server streaming retries

gax/src/clientInterface.ts

@@ -37,6 +37,7 @@ export interface ClientOptions
   clientConfig?: gax.ClientConfig;
   fallback?: boolean | 'rest' | 'proto';
   apiEndpoint?: string;
+  gaxServerStreamingRetries?: boolean;
 }
 
 export interface Descriptors {

gax/src/createApiCall.ts

@@ -28,7 +28,7 @@ import {
   SimpleCallbackFunction,
 } from './apitypes';
 import {Descriptor} from './descriptor';
-import {CallOptions, CallSettings} from './gax';
+import {CallOptions, CallSettings, convertRetryOptions} from './gax';
 import {retryable} from './normalCalls/retries';
 import {addTimeoutArg} from './normalCalls/timeout';
 import {StreamingApiCaller} from './streamingCalls/streamingApiCaller';
@@ -63,7 +63,6 @@ export function createApiCall(
   // function. Currently client librares are only calling this method with a
   // promise, but it will change.
   const funcPromise = typeof func === 'function' ? Promise.resolve(func) : func;
-
   // the following apiCaller will be used for all calls of this function...
   const apiCaller = createAPICaller(settings, descriptor);
 
@@ -72,9 +71,22 @@ export function createApiCall(
     callOptions?: CallOptions,
     callback?: APICallback
   ) => {
-    const thisSettings = settings.merge(callOptions);
-
     let currentApiCaller = apiCaller;
+
+    let thisSettings: CallSettings;
+    if (currentApiCaller instanceof StreamingApiCaller) {
+      const gaxStreamingRetries =
+        currentApiCaller.descriptor?.gaxStreamingRetries ?? false;
+      // If Gax streaming retries are enabled, check settings passed at call time and convert parameters if needed
+      const convertedRetryOptions = convertRetryOptions(
+        callOptions,
+        gaxStreamingRetries
+      );
+      thisSettings = settings.merge(convertedRetryOptions);
+    } else {
+      thisSettings = settings.merge(callOptions);
+    }
+
     // special case: if bundling is disabled for this one call,
     // use default API caller instead
     if (settings.isBundling && !thisSettings.isBundling) {
@@ -89,23 +101,41 @@ export function createApiCall(
 
         const streaming = (currentApiCaller as StreamingApiCaller).descriptor
           ?.streaming;
+
         const retry = thisSettings.retry;
+
         if (
-          !streaming &&
+          streaming &&
           retry &&
-          retry.retryCodes &&
-          retry.retryCodes.length > 0
+          retry.retryCodes.length > 0 &&
+          retry.shouldRetryFn
         ) {
-          retry.backoffSettings.initialRpcTimeoutMillis =
-            retry.backoffSettings.initialRpcTimeoutMillis ||
-            thisSettings.timeout;
-          return retryable(
-            func,
-            thisSettings.retry!,
-            thisSettings.otherArgs as GRPCCallOtherArgs,
-            thisSettings.apiName
+          throw new Error(
+            'Only one of retryCodes or shouldRetryFn may be defined'
           );
         }
+        if (!streaming && retry) {
+          if (retry.shouldRetryFn) {
+            throw new Error(
+              'Using a function to determine retry eligibility is only supported with server streaming calls'
+            );
+          }
+          if (retry.getResumptionRequestFn) {
+            throw new Error(
+              'Resumption strategy can only be used with server streaming retries'
+            );
+          }
+          if (retry.retryCodes && retry.retryCodes.length > 0) {
+            retry.backoffSettings.initialRpcTimeoutMillis ??=
+              thisSettings.timeout;
+            return retryable(
+              func,
+              thisSettings.retry!,
+              thisSettings.otherArgs as GRPCCallOtherArgs,
+              thisSettings.apiName
+            );
+          }
+        }
         return addTimeoutArg(
           func,
           thisSettings.timeout,