feat: use zod for validation

alexcambose · alexcambose · commit 996663627d5a · 2025-08-15T16:46:24.000+02:00
diff --git a/apps/insights/package.json b/apps/insights/package.json
@@ -46,7 +46,8 @@
     "superjson": "catalog:",
     "swr": "catalog:",
     "zod": "catalog:",
-    "zod-validation-error": "catalog:"
+    "zod-validation-error": "catalog:",
+    "zod-search-params": "catalog:"
   },
   "devDependencies": {
     "@cprussin/eslint-config": "catalog:",
diff --git a/apps/insights/src/app/api/pyth/get-feeds-for-publisher/[publisher]/route.ts b/apps/insights/src/app/api/pyth/get-feeds-for-publisher/[publisher]/route.ts
@@ -1,28 +1,36 @@
-import { NextRequest, NextResponse } from "next/server";
+import { NextRequest } from "next/server";
 import { stringify } from "superjson";
-
-import { Cluster, parseCluster } from "../../../../../services/pyth";
+import { z } from "zod";
+import { parseSearchParams } from "zod-search-params";
+
+import {
+  Cluster,
+  CLUSTER_NAMES,
+  ClusterToName,
+  toCluster,
+} from "../../../../../services/pyth";
 import { getFeeds } from "../../../../../services/pyth/get-feeds";
 
 export const GET = async (
   request: NextRequest,
   { params }: { params: Promise<{ publisher: string }> },
 ) => {
   const { publisher } = await params;
-  const clusterName = request.nextUrl.searchParams.get("cluster");
-
-  const cluster =
-    clusterName === null ? Cluster.Pythnet : parseCluster(clusterName);
+  const searchParams = request.nextUrl.searchParams;
+  const parsedSearchParams = parseSearchParams(queryParamsSchema, searchParams);
 
-  if (cluster === undefined) {
-    return NextResponse.json({ error: "Invalid Cluster" }, { status: 400 });
+  if (!parsedSearchParams) {
+    return new Response("Invalid params", {
+      status: 400,
+    });
   }
 
+  const { cluster } = parsedSearchParams;
+
   if (!publisher) {
-    return NextResponse.json(
-      { error: "Publisher is required" },
-      { status: 400 },
-    );
+    return new Response("Publisher is required", {
+      status: 400,
+    });
   }
 
   const feeds = await getFeeds(cluster);
@@ -37,3 +45,10 @@ export const GET = async (
     },
   });
 };
+
+const queryParamsSchema = z.object({
+  cluster: z
+    .enum(CLUSTER_NAMES)
+    .transform((value) => toCluster(value))
+    .default(ClusterToName[Cluster.Pythnet]),
+});
diff --git a/apps/insights/src/app/api/pyth/get-feeds/[symbol]/route.ts b/apps/insights/src/app/api/pyth/get-feeds/[symbol]/route.ts
@@ -1,24 +1,32 @@
-import { NextResponse } from "next/server";
+import { NextRequest } from "next/server";
 import { stringify } from "superjson";
+import { z } from "zod";
+import { parseSearchParams } from "zod-search-params";
 
-import { Cluster } from "../../../../../services/pyth";
+import {
+  Cluster,
+  CLUSTER_NAMES,
+  ClusterToName,
+  toCluster,
+} from "../../../../../services/pyth";
 import { getFeeds } from "../../../../../services/pyth/get-feeds";
 
 export const GET = async (
-  request: Request,
+  request: NextRequest,
   { params }: { params: Promise<{ symbol: string }> },
 ) => {
   const { symbol } = await params;
-  const { searchParams } = new URL(request.url);
-  const cluster = Number.parseInt(
-    searchParams.get("cluster") ?? Cluster.Pythnet.toString(),
-  ) as Cluster;
+  const searchParams = request.nextUrl.searchParams;
+  const parsedSearchParams = parseSearchParams(queryParamsSchema, searchParams);
 
-  // check if cluster is valid
-  if (cluster && !Object.values(Cluster).includes(cluster)) {
-    return NextResponse.json({ error: "Invalid cluster" }, { status: 400 });
+  if (!parsedSearchParams) {
+    return new Response("Invalid params", {
+      status: 400,
+    });
   }
 
+  const { cluster } = parsedSearchParams;
+
   const feeds = await getFeeds(cluster);
   const feed = feeds.find((feed) => feed.symbol === symbol);
 
@@ -28,3 +36,10 @@ export const GET = async (
     },
   });
 };
