Bug bash fixes (#933)

* HTTP functions always return a promise even when apply CORS.

Previously HTTPS functions had to be patched in the emulator
to ensure that the promise is always handled. This change
should circumvent that need and make v2 patching unnecessary.

* Export undocumented dependency of the emulator

* Make @types/cors a proper dep

* Add dummy files to silence imports eslinter

Co-authored-by: Michael Bleigh <[email protected]>

Author: inlined

logger/compat.js

@@ -0,0 +1,26 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+// This file is not part of the firebase-functions SDK. It is used to silence the
+// imports eslint plugin until it can understand import paths defined by node
+// package exports.
+// For more information, see github.com/import-js/eslint-plugin-import/issues/1810

logger/index.js

@@ -0,0 +1,26 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+// This file is not part of the firebase-functions SDK. It is used to silence the
+// imports eslint plugin until it can understand import paths defined by node
+// package exports.
+// For more information, see github.com/import-js/eslint-plugin-import/issues/1810

package.json

@@ -25,6 +25,7 @@
   "types": "lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
+    "./lib/providers/https": "./lib/v1/providers/https.js",
     "./v1": "./lib/v1/index.js",
     "./logger": "./lib/logger/index.js",
     "./logger/compat": "./lib/logger/compat.js",
@@ -84,6 +85,7 @@
     "test": "mocha"
   },
   "dependencies": {
+    "@types/cors": "^2.8.5",
     "@types/express": "4.17.3",
     "cors": "^2.8.5",
     "express": "^4.17.1",
@@ -92,7 +94,6 @@
   "devDependencies": {
     "@types/chai": "^4.1.7",
     "@types/chai-as-promised": "^7.1.0",
-    "@types/cors": "^2.8.5",
     "@types/jsonwebtoken": "^8.3.2",
     "@types/lodash": "^4.14.135",
     "@types/mocha": "^5.2.7",

spec/common/providers/https.spec.ts

@@ -58,6 +58,7 @@ function runHandler(
     class MockResponse {
       private statusCode = 0;
       private headers: { [name: string]: string } = {};
+      private callback: Function;
 
       public status(code: number) {
         this.statusCode = code;
@@ -79,11 +80,21 @@ function runHandler(
           headers: this.headers,
           body,
         });
+        if (this.callback) {
+          this.callback();
+        }
       }
 
       public end() {
         this.send(undefined);
       }
+
+      public on(event: string, callback: Function) {
+        if (event !== 'finish') {
+          throw new Error('MockResponse only implements the finish event');
+        }
+        this.callback = callback;
+      }
     }
 
     const response = new MockResponse();

spec/v1/providers/https.spec.ts

@@ -49,6 +49,7 @@ function runHandler(
     class MockResponse {
       private statusCode = 0;
       private headers: { [name: string]: string } = {};
+      private callback: Function;
 
       public status(code: number) {
         this.statusCode = code;
@@ -70,13 +71,22 @@ function runHandler(
           headers: this.headers,
           body,
         });
+        if (this.callback) {
+          this.callback();
+        }
       }
 
       public end() {
         this.send(undefined);
       }
-    }
 
+      public on(event: string, callback: Function) {
+        if (event !== 'finish') {
+          throw new Error('MockResponse only implements the finish event');
+        }
+        this.callback = callback;
+      }
+    }
     const response = new MockResponse();
     handler(request, response as any, () => undefined);
   });

spec/v2/providers/https.spec.ts

@@ -28,6 +28,7 @@ function runHandler(
     class MockResponse {
       private statusCode = 0;
       private headers: { [name: string]: string } = {};
+      private callback: Function;
 
       public status(code: number) {
         this.statusCode = code;
@@ -49,11 +50,21 @@ function runHandler(
           headers: this.headers,
           body,
         });
+        if (this.callback) {
+          this.callback();
+        }
       }
 
       public end() {
         this.send(undefined);
       }
+
+      public on(event: string, callback: Function) {
+        if (event !== 'finish') {
+          throw new Error('MockResponse only implements the finish event');
+        }
+        this.callback = callback;
+      }
     }
 
     const response = new MockResponse();

src/common/providers/https.ts

@@ -598,9 +598,12 @@ export function onCallHandler<Req = any, Res = any>(
   handler: v1Handler | v2Handler<Req, Res>
 ): (req: Request, res: express.Response) => Promise<void> {
   const wrapped = wrapOnCallHandler(handler);
-  return async (req: Request, res: express.Response) => {
-    cors(options)(req, res, () => {
-      return wrapped(req, res);
+  return (req: Request, res: express.Response) => {
+    return new Promise((resolve) => {
+      res.on('finish', resolve);
+      cors(options)(req, res, () => {
+        resolve(wrapped(req, res));
+      });
     });
   };
 }

src/v2/providers/https.ts

@@ -83,9 +83,12 @@ export function onRequest(
 
   if ('cors' in opts) {
     const userProvidedHandler = handler;
-    handler = (req: Request, res: express.Response) => {
-      cors({ origin: opts.cors })(req, res, () => {
-        userProvidedHandler(req, res);
+    handler = (req: Request, res: express.Response): void | Promise<void> => {
+      return new Promise((resolve) => {
+        res.on('finish', resolve);
+        cors({ origin: opts.cors })(req, res, () => {
+          resolve(userProvidedHandler(req, res));
+        });
       });
     };
   }

v1/index.js

@@ -0,0 +1,26 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+// This file is not part of the firebase-functions SDK. It is used to silence the
+// imports eslint plugin until it can understand import paths defined by node
+// package exports.
+// For more information, see github.com/import-js/eslint-plugin-import/issues/1810

v2/core.js

@@ -0,0 +1,26 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+// This file is not part of the firebase-functions SDK. It is used to silence the
+// imports eslint plugin until it can understand import paths defined by node
+// package exports.
+// For more information, see github.com/import-js/eslint-plugin-import/issues/1810