#79 introduced express to better manage google function routes with z…

…od validation

cloud/functions/package.json

@@ -20,6 +20,7 @@
     "@types/lodash": "^4.14.194",
     "axios": "^1.3.6",
     "cheerio": "1.0.0-rc.12",
+    "express": "4.19.2",
     "firebase-admin": "^11.5.0",
     "firebase-functions": "4.8.1",
     "lodash": "^4.17.21",

cloud/functions/src/functions/http/hello.ts

@@ -1,9 +1,8 @@
 import * as functions from "firebase-functions";
 import {sendResponseMessage} from "./utils";
+import {Response} from "express";
 
-const helloWorld = functions.https.onRequest((request, response) => {
-    functions.logger.info("Hello voxxrin logs!", {structuredData: true});
-    return sendResponseMessage(response, 200, "Hello from Voxxrin!");
-});
-
-export default helloWorld
+export default async (response: Response, pathParams: {}, queryParams: {who?: string}) => {
+  functions.logger.info("Hello voxxrin logs!", {structuredData: true});
+  return sendResponseMessage(response, 200, `Hello ${queryParams.who || "nobody"} from Voxxrin!`);
+};

cloud/functions/src/functions/http/routes.ts

@@ -0,0 +1,10 @@
+import {Routes} from "./utils";
+import * as z from "zod";
+import type {Express} from 'express';
+import helloWorld from "./hello";
+
+export function declareExpressHttpRoutes(app: Express) {
+// For testing purposes only
+  Routes.get(app, `/helloWorld`, z.object({ query: z.object({ who: z.string().optional() })}), helloWorld);
+
+}

cloud/functions/src/functions/http/utils.ts

@@ -1,5 +1,10 @@
 import * as functions from "firebase-functions";
 import {Response} from "firebase-functions";
