clear failAfter timeout after request resolves (#3330)

* clear failAfter timeout after request resolves

* Create nasty-pigs-invite.md

* add a test

* fix test setup issues

.changeset/nasty-pigs-invite.md

@@ -0,0 +1,6 @@
+---
+"@firebase/functions": patch
+"firebase": patch
+---
+
+Clear timeout after a successful response or after the request is canceled. Fixes [issue 3289](https://github.com/firebase/firebase-js-sdk/issues/3289).

config/functions/package.json

@@ -8,6 +8,6 @@
   },
   "private": true,
   "engines": {
-    "node": "8"
+    "node": "10"
   }
 }

packages/functions/src/api/service.ts

@@ -58,12 +58,23 @@ export interface HttpResponseBody {
  *
  * @param millis Number of milliseconds to wait before rejecting.
  */
-function failAfter(millis: number): Promise<never> {
-  return new Promise((_, reject) => {
-    setTimeout(() => {
+function failAfter(
+  millis: number
+): {
+  timer: number | NodeJS.Timeout;
+  promise: Promise<never>;
+} {
+  let timer!: number | NodeJS.Timeout;
+  const promise = new Promise<never>((_, reject) => {
+    timer = setTimeout(() => {
       reject(new HttpsErrorImpl('deadline-exceeded', 'deadline-exceeded'));
     }, millis);
   });
+
+  return {
+    timer,
+    promise
+  };
 }
 
 /**
@@ -213,10 +224,12 @@ export class Service implements FirebaseFunctions, FirebaseService {
     // Default timeout to 70s, but let the options override it.
     const timeout = options.timeout || 70000;
 
+    const { timer, promise: failAfterPromise } = failAfter(timeout);
+
     const response = await Promise.race([
-      this.postJSON(url, body, headers),
-      failAfter(timeout),
-      this.cancelAllRequests
+      clearTimeoutWrapper(timer, this.postJSON(url, body, headers)),
+      failAfterPromise,
+      clearTimeoutWrapper(timer, this.cancelAllRequests)
     ]);
 
     // If service was deleted, interrupted response throws an error.
@@ -261,3 +274,13 @@ export class Service implements FirebaseFunctions, FirebaseService {
     return { data: decodedData };
   }
 }
+
+async function clearTimeoutWrapper<T>(
+  timer: number | NodeJS.Timeout,
+  promise: Promise<T>
+): Promise<T> {
+  const result = await promise;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  clearTimeout(timer as any);
+  return result;
+}

packages/functions/test/callable.test.ts

@@ -190,4 +190,14 @@ describe('Firebase Functions > Call', () => {
     const func = functions.httpsCallable('timeoutTest', { timeout: 10 });
     await expectError(func(), 'deadline-exceeded', 'deadline-exceeded');
   });
+
+  it('cancels timeout', async () => {
+    const functions = createTestService(app, region);
+    const globalObj = typeof window !== 'undefined' ? window : global;
+    const clearTimeoutSpy = sinon.spy(globalObj, 'clearTimeout');
+    const func = functions.httpsCallable('nullTest');
+    await func(null);
+    expect(clearTimeoutSpy.called).to.be.true;
+    clearTimeoutSpy.restore();
+  });
 });

tools/config.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,12 +72,12 @@ Promise.resolve(userToken || cachedToken)
     })();
 
     // Write config to top-level config directory
-    await firebaseTools.setup
-      .web({ project, token })
+    await firebaseTools.apps
+      .sdkconfig('web', undefined, { project, token })
       .then(config =>
         fs.writeFile(
           path.resolve(__dirname, '../config/project.json'),
-          JSON.stringify(config, null, 2)
+          JSON.stringify(config.sdkConfig, null, 2)
         )
       );