Add ability to set a timeout on Functions. (#2329)

Changes the default timeout for FirebaseFunctions to 70s and adds an API to override that timeout on a per-function basis.

Author: bklimt

Functions/Backend/index.js

@@ -107,3 +107,9 @@ exports.httpErrorTest = functions.https.onRequest((request, response) => {
   // Send an http error with no body.
   response.status(400).send();
 });
+
+exports.timeoutTest = functions.https.onRequest((request, response) => {
+  // Wait for longer than 500ms.
+  setTimeout(() => response.send({data: true}), 500);
+});
+

Functions/Backend/start.sh

@@ -47,6 +47,7 @@ FUNCTIONS_BIN="./node_modules/.bin/functions"
 "${FUNCTIONS_BIN}" deploy unknownErrorTest --trigger-http
 "${FUNCTIONS_BIN}" deploy explicitErrorTest --trigger-http
 "${FUNCTIONS_BIN}" deploy httpErrorTest --trigger-http
+"${FUNCTIONS_BIN}" deploy timeoutTest --trigger-http
 
 # Wait for the user to tell us to stop the server.
 echo "Functions emulator now running in ${TEMP_DIR}."

Functions/Example/IntegrationTests/FIRIntegrationTests.m

@@ -196,4 +196,19 @@ - (void)testHttpError {
   [self waitForExpectations:@[ expectation ] timeout:10];
 }
 
+- (void)testTimeout {
+  XCTestExpectation *expectation = [[XCTestExpectation alloc] init];
+  FIRHTTPSCallable *function = [_functions HTTPSCallableWithName:@"timeoutTest"];
+  function.timeoutInterval = 0.05;
+  [function
+      callWithCompletion:^(FIRHTTPSCallableResult *_Nullable result, NSError *_Nullable error) {
+        XCTAssertNotNil(error);
+        XCTAssertEqual(FIRFunctionsErrorCodeDeadlineExceeded, error.code);
+        XCTAssertEqualObjects(@"DEADLINE EXCEEDED", error.userInfo[NSLocalizedDescriptionKey]);
+        XCTAssertNil(error.userInfo[FIRFunctionsErrorDetailsKey]);
+        [expectation fulfill];
+      }];
+  [self waitForExpectations:@[ expectation ] timeout:10];
+}
+
 @end

Functions/FirebaseFunctions/FIRFunctions+Internal.h

@@ -31,6 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)callFunction:(NSString *)name
           withObject:(nullable id)data
+             timeout:(NSTimeInterval)timeout
           completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
                                NSError *_Nullable error))completion;
 

Functions/FirebaseFunctions/FIRFunctions.m

@@ -159,6 +159,7 @@ - (NSString *)URLWithName:(NSString *)name {
 
 - (void)callFunction:(NSString *)name
           withObject:(nullable id)data
+             timeout:(NSTimeInterval)timeout
           completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
                                NSError *_Nullable error))completion {
   [_contextProvider getContext:^(FUNContext *_Nullable context, NSError *_Nullable error) {
@@ -168,16 +169,25 @@ - (void)callFunction:(NSString *)name
       }
       return;
     }
-    return [self callFunction:name withObject:data context:context completion:completion];
+    return [self callFunction:name
+                   withObject:data
+                      timeout:timeout
+                      context:context
+                   completion:completion];
   }];
 }
 
 - (void)callFunction:(NSString *)name
           withObject:(nullable id)data
+             timeout:(NSTimeInterval)timeout
              context:(FUNContext *)context
           completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
                                NSError *_Nullable error))completion {
-  GTMSessionFetcher *fetcher = [_fetcherService fetcherWithURLString:[self URLWithName:name]];
+  NSURL *url = [NSURL URLWithString:[self URLWithName:name]];
+  NSURLRequest *request = [NSURLRequest requestWithURL:url
+                                           cachePolicy:NSURLRequestUseProtocolCachePolicy
+                                       timeoutInterval:timeout];
+  GTMSessionFetcher *fetcher = [_fetcherService fetcherWithRequest:request];
 
   NSMutableDictionary *body = [NSMutableDictionary dictionary];
   // Encode the data in the body.
@@ -225,6 +235,11 @@ - (void)callFunction:(NSString *)name
       if ([error.domain isEqualToString:kGTMSessionFetcherStatusDomain]) {
         error = FUNErrorForResponse(error.code, data, serializer);
       }
+      if ([error.domain isEqualToString:NSURLErrorDomain]) {
+        if (error.code == NSURLErrorTimedOut) {
+          error = FUNErrorForCode(FIRFunctionsErrorCodeDeadlineExceeded);
+        }
+      }
     } else {
       // If there wasn't an HTTP error, see if there was an error in the body.
       error = FUNErrorForResponse(200, data, serializer);

Functions/FirebaseFunctions/FIRHTTPSCallable.m

@@ -51,6 +51,7 @@ - (instancetype)initWithFunctions:(FIRFunctions *)functions name:(NSString *)nam
     }
     _name = [name copy];
     _functions = functions;
+    _timeoutInterval = 70.0;
   }
   return self;
 }
@@ -63,7 +64,10 @@ - (void)callWithCompletion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
 - (void)callWithObject:(nullable id)data
             completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
                                  NSError *_Nullable error))completion {
-  [_functions callFunction:_name withObject:data completion:completion];
+  [_functions callFunction:_name
+                withObject:data
+                   timeout:self.timeoutInterval
+                completion:completion];
 }
 
 @end

Functions/FirebaseFunctions/FUNError.h

@@ -14,11 +14,19 @@
 // limitations under the License.
 
 #import <Foundation/Foundation.h>
+#import "FIRError.h"
 
 @class FUNSerializer;
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ * Takes an error code and returns a corresponding NSError.
+ * @param code The eror code.
+ * @return The corresponding NSError.
+ */
+NSError *_Nullable FUNErrorForCode(FIRFunctionsErrorCode code);
+
 /**
  * Takes an HTTP status code and optional body and returns a corresponding NSError.
  * If an explicit error is encoded in the JSON body, it will be used.

Functions/FirebaseFunctions/FUNError.m

@@ -14,7 +14,6 @@
 // limitations under the License.
 
 #import "FUNError.h"
-#import "FIRError.h"
 
 #import "FUNSerializer.h"
 
@@ -141,6 +140,11 @@ FIRFunctionsErrorCode FIRFunctionsErrorCodeForName(NSString *name) {
   return @"UNKNOWN";
 }
 
+NSError *_Nullable FUNErrorForCode(FIRFunctionsErrorCode code) {
+  NSDictionary *userInfo = @{NSLocalizedDescriptionKey : FUNDescriptionForErrorCode(code)};
+  return [NSError errorWithDomain:FIRFunctionsErrorDomain code:code userInfo:userInfo];
+}
+
 NSError *_Nullable FUNErrorForResponse(NSInteger status,
                                        NSData *_Nullable body,
                                        FUNSerializer *serializer) {

Functions/FirebaseFunctions/Public/FIRHTTPSCallable.h

@@ -89,6 +89,11 @@ NS_SWIFT_NAME(HTTPSCallable)
     NS_SWIFT_NAME(call(_:completion:));
 // clang-format on
 
+/**
+ * The timeout to use when calling the function. Defaults to 60 seconds.
+ */
+@property(nonatomic, assign) NSTimeInterval timeoutInterval;
+
 @end
 
 NS_ASSUME_NONNULL_END