add more typing

devksingh4 · devksingh4 · commit 4f2b5ec7c9c9 · 2025-04-21T02:34:54.000Z
diff --git a/src/api/index.ts b/src/api/index.ts
@@ -41,6 +41,7 @@ import {
   validatorCompiler,
 } from "fastify-zod-openapi";
 import { ZodOpenApiVersion } from "zod-openapi";
+import { withTags } from "./components/index.js";
 
 dotenv.config();
 
@@ -149,7 +150,11 @@ async function init(prettyPrint: boolean = false) {
     );
     done();
   });
-  app.get("/api/v1/healthz", (_, reply) => reply.send({ message: "UP" }));
+  app.get(
+    "/api/v1/healthz",
+    { schema: withTags(["Generic"], {}) },
+    (_, reply) => reply.send({ message: "UP" }),
+  );
   await app.register(
     async (api, _options) => {
       api.register(protectedRoute, { prefix: "/protected" });
diff --git a/src/api/routes/ics.ts b/src/api/routes/ics.ts
@@ -18,6 +18,14 @@ import { OrganizationList } from "../../common/orgs.js";
 import { CLIENT_HTTP_CACHE_POLICY, EventRepeatOptions } from "./events.js";
 import rateLimiter from "api/plugins/rateLimiter.js";
 import { getCacheCounter } from "api/functions/cache.js";
+import {
+  FastifyZodOpenApiSchema,
+  FastifyZodOpenApiTypeProvider,
+  serializerCompiler,
+  validatorCompiler,
+} from "fastify-zod-openapi";
+import { withTags } from "api/components/index.js";
+import { z } from "zod";
 
 const repeatingIcalMap: Record<EventRepeatOptions, ICalEventJSONRepeatingData> =
   {
@@ -36,128 +44,144 @@ function generateHostName(host: string) {
 }
 
 const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
+  fastify.setValidatorCompiler(validatorCompiler);
+  fastify.setSerializerCompiler(serializerCompiler);
   fastify.register(rateLimiter, {
     limit: OrganizationList.length,
     duration: 30,
     rateLimitIdentifier: "ical",
   });
-  fastify.get("/:host?", async (request, reply) => {
-    const host = (request.params as Record<string, string>).host;
-    let queryParams: QueryCommandInput = {
-      TableName: genericConfig.EventsDynamoTableName,
-    };
-    let response;
-    const ifNoneMatch = request.headers["if-none-match"];
-    if (ifNoneMatch) {
-      const etag = await getCacheCounter(
-        fastify.dynamoClient,
-        `events-etag-${host || "all"}`,
-      );
+  fastify.withTypeProvider<FastifyZodOpenApiTypeProvider>().get(
+    "/:host?",
+    {
+      schema: withTags(["iCalendar Integration"], {
+        params: z.object({
+          host: z
+            .optional(z.enum(OrganizationList as [string, ...string[]]))
+            .openapi({ description: "Host to get calendar for." }),
+        }),
+      } satisfies FastifyZodOpenApiSchema),
+    },
+    async (request, reply) => {
+      const host = request.params.host || "ACM";
+      let queryParams: QueryCommandInput = {
+        TableName: genericConfig.EventsDynamoTableName,
+      };
+      let response;
+      const ifNoneMatch = request.headers["if-none-match"];
+      if (ifNoneMatch) {
+        const etag = await getCacheCounter(
+          fastify.dynamoClient,
+          `events-etag-${host || "all"}`,
+        );
 
-      if (
-        ifNoneMatch === `"${etag.toString()}"` ||
-        ifNoneMatch === etag.toString()
-      ) {
-        return reply
-          .code(304)
-          .header("ETag", etag)
-          .header("Cache-Control", CLIENT_HTTP_CACHE_POLICY)
-          .send();
-      }
+        if (
+          ifNoneMatch === `"${etag.toString()}"` ||
+          ifNoneMatch === etag.toString()
+        ) {
+          return reply
+            .code(304)
+            .header("ETag", etag)
+            .header("Cache-Control", CLIENT_HTTP_CACHE_POLICY)
+            .send();
+        }
 
-      reply.header("etag", etag);
-    }
-    if (host) {
-      if (!OrganizationList.includes(host)) {
-        throw new ValidationError({
-          message: `Invalid host parameter "${host}" in path.`,
-        });
+        reply.header("etag", etag);
       }
-      queryParams = {
-        ...queryParams,
-      };
-      response = await fastify.dynamoClient.send(
-        new QueryCommand({
+      if (host) {
+        if (!OrganizationList.includes(host)) {
+          throw new ValidationError({
+            message: `Invalid host parameter "${host}" in path.`,
+          });
+        }
+        queryParams = {
           ...queryParams,
-          ExpressionAttributeValues: {
-            ":host": {
-              S: host,
+        };
+        response = await fastify.dynamoClient.send(
+          new QueryCommand({
+            ...queryParams,
+            ExpressionAttributeValues: {
+              ":host": {
+                S: host,
+              },
             },
-          },
-          KeyConditionExpression: "host = :host",
-          IndexName: "HostIndex",
-        }),
-      );
-    } else {
-      response = await fastify.dynamoClient.send(new ScanCommand(queryParams));
-    }
-    const dynamoItems = response.Items
-      ? response.Items.map((x) => unmarshall(x))
-      : null;
-    if (!dynamoItems) {
-      throw new NotFoundError({
-        endpointName: host ? `/api/v1/ical/${host}` : "/api/v1/ical",
-      });
-    }
-    // generate friendly calendar name
-    let calendarName =
-      host && host.includes("ACM")
-        ? `${host} Events`
-        : `ACM@UIUC - ${host} Events`;
-    if (host == "ACM") {
-      calendarName = "ACM@UIUC - Major Events";
-    }
-    if (!host) {
-      calendarName = "ACM@UIUC - All Events";
-    }
-    const calendar = ical({ name: calendarName });
-    calendar.timezone({
-      name: "America/Chicago",
-      generator: getVtimezoneComponent,
-    });
-    calendar.method(ICalCalendarMethod.PUBLISH);
-    for (const rawEvent of dynamoItems) {
-      let event = calendar.createEvent({
-        start: moment.tz(rawEvent.start, "America/Chicago"),
-        end: rawEvent.end
-          ? moment.tz(rawEvent.end, "America/Chicago")
-          : moment.tz(rawEvent.start, "America/Chicago"),
-        summary: rawEvent.title,
-        description: rawEvent.locationLink
-          ? `Host: ${rawEvent.host}\nGoogle Maps Link: ${rawEvent.locationLink}\n\n` +
-            rawEvent.description
-          : `Host: ${rawEvent.host}\n\n` + rawEvent.description,
-        timezone: "America/Chicago",
-        organizer: generateHostName(host),
-        id: rawEvent.id,
+            KeyConditionExpression: "host = :host",
+            IndexName: "HostIndex",
+          }),
+        );
+      } else {
+        response = await fastify.dynamoClient.send(
+          new ScanCommand(queryParams),
+        );
+      }
+      const dynamoItems = response.Items
+        ? response.Items.map((x) => unmarshall(x))
+        : null;
+      if (!dynamoItems) {
+        throw new NotFoundError({
+          endpointName: host ? `/api/v1/ical/${host}` : "/api/v1/ical",
+        });
+      }
+      // generate friendly calendar name
+      let calendarName =
+        host && host.includes("ACM")
+          ? `${host} Events`
+          : `ACM@UIUC - ${host} Events`;
+      if (host == "ACM") {
+        calendarName = "ACM@UIUC - Major Events";
+      }
+      if (!host) {
+        calendarName = "ACM@UIUC - All Events";
+      }
+      const calendar = ical({ name: calendarName });
+      calendar.timezone({
+        name: "America/Chicago",
+        generator: getVtimezoneComponent,
       });
+      calendar.method(ICalCalendarMethod.PUBLISH);
+      for (const rawEvent of dynamoItems) {
+        let event = calendar.createEvent({
+          start: moment.tz(rawEvent.start, "America/Chicago"),
+          end: rawEvent.end
+            ? moment.tz(rawEvent.end, "America/Chicago")
+            : moment.tz(rawEvent.start, "America/Chicago"),
+          summary: rawEvent.title,
+          description: rawEvent.locationLink
+            ? `Host: ${rawEvent.host}\nGoogle Maps Link: ${rawEvent.locationLink}\n\n` +
+              rawEvent.description
+            : `Host: ${rawEvent.host}\n\n` + rawEvent.description,
+          timezone: "America/Chicago",
+          organizer: generateHostName(host),
+          id: rawEvent.id,
+        });
 
-      if (rawEvent.repeats) {
-        if (rawEvent.repeatEnds) {
-          event = event.repeating({
-            ...repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
-            until: moment.tz(rawEvent.repeatEnds, "America/Chicago"),
+        if (rawEvent.repeats) {
+          if (rawEvent.repeatEnds) {
+            event = event.repeating({
+              ...repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+              until: moment.tz(rawEvent.repeatEnds, "America/Chicago"),
+            });
+          } else {
+            event.repeating(
+              repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+            );
+          }
+        }
+        if (rawEvent.location) {
+          event = event.location({
+            title: rawEvent.location,
           });
-        } else {
-          event.repeating(
-            repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
-          );
         }
       }
-      if (rawEvent.location) {
-        event = event.location({
-          title: rawEvent.location,
-        });
-      }
-    }
 
-    reply
-      .headers({
-        "Content-Type": "text/calendar; charset=utf-8",
-        "Content-Disposition": 'attachment; filename="calendar.ics"',
-      })
-      .send(calendar.toString());
-  });
+      reply
+        .headers({
+          "Content-Type": "text/calendar; charset=utf-8",
+          "Content-Disposition": 'attachment; filename="calendar.ics"',
+        })
+        .send(calendar.toString());
+    },
+  );
 };
 
 export default icalPlugin;
diff --git a/src/api/routes/membership.ts b/src/api/routes/membership.ts
@@ -227,7 +227,7 @@ const membershipPlugin: FastifyPluginAsync = async (fastify, _options) => {
   };
   fastify.post(
     "/provision",
-    { config: { rawBody: true } },
+    { config: { rawBody: true }, schema: { hide: true } },
     async (request, reply) => {
       let event: Stripe.Event;
       if (!request.rawBody) {
diff --git a/src/api/routes/organizations.ts b/src/api/routes/organizations.ts
@@ -2,6 +2,7 @@ import { FastifyPluginAsync } from "fastify";
 import { OrganizationList } from "../../common/orgs.js";
 import fastifyCaching from "@fastify/caching";
 import rateLimiter from "api/plugins/rateLimiter.js";
+import { withTags } from "api/components/index.js";
 
 const organizationsPlugin: FastifyPluginAsync = async (fastify, _options) => {
   fastify.register(fastifyCaching, {
@@ -14,9 +15,13 @@ const organizationsPlugin: FastifyPluginAsync = async (fastify, _options) => {
     duration: 60,
     rateLimitIdentifier: "organizations",
   });
-  fastify.get("/", {}, async (request, reply) => {
-    reply.send(OrganizationList);
-  });
+  fastify.get(
+    "/",
+    { schema: withTags(["Generic"], {}) },
+    async (request, reply) => {
+      reply.send(OrganizationList);
+    },
+  );
 };
 
 export default organizationsPlugin;
diff --git a/src/api/routes/protected.ts b/src/api/routes/protected.ts
@@ -1,16 +1,21 @@
 import { FastifyPluginAsync } from "fastify";
 import rateLimiter from "api/plugins/rateLimiter.js";
+import { withTags } from "api/components/index.js";
 
 const protectedRoute: FastifyPluginAsync = async (fastify, _options) => {
   await fastify.register(rateLimiter, {
     limit: 15,
     duration: 30,
     rateLimitIdentifier: "protected",
   });
-  fastify.get("/", async (request, reply) => {
-    const roles = await fastify.authorize(request, reply, []);
-    reply.send({ username: request.username, roles: Array.from(roles) });
-  });
+  fastify.get(
+    "/",
+    { schema: withTags(["Generic"], {}) },
+    async (request, reply) => {
+      const roles = await fastify.authorize(request, reply, []);
+      reply.send({ username: request.username, roles: Array.from(roles) });
+    },
+  );
 };
 
 export default protectedRoute;
diff --git a/src/api/routes/vending.ts b/src/api/routes/vending.ts