+
+const queryParamsSchema = z.object({
+  cluster: z
+    .enum(CLUSTER_NAMES)
+    .transform((value) => toCluster(value))
+    .default(ClusterToName[Cluster.Pythnet]),
+});
diff --git a/apps/insights/src/app/api/pyth/get-feeds/route.ts b/apps/insights/src/app/api/pyth/get-feeds/route.ts
@@ -1,23 +1,24 @@
-import { NextResponse } from "next/server";
+import { NextRequest } from "next/server";
 import { stringify } from "superjson";
+import { z } from "zod";
+import { parseSearchParams } from "zod-search-params";
 
-import { Cluster } from "../../../../services/pyth";
+import { CLUSTER_NAMES, toCluster } from "../../../../services/pyth";
 import { getFeeds } from "../../../../services/pyth/get-feeds";
 
-export const GET = async (request: Request) => {
+export const GET = async (request: NextRequest) => {
   // get cluster from query params
-  const { searchParams } = new URL(request.url);
-  const excludePriceComponents =
-    searchParams.get("excludePriceComponents") === "true";
-  const cluster = Number.parseInt(
-    searchParams.get("cluster") ?? Cluster.Pythnet.toString(),
-  ) as Cluster;
+  const searchParams = request.nextUrl.searchParams;
+  const parsedSearchParams = parseSearchParams(queryParamsSchema, searchParams);
 
-  // check if cluster is valid
-  if (cluster && !Object.values(Cluster).includes(cluster)) {
-    return NextResponse.json({ error: "Invalid cluster" }, { status: 400 });
+  if (!parsedSearchParams) {
+    return new Response("Invalid params", {
+      status: 400,
+    });
   }
 
+  const { excludePriceComponents, cluster } = parsedSearchParams;
+
   const feeds = await getFeeds(cluster);
   const filteredFeeds = excludePriceComponents
     ? feeds.map((feed) => {
@@ -33,3 +34,8 @@ export const GET = async (request: Request) => {
     },
   });
 };
+
+const queryParamsSchema = z.object({
+  cluster: z.enum(CLUSTER_NAMES).transform((value) => toCluster(value)),
+  excludePriceComponents: z.boolean(),
+});
diff --git a/apps/insights/src/app/api/pyth/get-publishers/[symbol]/route.ts b/apps/insights/src/app/api/pyth/get-publishers/[symbol]/route.ts
@@ -1,29 +1,45 @@
-import { NextResponse } from "next/server";
+import { NextRequest, NextResponse } from "next/server";
+import { z } from "zod";
+import { parseSearchParams } from "zod-search-params";
 
-import { Cluster } from "../../../../../services/pyth";
+import {
+  Cluster,
+  CLUSTER_NAMES,
+  ClusterToName,
+  toCluster,
+} from "../../../../../services/pyth";
 import { getPublishersForCluster } from "../../../../../services/pyth/get-publishers-for-cluster";
 
 export const GET = async (
-  request: Request,
+  request: NextRequest,
   { params }: { params: Promise<{ symbol: string }> },
 ) => {
   const { symbol } = await params;
-  // get cluster from query params
-  const { searchParams } = new URL(request.url);
-  const cluster = Number.parseInt(
-    searchParams.get("cluster") ?? Cluster.Pythnet.toString(),
-  ) as Cluster;
-
-  // check if cluster is valid
-  if (cluster && !Object.values(Cluster).includes(cluster)) {
-    return NextResponse.json({ error: "Invalid cluster" }, { status: 400 });
+  const searchParams = request.nextUrl.searchParams;
+  const parsedSearchParams = parseSearchParams(queryParamsSchema, searchParams);
+
+  if (!parsedSearchParams) {
+    return new Response("Invalid params", {
+      status: 400,
+    });
   }
 
+  const { cluster } = parsedSearchParams;
+
   if (!symbol) {
-    return NextResponse.json({ error: "Symbol is required" }, { status: 400 });
+    return new Response("Symbol is required", {
+      status: 400,
+    });
   }
 
   const map = await getPublishersForCluster(cluster);
 
   return NextResponse.json(map[symbol] ?? []);
 };
+
+const queryParamsSchema = z.object({
+  cluster: z
+    .enum(CLUSTER_NAMES)
+    .transform((value) => toCluster(value))
+    .default(ClusterToName[Cluster.Pythnet]),
+});
diff --git a/apps/insights/src/server/pyth.ts b/apps/insights/src/server/pyth.ts
@@ -2,15 +2,15 @@ import { parse } from "superjson";
 import { z } from "zod";
 
 import { PUBLIC_URL, VERCEL_AUTOMATION_BYPASS_SECRET } from "../config/server";
-import { Cluster, priceFeedsSchema } from "../services/pyth";
+import { Cluster, ClusterToName, priceFeedsSchema } from "../services/pyth";
 import { DEFAULT_CACHE_TTL } from "../utils/cache";
 
 export async function getPublishersForFeedRequest(
   cluster: Cluster,
   symbol: string,
 ) {
   const data = await fetch(
-    `${PUBLIC_URL}/api/pyth/get-publishers/${encodeURIComponent(symbol)}?cluster=${cluster.toString()}`,
+    `${PUBLIC_URL}/api/pyth/get-publishers/${encodeURIComponent(symbol)}?cluster=${ClusterToName[cluster]}`,
     {
       next: {
         revalidate: DEFAULT_CACHE_TTL,
@@ -30,7 +30,7 @@ export async function getFeedsForPublisherRequest(
   publisher: string,
 ) {
   const data = await fetch(
-    `${PUBLIC_URL}/api/pyth/get-feeds-for-publisher/${encodeURIComponent(publisher)}?cluster=${cluster.toString()}`,
+    `${PUBLIC_URL}/api/pyth/get-feeds-for-publisher/${encodeURIComponent(publisher)}?cluster=${ClusterToName[cluster]}`,
     {
       next: {
         revalidate: DEFAULT_CACHE_TTL,
@@ -48,7 +48,7 @@ export async function getFeedsForPublisherRequest(
 
 export const getFeedsRequest = async (cluster: Cluster) => {
   const data = await fetch(
-    `${PUBLIC_URL}/api/pyth/get-feeds?cluster=${cluster.toString()}&excludePriceComponents=true`,
+    `${PUBLIC_URL}/api/pyth/get-feeds?cluster=${ClusterToName[cluster]}&excludePriceComponents=true`,
     {
       next: {
         revalidate: DEFAULT_CACHE_TTL,
@@ -76,7 +76,7 @@ export const getFeedForSymbolRequest = async ({
   cluster?: Cluster;
 }): Promise<z.infer<typeof priceFeedsSchema>[0] | undefined> => {
   const data = await fetch(
-    `${PUBLIC_URL}/api/pyth/get-feeds/${encodeURIComponent(symbol)}?cluster=${cluster.toString()}`,
+    `${PUBLIC_URL}/api/pyth/get-feeds/${encodeURIComponent(symbol)}?cluster=${ClusterToName[cluster]}`,
     {
       next: {
         revalidate: DEFAULT_CACHE_TTL,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
