feat: more information for exceed timeout error

src/normalCalls/retries.ts

@@ -69,8 +69,9 @@ export function retryable(
     let timeoutId: ReturnType<typeof setTimeout> | null;
     let now = new Date();
     let deadline: number;
+    const startTime = now.getTime();
     if (retry.backoffSettings.totalTimeoutMillis) {
-      deadline = now.getTime() + retry.backoffSettings.totalTimeoutMillis;
+      deadline = startTime + retry.backoffSettings.totalTimeoutMillis;
     }
     let retries = 0;
     const maxRetries = retry.backoffSettings.maxRetries!;
@@ -80,8 +81,14 @@ export function retryable(
     function repeat() {
       timeoutId = null;
       if (deadline && now.getTime() >= deadline) {
+        const timeCost = now.getTime() - startTime;
+        const funcName = func.name;
         const error = new GoogleError(
-          'Retry total timeout exceeded before any response was received'
+          `Function ${funcName} takes ${timeCost} milliseconds which exceeds retry total timeout ${
+            retry.backoffSettings.totalTimeoutMillis
+          } milliseconds before any response was received. The retry settings is ${JSON.stringify(
+            retry.backoffSettings
+          )}.`
         );
         error.code = Status.DEADLINE_EXCEEDED;
         callback(error);

test/unit/apiCallable.ts

@@ -364,6 +364,20 @@ describe('retryable', () => {
     });
   });
 
+  it('retry fails for exceeding total timeout', done => {
+    const spy = sinon.spy(fail);
+    const apiCall = createApiCall(spy, settings);
+    apiCall({}, undefined, err => {
+      assert.ok(err instanceof GoogleError);
+      assert.strictEqual(
+        err.message,
+        'Function  takes 100 milliseconds which exceeds retry total timeout 100 milliseconds before any response was received. The retry settings is {"initialRetryDelayMillis":0,"retryDelayMultiplier":0,"maxRetryDelayMillis":0,"initialRpcTimeoutMillis":0,"rpcTimeoutMultiplier":0,"maxRpcTimeoutMillis":0,"totalTimeoutMillis":100}.'
+      );
+      assert.strictEqual(err!.code, status.DEADLINE_EXCEEDED);
+      done();
+    });
+  });
+
   // maxRetries is unsupported, and intended for internal use only.
   it('errors when totalTimeoutMillis and maxRetries set', done => {
     const maxRetries = 5;