Merge pull request #296 from H4ad/feat/firebase-functions-v5-v6

feat(firebase): ensure support to v5 and v6 sdk

Author: H4ad

package-lock.json

@@ -84,7 +84,7 @@
     "@deepkit/framework": "1.0.1-alpha.99",
     "@deepkit/http": "1.0.1-alpha.98",
     "@deepkit/workflow": "1.0.1-alpha.97",
-    "@google-cloud/functions-framework": "3.3.0",
+    "@google-cloud/functions-framework": "3.4.2",
     "@hapi/hapi": "21.3.2",
     "@microsoft/api-documenter": "7.23.15",
     "@microsoft/api-extractor": "7.39.0",
@@ -122,6 +122,8 @@
     "fastify-v5": "npm:fastify@5",
     "firebase-admin": "11.11.1",
     "firebase-functions": "4.5.0",
+    "firebase-functions-v5": "npm:firebase-functions@5",
+    "firebase-functions-v6": "npm:firebase-functions@6",
     "glob": "10.3.10",
     "husky": "8.0.3",
     "koa": "2.15.0",

package.json

@@ -0,0 +1,119 @@
+import type { HttpsOptions } from 'firebase-functions/v2/https';
+import { describe, expect, it, vitest } from 'vitest';
+import {
+  type FrameworkContract,
+  ServerlessRequest,
+  ServerlessResponse,
+  waitForStreamComplete,
+} from '../../src';
+import { HttpFirebaseV2Handler } from '../../src/handlers/firebase';
+import { FrameworkMock } from '../mocks/framework.mock';
+
+vitest.mock('firebase-functions/v2', async () => {
+  // eslint-disable-next-line import/no-unresolved
+  return await import('firebase-functions-v5/v2');
+});
+
+describe(HttpFirebaseV2Handler.name, () => {
+  it('should forward correctly the request to framework', async () => {
+    const handlerFactory = new HttpFirebaseV2Handler();
+
+    const method = 'POST';
+    const url = '/users/batata';
+    const headers = { 'Content-Type': 'application/json' };
+    const remoteAddress = '168.16.0.1';
+    const body = Buffer.from('{"test": true}', 'utf-8');
+
+    const request = new ServerlessRequest({
+      method,
+      url,
+      headers,
+      remoteAddress,
+      body,
+    });
+
+    const response = new ServerlessResponse({
+      method,
+    });
+
+    const responseBody = { batata: true };
+    const responseStatus = 200;
+    const framework = new FrameworkMock(responseStatus, responseBody);
+
+    const handler = handlerFactory.getHandler(null, framework);
+
+    handler(request, response);
+
+    await waitForStreamComplete(response);
+
+    expect(response.statusCode).toBe(responseStatus);
+    expect(ServerlessResponse.body(response).toString()).toStrictEqual(
+      JSON.stringify(responseBody),
+    );
+  });
+
+  it('should handle weird body types', () => {
+    const handlerFactory = new HttpFirebaseV2Handler();
+
+    const method = 'POST';
+    const url = '/users/batata';
+    const headers = { 'Content-Type': 'application/json' };
+    const remoteAddress = '168.16.0.1';
+    const options = [{ potato: true }, [{ test: true }]];
+
+    for (const option of options) {
+      const request = new ServerlessRequest({
+        method,
+        url,
+        headers,
+        remoteAddress,
+        body: option as any,
+      });
+
+      const response = new ServerlessResponse({
+        method,
+      });
+
+      const framework: FrameworkContract<unknown> = {
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        sendRequest: vitest.fn(
+          async (
+            _app: null,
+            req: ServerlessRequest,
+            res: ServerlessResponse,
+          ) => {
+            expect(req.body?.toString()).toEqual(JSON.stringify(option));
+            expect(req.headers['content-length']).toEqual(
+              Buffer.byteLength(JSON.stringify(option)).toString(),
+            );
+
+            req.pipe(res);
+
+            await waitForStreamComplete(res);
+
+            expect(ServerlessResponse.body(res).toString()).toEqual(
+              JSON.stringify(option),
+            );
+          },
+        ),
+      };
+
+      const handler = handlerFactory.getHandler(null, framework);
+
+      handler(request, response);
+    }
+  });
+
+  it('should forward the properties to https.onRequest', () => {
+    const options: HttpsOptions = {
+      concurrency: 400,
+    };
+    const factory = new HttpFirebaseV2Handler(options);
+
+    const spyMethod = vitest.spyOn(factory, 'onRequestWithOptions' as any);
+
+    factory.getHandler(null, new FrameworkMock(200, {}));
+
+    expect(spyMethod).toHaveBeenCalledWith(options, expect.any(Function));
+  });
+});