+import * as z from "zod";
+import {RouteParameters} from "express-serve-static-core";
+import * as express from "express";
+import {AnyZodObject} from "zod";
+import { type Express, NextFunction} from "express";
 
 export function extractSingleQueryParam(request: functions.https.Request, paramName: string) {
     const value  = request.query[paramName];
@@ -44,3 +49,75 @@ export async function logPerf<T>(message: string, callback: () => Promise<T>) {
 
     return results;
 }
+
+type RequestZodObject = z.ZodObject<{
+  query?: AnyZodObject,
+  path?: AnyZodObject,
+}>
+type RequestWithBodyZodObject = z.ZodObject<{
+  body?: AnyZodObject,
+  query?: AnyZodObject,
+  path?: AnyZodObject,
+}>
+
+
+const validateRouteWith =
+  (schema: z.AnyZodObject) =>
+    async (req: express.Request, res: express.Response, next: NextFunction) => {
+      try {
+        await schema.parseAsync({
+          body: req.body,
+          query: req.query,
+          path: req.params,
+        });
+        return next();
+      } catch (error) {
+        return res.status(412).json(error);
+      }
+    };
+
+export const Routes = {
+  post: function<
+    ROUTE extends string,
+    VALIDATION_SCHEMA extends RequestWithBodyZodObject,
+    QUERY_PARAMS = z.infer<VALIDATION_SCHEMA>['query'],
+    BODY = z.infer<VALIDATION_SCHEMA>['body'],
+    PATH_PARAMS = Omit< RouteParameters<ROUTE>, keyof z.infer<VALIDATION_SCHEMA>['path']> & z.infer<VALIDATION_SCHEMA>['path']
+  >(app: Express, route: ROUTE, schema: VALIDATION_SCHEMA, callback: (res: express.Response, pathParams: PATH_PARAMS, queryParams: QUERY_PARAMS, body: BODY) => void) {
+    app.post(route, validateRouteWith(schema), (req, res) => {
+      callback(res, req.params as PATH_PARAMS, req.query as QUERY_PARAMS, req.body as BODY)
+    })
+  },
+  put: function<
+    ROUTE extends string,
+    VALIDATION_SCHEMA extends RequestWithBodyZodObject,
+    QUERY_PARAMS = z.infer<VALIDATION_SCHEMA>['query'],
+    BODY = z.infer<VALIDATION_SCHEMA>['body'],
+    PATH_PARAMS = Omit< RouteParameters<ROUTE>, keyof z.infer<VALIDATION_SCHEMA>['path']> & z.infer<VALIDATION_SCHEMA>['path']
+  >(app: Express, route: ROUTE, schema: VALIDATION_SCHEMA, callback: (res: express.Response, pathParams: PATH_PARAMS, queryParams: QUERY_PARAMS, body: BODY) => void) {
+    app.put(route, validateRouteWith(schema), (req, res) => {
+      callback(res, req.params as PATH_PARAMS, req.query as QUERY_PARAMS, req.body as BODY)
+    })
+  },
+  get: function<
+    ROUTE extends string,
+    VALIDATION_SCHEMA extends RequestZodObject,
+    QUERY_PARAMS = z.infer<VALIDATION_SCHEMA>['query'],
+    PATH_PARAMS = Omit< RouteParameters<ROUTE>, keyof z.infer<VALIDATION_SCHEMA>['path']> & z.infer<VALIDATION_SCHEMA>['path']
+  >(app: Express, route: ROUTE, schema: VALIDATION_SCHEMA, callback: (res: express.Response, pathParams: PATH_PARAMS, queryParams: QUERY_PARAMS) => void) {
+    app.get(route, validateRouteWith(schema), (req, res) => {
+      callback(res, req.params as PATH_PARAMS, req.query as QUERY_PARAMS)
+    })
+  },
+  delete: function<
+    ROUTE extends string,
+    VALIDATION_SCHEMA extends RequestZodObject,
+    QUERY_PARAMS = z.infer<VALIDATION_SCHEMA>['query'],
+    PATH_PARAMS = Omit< RouteParameters<ROUTE>, keyof z.infer<VALIDATION_SCHEMA>['path']> & z.infer<VALIDATION_SCHEMA>['path']
+  >(app: Express, route: ROUTE, schema: VALIDATION_SCHEMA, callback: (res: express.Response, pathParams: PATH_PARAMS, queryParams: QUERY_PARAMS) => void) {
+    app.delete(route, validateRouteWith(schema), (req, res) => {
+      callback(res, req.params as PATH_PARAMS, req.query as QUERY_PARAMS)
+    })
+  }
+}
+

cloud/functions/src/index.ts

@@ -1,5 +1,4 @@
 import crawl from "./functions/http/crawl"
-import hello from "./functions/http/hello"
 import {migrateFirestoreSchema} from "./functions/http/migrateFirestoreSchema";
 import {onUserTalksNoteCreate, onUserTalksNoteUpdate} from "./functions/firestore/onUserTalkNotes"
 import {onUserCreated} from "./functions/firestore/onUserCreated";
@@ -12,9 +11,14 @@ import deprecatedEventStats from "./functions/http/event/deprecatedEventStats";
 import talkFeedbacksViewers from "./functions/http/event/talkFeedbacksViewers";
 import publicEventStats from "./functions/http/event/publicEventStats";
 import {globalStats} from "./functions/http/event/globalStatistics";
+import * as express from 'express';
+import * as functions from 'firebase-functions';
+import {declareExpressHttpRoutes} from "./functions/http/routes";
 
-// For testing purposes only
-exports.helloWorld = hello
+const app = express()
+app.use(express.json());
+
+// Legacy HTTP Endpoints declaration... please use declareRoutes() instead !
 
 // For organizers
 exports.crawl = crawl
@@ -30,6 +34,11 @@ exports.eventStats = deprecatedEventStats
 exports.migrateFirestoreSchema = migrateFirestoreSchema
 exports.globalStats = globalStats
 
+// Express handler
+declareExpressHttpRoutes(app)
+exports.api = functions.https.onRequest(app);
+
+// Firebase handlers
 exports.onUserTalksNoteCreate = onUserTalksNoteCreate
 exports.onUserTalksNoteUpdate = onUserTalksNoteUpdate
 exports.onUserCreated = onUserCreated