Parse the scope from the URL

Author: matt-aitken

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.metrics.$dashboardKey/route.tsx

@@ -30,7 +30,7 @@ import { QueuesFilter } from "~/components/metrics/QueuesFilter";
 import { useCurrentPlan } from "../_app.orgs.$organizationSlug/route";
 import { useSearchParams } from "~/hooks/useSearchParam";
 import { type WidgetData } from "~/components/metrics/QueryWidget";
-import type { QueryScope } from "~/services/queryService.server";
+import { QueryScopeSchema } from "~/v3/querySchemas";
 
 const ParamSchema = EnvironmentParamSchema.extend({
   dashboardKey: z.string(),
@@ -145,7 +145,8 @@ export function MetricDashboard({
   const period = value("period");
   const from = value("from");
   const to = value("to");
-  const scope = (value("scope") as QueryScope) ?? "environment";
+  const parsedScope = QueryScopeSchema.safeParse(value("scope") ?? "environment");
+  const scope = parsedScope.success ? parsedScope.data : "environment";
   const tasks = values("tasks").filter((v) => v !== "");
   const queues = values("queues").filter((v) => v !== "");
 

apps/webapp/app/services/queryService.server.ts

@@ -20,11 +20,10 @@ import {
 import { getLimit } from "./platform.v3.server";
 import { timeFilters, timeFilterFromTo } from "~/components/runs/v3/SharedFilters";
 import parse from "parse-duration";
-import { querySchemas } from "~/v3/querySchemas";
+import { querySchemas, QueryScopeSchema, type QueryScope } from "~/v3/querySchemas";
 
-export type { TableSchema, TSQLQueryResult };
-
-export type QueryScope = "organization" | "project" | "environment";
+export { QueryScopeSchema };
+export type { TableSchema, TSQLQueryResult, QueryScope };
 
 const scopeToEnum = {
   organization: "ORGANIZATION",

apps/webapp/app/v3/querySchemas.ts

@@ -1,8 +1,12 @@
 import { column, type TableSchema } from "@internal/tsql";
+import { z } from "zod";
 import { autoFormatSQL } from "~/components/code/TSQLEditor";
 import { runFriendlyStatus, runStatusTitleFromStatus } from "~/components/runs/v3/TaskRunStatus";
 import { logger } from "~/services/logger.server";
 
+export const QueryScopeSchema = z.enum(["organization", "project", "environment"]);
+export type QueryScope = z.infer<typeof QueryScopeSchema>;
+
 /**
  * Environment type values
  */