refactor!: move function wrapping earlier

This commit extracts the logic for wrapping user functions into its
own module and adds unit tests. It also refactors the code path that
wraps the user function earlier in the initialization logic. This
removes registration from the critical request path.

Author: matthewrobertson

src/function_wrappers.ts

@@ -0,0 +1,231 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Node.js server that runs user's code on HTTP request. HTTP response is sent
+// once user's function has completed.
+// The server accepts following HTTP requests:
+//   - POST '/*' for executing functions (only for servers handling functions
+//     with non-HTTP trigger).
+//   - ANY (all methods) '/*' for executing functions (only for servers handling
+//     functions with HTTP trigger).
+
+// eslint-disable-next-line node/no-deprecated-api
+import * as domain from 'domain';
+import {Request, Response, RequestHandler} from 'express';
+import {sendCrashResponse} from './logger';
+import {sendResponse} from './invoker';
+import {isBinaryCloudEvent, getBinaryCloudEventContext} from './cloudevents';
+import {
+  HttpFunction,
+  EventFunction,
+  EventFunctionWithCallback,
+  Context,
+  CloudEventFunction,
+  CloudEventFunctionWithCallback,
+  CloudEventsContext,
+  HandlerFunction,
+} from './functions';
+import {SignatureType} from './types';
+
+/**
+ * The handler function used to signal completion of event functions.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type OnDoneCallback = (err: Error | null, result: any) => void;
+
+/**
+ * Get a completion handler that can be used to signal completion of an event function.
+ * @param res the response object of the request the completion handler is for.
+ * @returns an OnDoneCallback for the provided request.
+ */
+const getOnDoneCallback = (res: Response): OnDoneCallback => {
+  return process.domain.bind<OnDoneCallback>((err, result) => {
+    if (res.locals.functionExecutionFinished) {
+      console.log('Ignoring extra callback call');
+    } else {
+      res.locals.functionExecutionFinished = true;
+      if (err) {
+        console.error(err.stack);
+      }
+      sendResponse(result, err, res);
+    }
+  });
+};
+
+/**
+ * Helper function to parse a cloudevent object from an HTTP request.
+ * @param req an Express HTTP request
+ * @returns a cloudevent parsed from the request
+ */
+const parseCloudEventRequest = (req: Request): CloudEventsContext => {
+  let cloudevent = req.body;
+  if (isBinaryCloudEvent(req)) {
+    cloudevent = getBinaryCloudEventContext(req);
+    cloudevent.data = req.body;
+  }
+  return cloudevent;
+};
+
+/**
+ * Helper function to background event context and data payload object from an HTTP
+ * request.
+ * @param req an Express HTTP request
+ * @returns the data playload and event context parsed from the request
+ */
+const parseBackgroundEvent = (req: Request): {data: {}; context: Context} => {
+  const event = req.body;
+  const data = event.data;
+  let context = event.context;
+  if (context === undefined) {
+    // Support legacy events and CloudEvents in structured content mode, with
+    // context properties represented as event top-level properties.
+    // Context is everything but data.
+    context = event;
+    // Clear the property before removing field so the data object
+    // is not deleted.
+    context.data = undefined;
+    delete context.data;
+  }
+  return {data, context};
+};
+
+/**
+ * Wraps the provided function into an Express handler function with additional
+ * instrumentation logic.
+ * @param execute Runs user's function.
+ * @return An Express handler function.
+ */
+const wrapHttpFunction = (execute: HttpFunction): RequestHandler => {
+  return (req: Request, res: Response) => {
+    const d = domain.create();
+    // Catch unhandled errors originating from this request.
+    d.on('error', err => {
+      if (res.locals.functionExecutionFinished) {
+        console.error(`Exception from a finished function: ${err}`);
+      } else {
+        res.locals.functionExecutionFinished = true;
+        sendCrashResponse({err, res});
+      }
+    });
+    d.run(() => {
+      process.nextTick(() => {
+        execute(req, res);
+      });
+    });
+  };
+};
+
+/**
+ * Wraps an async cloudevent function in an express RequestHandler.
+ * @param userFunction User's function.
+ * @return An Express hander function that invokes the user function.
+ */
+const wrapCloudEventFunction = (
+  userFunction: CloudEventFunction
+): RequestHandler => {
+  const httpHandler = (req: Request, res: Response) => {
+    const callback = getOnDoneCallback(res);
+    const cloudevent = parseCloudEventRequest(req);
+    Promise.resolve()
+      .then(() => userFunction(cloudevent))
+      .then(
+        result => callback(null, result),
+        err => callback(err, undefined)
+      );
+  };
+  return wrapHttpFunction(httpHandler);
+};
+
+/**
+ * Wraps callback style cloudevent function in an express RequestHandler.
+ * @param userFunction User's function.
+ * @return An Express hander function that invokes the user function.
+ */
+const wrapCloudEventFunctionWithCallback = (
+  userFunction: CloudEventFunctionWithCallback
+): RequestHandler => {
+  const httpHandler = (req: Request, res: Response) => {
+    const callback = getOnDoneCallback(res);
+    const cloudevent = parseCloudEventRequest(req);
+    return userFunction(cloudevent, callback);
+  };
+  return wrapHttpFunction(httpHandler);
+};
+
+/**
+ * Wraps an async event function in an express RequestHandler.
+ * @param userFunction User's function.
+ * @return An Express hander function that invokes the user function.
+ */
+const wrapEventFunction = (userFunction: EventFunction): RequestHandler => {
+  const httpHandler = (req: Request, res: Response) => {
+    const callback = getOnDoneCallback(res);
+    const {data, context} = parseBackgroundEvent(req);
+    Promise.resolve()
+      .then(() => userFunction(data, context))
+      .then(
+        result => callback(null, result),
+        err => callback(err, undefined)
+      );
+  };
+  return wrapHttpFunction(httpHandler);
+};
+
+/**
+ * Wraps an callback style event function in an express RequestHandler.
+ * @param userFunction User's function.
+ * @return An Express hander function that invokes the user function.
+ */
+const wrapEventFunctionWithCallback = (
+  userFunction: EventFunctionWithCallback
+): RequestHandler => {
+  const httpHandler = (req: Request, res: Response) => {
+    const callback = getOnDoneCallback(res);
+    const {data, context} = parseBackgroundEvent(req);
+    return userFunction(data, context, callback);
+  };
+  return wrapHttpFunction(httpHandler);
+};
+
+/**
+ * Wraps a user function with the provided signature type in an express
+ * RequestHandler.
+ * @param userFunction User's function.
+ * @return An Express hander function that invokes the user function.
+ */
+export const wrapUserFunction = (
+  userFunction: HandlerFunction,
+  signatureType: SignatureType
+): RequestHandler => {
+  switch (signatureType) {
+    case 'http':
+      return wrapHttpFunction(userFunction as HttpFunction);
+    case 'event':
+      // Callback style if user function has more than 2 arguments.
+      if (userFunction!.length > 2) {
+        return wrapEventFunctionWithCallback(
+          userFunction as EventFunctionWithCallback
+        );
+      }
+      return wrapEventFunction(userFunction as EventFunction);
+    case 'cloudevent':
+      if (userFunction!.length > 1) {
+        // Callback style if user function has more than 1 argument.
+        return wrapCloudEventFunctionWithCallback(
+          userFunction as CloudEventFunctionWithCallback
+        );
+      }
+      return wrapCloudEventFunction(userFunction as CloudEventFunction);
+  }
+};