firebase-functions 6.1.1 → 6.1.2

package/lib/common/providers/https.d.ts

@@ -90,8 +90,21 @@ export interface CallableRequest<T = any> {
  * to allow writing partial, streaming responses back to the client.
  */
 export interface CallableProxyResponse {
+    /**
+     * Writes a chunk of the response body to the client. This method can be called
+     * multiple times to stream data progressively.
+     */
     write: express.Response["write"];
+    /**
+     * Indicates whether the client has requested and can handle streaming responses.
+     * This should be checked before attempting to stream data to avoid compatibility issues.
+     */
     acceptsStreaming: boolean;
+    /**
+     * An AbortSignal that is triggered when the client disconnects or the
+     * request is terminated prematurely.
+     */
+    signal: AbortSignal;
 }
 /**
  * The set of Firebase Functions status codes. The codes are the same at the

package/lib/common/providers/https.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onCallHandler = exports.checkAuthToken = exports.unsafeDecodeAppCheckToken = exports.unsafeDecodeIdToken = exports.unsafeDecodeToken = exports.decode = exports.encode = exports.isValidRequest = exports.HttpsError = exports.ORIGINAL_AUTH_HEADER = exports.CALLABLE_AUTH_HEADER = void 0;
+exports.onCallHandler = exports.checkAuthToken = exports.unsafeDecodeAppCheckToken = exports.unsafeDecodeIdToken = exports.unsafeDecodeToken = exports.decode = exports.encode = exports.isValidRequest = exports.HttpsError = exports.DEFAULT_HEARTBEAT_SECONDS = exports.ORIGINAL_AUTH_HEADER = exports.CALLABLE_AUTH_HEADER = void 0;
 const cors = require("cors");
 const logger = require("../../logger");
 // TODO(inlined): Decide whether we want to un-version apps or whether we want a
@@ -35,6 +35,8 @@ const JWT_REGEX = /^[a-zA-Z0-9\-_=]+?\.[a-zA-Z0-9\-_=]+?\.([a-zA-Z0-9\-_=]+)?$/;
 exports.CALLABLE_AUTH_HEADER = "x-callable-context-auth";
 /** @internal */
 exports.ORIGINAL_AUTH_HEADER = "x-original-auth";
+/** @internal */
+exports.DEFAULT_HEARTBEAT_SECONDS = 30;
 /**
  * Standard error codes and HTTP statuses for different ways a request can fail,
  * as defined by:
@@ -403,6 +405,30 @@ function encodeSSE(data) {
 /** @internal */
 function wrapOnCallHandler(options, handler, version) {
     return async (req, res) => {
+        const abortController = new AbortController();
+        let heartbeatInterval = null;
+        const heartbeatSeconds = options.heartbeatSeconds === undefined ? exports.DEFAULT_HEARTBEAT_SECONDS : options.heartbeatSeconds;
+        const clearScheduledHeartbeat = () => {
+            if (heartbeatInterval) {
+                clearTimeout(heartbeatInterval);
+                heartbeatInterval = null;
+            }
+        };
+        const scheduleHeartbeat = () => {
+            clearScheduledHeartbeat();
+            if (!abortController.signal.aborted) {
+                heartbeatInterval = setTimeout(() => {
+                    if (!abortController.signal.aborted) {
+                        res.write(": ping\n");
+                        scheduleHeartbeat();
+                    }
+                }, heartbeatSeconds * 1000);
+            }
+        };
+        res.on("close", () => {
+            clearScheduledHeartbeat();
+            abortController.abort();
+        });
         try {
             if (!isValidRequest(req)) {
                 logger.error("Invalid request, unable to process.");
@@ -470,52 +496,79 @@ function wrapOnCallHandler(options, handler, version) {
                     ...context,
                     data,
                 };
-                // TODO: set up optional heartbeat
                 const responseProxy = {
                     write(chunk) {
-                        if (acceptsStreaming) {
-                            const formattedData = encodeSSE({ message: chunk });
-                            return res.write(formattedData);
-                        }
                         // if client doesn't accept sse-protocol, response.write() is no-op.
+                        if (!acceptsStreaming) {
+                            return false;
+                        }
+                        // if connection is already closed, response.write() is no-op.
+                        if (abortController.signal.aborted) {
+                            return false;
+                        }
+                        const formattedData = encodeSSE({ message: chunk });
+                        const wrote = res.write(formattedData);
+                        // Reset heartbeat timer after successful write
+                        if (wrote && heartbeatInterval !== null && heartbeatSeconds > 0) {
+                            scheduleHeartbeat();
+                        }
+                        return wrote;
                     },
                     acceptsStreaming,
+                    signal: abortController.signal,
                 };
                 if (acceptsStreaming) {
                     // SSE always responds with 200
                     res.status(200);
+                    if (heartbeatSeconds !== null && heartbeatSeconds > 0) {
+                        scheduleHeartbeat();
+                    }
                 }
                 // For some reason the type system isn't picking up that the handler
                 // is a one argument function.
                 result = await handler(arg, responseProxy);
+                clearScheduledHeartbeat();
             }
-            // Encode the result as JSON to preserve types like Dates.
-            result = encode(result);
-            // If there was some result, encode it in the body.
-            const responseBody = { result };
-            if (acceptsStreaming) {
-                res.write(encodeSSE(responseBody));
-                res.end();
+            if (!abortController.signal.aborted) {
+                // Encode the result as JSON to preserve types like Dates.
+                result = encode(result);
+                // If there was some result, encode it in the body.
+                const responseBody = { result };
+                if (acceptsStreaming) {
+                    res.write(encodeSSE(responseBody));
+                    res.end();
+                }
+                else {
+                    res.status(200).send(responseBody);
+                }
             }
             else {
-                res.status(200).send(responseBody);
+                res.end();
             }
         }
         catch (err) {
-            let httpErr = err;
-            if (!(err instanceof HttpsError)) {
-                // This doesn't count as an 'explicit' error.
-                logger.error("Unhandled error", err);
-                httpErr = new HttpsError("internal", "INTERNAL");
-            }
-            const { status } = httpErr.httpErrorCode;
-            const body = { error: httpErr.toJSON() };
-            if (version === "gcfv2" && req.header("accept") === "text/event-stream") {
-                res.send(encodeSSE(body));
+            if (!abortController.signal.aborted) {
+                let httpErr = err;
+                if (!(err instanceof HttpsError)) {
+                    // This doesn't count as an 'explicit' error.
+                    logger.error("Unhandled error", err);
+                    httpErr = new HttpsError("internal", "INTERNAL");
+                }
+                const { status } = httpErr.httpErrorCode;
+                const body = { error: httpErr.toJSON() };
+                if (version === "gcfv2" && req.header("accept") === "text/event-stream") {
+                    res.send(encodeSSE(body));
+                }
+                else {
+                    res.status(status).send(body);
+                }
             }
             else {
-                res.status(status).send(body);
+                res.end();
             }
         }
+        finally {
+            clearScheduledHeartbeat();
+        }
     };
 }

package/lib/v2/providers/https.d.ts

@@ -132,6 +132,13 @@ export interface CallableOptions extends HttpsOptions {
      * further decisions, such as requiring additional security checks or rejecting the request.
      */
     consumeAppCheckToken?: boolean;
+    /**
+     * Time in seconds between sending heartbeat messages to keep the connection
+     * alive. Set to `null` to disable heartbeats.
+     *
+     * Defaults to 30 seconds.
+     */
+    heartbeatSeconds?: number | null;
 }
 /**
  * Handles HTTPS requests.

package/lib/v2/providers/https.js

@@ -136,6 +136,7 @@ function onCall(optsOrHandler, handler) {
         cors: { origin, methods: "POST" },
         enforceAppCheck: (_a = opts.enforceAppCheck) !== null && _a !== void 0 ? _a : options.getGlobalOptions().enforceAppCheck,
         consumeAppCheckToken: opts.consumeAppCheckToken,
+        heartbeatSeconds: opts.heartbeatSeconds,
     }, fixedLen, "gcfv2");
     func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(func));
     Object.defineProperty(func, "__trigger", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "6.1.1",
+  "version": "6.1.2",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -287,7 +287,7 @@
     "@types/nock": "^10.0.3",
     "@types/node": "^14.18.24",
     "@types/node-fetch": "^3.0.3",
-    "@types/sinon": "^7.0.13",
+    "@types/sinon": "^9.0.11",
     "@typescript-eslint/eslint-plugin": "^5.33.1",
     "@typescript-eslint/parser": "^5.33.1",
     "api-extractor-model-me": "^0.1.1",
@@ -313,7 +313,7 @@
     "prettier": "^2.7.1",
     "protobufjs-cli": "^1.1.1",
     "semver": "^7.3.5",
-    "sinon": "^7.3.2",
+    "sinon": "^9.2.4",
     "ts-node": "^10.4.0",
     "typescript": "^4.3.5",
     "yargs": "^15.3.1"