extending express.request to include rawBody (#420)

Author: joehan

spec/providers/https.spec.ts

@@ -71,7 +71,7 @@ interface RunHandlerResult {
  * and response are properly converted to their http equivalents.
  */
 interface CallTest {
-  // An http request, mocking a subset of express.Request.
+  // An http request, mocking a subset of https.Request.
   httpRequest: any;
 
   // The expected format of the request passed to the handler.
@@ -90,7 +90,7 @@ interface CallTest {
  */
 function runHandler(
   handler: express.Handler,
-  request: express.Request
+  request: https.Request
 ): Promise<RunHandlerResult> {
   return new Promise((resolve, reject) => {
     // MockResponse mocks an express.Response.
@@ -145,7 +145,7 @@ async function runTest(test: CallTest): Promise<any> {
   expect(response.status).to.equal(test.expectedHttpResponse.status);
 }
 
-// MockRequest mocks an express.Request.
+// MockRequest mocks an https.Request.
 class MockRequest {
   public method: 'POST' | 'GET' | 'OPTIONS' = 'POST';
 

src/function-builder.ts

@@ -152,7 +152,7 @@ export class FunctionBuilder {
        * same signature as an Express app.
        */
       onRequest: (
-        handler: (req: express.Request, resp: express.Response) => void
+        handler: (req: https.Request, resp: express.Response) => void
       ) => https._onRequestWithOpts(handler, this.options),
       /**
        * Declares a callable method for clients to call using a Firebase SDK.

src/providers/https.ts

@@ -28,13 +28,20 @@ import { apps } from '../apps';
 import { HttpsFunction, optsToTrigger, Runnable } from '../cloud-functions';
 import { DeploymentOptions } from '../function-builder';
 
+/**
+ * 
+ * 
+ */
+export interface Request extends express.Request {
+  rawBody: Buffer;
+}
 /**
  * Handle HTTP requests.
  * @param handler A function that takes a request and response object,
  * same signature as an Express app.
  */
 export function onRequest(
-  handler: (req: express.Request, resp: express.Response) => void
+  handler: (req: Request, resp: express.Response) => void
 ) {
   return _onRequestWithOpts(handler, {});
 }
@@ -51,11 +58,11 @@ export function onCall(
 
 /** @internal */
 export function _onRequestWithOpts(
-  handler: (req: express.Request, resp: express.Response) => void,
+  handler: (req: Request, resp: express.Response) => void,
   opts: DeploymentOptions
 ): HttpsFunction {
   // lets us add __trigger without altering handler:
-  let cloudFunction: any = (req: express.Request, res: express.Response) => {
+  let cloudFunction: any = (req: Request, res: express.Response) => {
     handler(req, res);
   };
   cloudFunction.__trigger = _.assign(optsToTrigger(opts), { httpsTrigger: {} });
@@ -267,11 +274,11 @@ export interface CallableContext {
   /**
    * The raw request handled by the callable.
    */
-  rawRequest: express.Request;
+  rawRequest: Request;
 }
 
 // The allowed interface for an http request for a callable function.
-interface HttpRequest extends express.Request {
+interface HttpRequest extends Request {
   body: {
     data: any;
   };
@@ -284,7 +291,7 @@ interface HttpResponseBody {
 }
 
 // Returns true if req is a properly formatted callable request.
-function isValidRequest(req: express.Request): req is HttpRequest {
+function isValidRequest(req: Request): req is HttpRequest {
   // The body must not be empty.
   if (!req.body) {
     console.warn('Request is missing body.');
@@ -416,7 +423,7 @@ export function _onCallWithOpts(
   handler: (data: any, context: CallableContext) => any | Promise<any>,
   opts: DeploymentOptions
 ): HttpsFunction & Runnable<any> {
-  const func = async (req: express.Request, res: express.Response) => {
+  const func = async (req: Request, res: express.Response) => {
     try {
       if (!isValidRequest(req)) {
         console.error('Invalid request', req);
@@ -477,7 +484,7 @@ export function _onCallWithOpts(
   };
 
   // Wrap the function with a cors handler.
-  const corsFunc: any = (req: express.Request, res: express.Response) => {
+  const corsFunc: any = (req: Request, res: express.Response) => {
     return corsHandler(req, res, () => func(req, res));
   };