Skip to content

Open-source status page, incident response and uptime monitoring

chore: improve dashboard not-found error pages (#2067)

Maximilian Kaske84d6dcc325cd
diff --git a/apps/dashboard/src/app/(dashboard)/error.tsx b/apps/dashboard/src/app/(dashboard)/error.tsx
new file mode 100644
index 000000000..4f56152f5
--- /dev/null
+++ b/apps/dashboard/src/app/(dashboard)/error.tsx
@@ -0,0 +1,58 @@
+"use client";
+
+import { Code } from "@/components/common/code";
+import { Button } from "@openstatus/ui/components/ui/button";
+import * as Sentry from "@sentry/nextjs";
+import Link from "next/link";
+import { useEffect } from "react";
+
+export default function ErrorPage({
+ error,
+ reset,
+}: {
+ error: Error & { digest?: string };
+ reset: () => void;
+}) {
+ useEffect(() => {
+ Sentry.captureException(error);
+ }, [error]);
+
+ return (
+ <main className="flex min-h-screen w-full flex-col items-center justify-center p-4 md:p-8">
+ <div className="mx-auto w-full max-w-md rounded-lg border border-border bg-sidebar">
+ <div className="flex flex-col gap-6 p-6 sm:p-8">
+ <div className="flex flex-col gap-1 text-center">
+ <p className="font-mono text-destructive">500 Error</p>
+ <h2 className="font-cal text-2xl text-foreground">
+ Something went wrong
+ </h2>
+ <p className="text-muted-foreground text-sm">
+ An unexpected error occurred. If this keeps happening, please{" "}
+ <a
+ href="mailto:[email protected]"
+ className="text-foreground underline underline-offset-4"
+ >
+ contact us
+ </a>
+ .
+ </p>
+ </div>
+ {process.env.NODE_ENV === "development" && (
+ <Code className="max-h-40 overflow-auto rounded-md border border-border bg-background text-destructive">
+ {error.message}
+ {error.stack && `\n\n${error.stack}`}
+ </Code>
+ )}
+ <div className="flex items-center justify-center gap-4">
+ <Button variant="outline" onClick={reset}>
+ Try again
+ </Button>
+ <Button asChild>
+ <Link href="/overview">Home</Link>
+ </Button>
+ </div>
+ </div>
+ </div>
+ </main>
+ );
+}
diff --git a/apps/dashboard/src/app/(dashboard)/monitors/[id]/layout.tsx b/apps/dashboard/src/app/(dashboard)/monitors/[id]/layout.tsx
index ec400b9fa..4c01e7a6a 100644
--- a/apps/dashboard/src/app/(dashboard)/monitors/[id]/layout.tsx
+++ b/apps/dashboard/src/app/(dashboard)/monitors/[id]/layout.tsx
@@ -4,7 +4,12 @@ import {
AppHeaderContent,
} from "@/components/nav/app-header";
import { AppSidebarTrigger } from "@/components/nav/app-sidebar";
-import { HydrateClient, getQueryClient, trpc } from "@/lib/trpc/server";
+import {
+ HydrateClient,
+ fetchQueryOrNotFound,
+ getQueryClient,
+ trpc,
+} from "@/lib/trpc/server";
import { Breadcrumb } from "./breadcrumb";
import { NavActions } from "./nav-actions";
import { Tabs } from "./tabs";
@@ -19,7 +24,7 @@ export default async function Layout({
const { id } = await params;
const queryClient = getQueryClient();
- await queryClient.prefetchQuery(
+ await fetchQueryOrNotFound(
trpc.monitor.get.queryOptions({ id: Number.parseInt(id) }),
);
await queryClient.prefetchQuery(trpc.notification.list.queryOptions());
diff --git a/apps/dashboard/src/app/(dashboard)/not-found.tsx b/apps/dashboard/src/app/(dashboard)/not-found.tsx
new file mode 100644
index 000000000..78b425702
--- /dev/null
+++ b/apps/dashboard/src/app/(dashboard)/not-found.tsx
@@ -0,0 +1,45 @@
+"use client";
+
+import { WorkspaceSwitcher } from "@/components/nav/workspace-switcher";
+import { Button } from "@openstatus/ui/components/ui/button";
+import Link from "next/link";
+import { useRouter } from "next/navigation";
+
+export default function NotFound() {
+ const router = useRouter();
+
+ return (
+ <main className="flex min-h-screen w-full flex-col items-center justify-center p-4 md:p-8">
+ <div className="mx-auto w-full max-w-md rounded-lg border border-border bg-sidebar">
+ <div className="flex flex-col gap-6 p-6 sm:p-8">
+ <div className="flex flex-col gap-1 text-center">
+ <p className="font-mono text-destructive">404 Not found</p>
+ <h2 className="font-cal text-2xl text-foreground">
+ Page not found
+ </h2>
+ <p className="text-muted-foreground text-sm">
+ This resource doesn&apos;t exist or you might not be in the right
+ workspace.
+ </p>
+ </div>
+ <WorkspaceSwitcher
+ className="rounded-md border border-border bg-background"
+ side="bottom"
+ />
+ <div className="flex items-center justify-center gap-4">
+ <Button
+ variant="outline"
+ onClick={router.back}
+ className="cursor-pointer"
+ >
+ Go Back
+ </Button>
+ <Button asChild>
+ <Link href="/overview">Home</Link>
+ </Button>
+ </div>
+ </div>
+ </div>
+ </main>
+ );
+}
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/layout.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/layout.tsx
index 9c067825e..c972c8c4b 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/layout.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/layout.tsx
@@ -1,5 +1,3 @@
-import { redirect } from "next/navigation";
-
import {
AppHeader,
AppHeaderActions,
@@ -7,7 +5,12 @@ import {
} from "@/components/nav/app-header";
import { AppSidebarTrigger } from "@/components/nav/app-sidebar";
-import { HydrateClient, getQueryClient, trpc } from "@/lib/trpc/server";
+import {
+ HydrateClient,
+ fetchQueryOrNotFound,
+ getQueryClient,
+ trpc,
+} from "@/lib/trpc/server";
import { Breadcrumb } from "./breadcrumb";
import { NavActions } from "./nav-actions";
import { Tabs } from "./tabs";
@@ -22,14 +25,9 @@ export default async function Layout({
const { id } = await params;
const queryClient = getQueryClient();
- const pageData = await queryClient.fetchQuery(
+ await fetchQueryOrNotFound(
trpc.page.get.queryOptions({ id: Number.parseInt(id) }),
);
-
- if (!pageData?.id) {
- redirect("/status-pages");
- }
-
await queryClient.prefetchQuery(trpc.monitor.list.queryOptions());
return (
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/layout.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/layout.tsx
index 58900778e..5b2d27ade 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/layout.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/layout.tsx
@@ -1,4 +1,4 @@
-import { HydrateClient, getQueryClient, trpc } from "@/lib/trpc/server";
+import { HydrateClient, fetchQueryOrNotFound, trpc } from "@/lib/trpc/server";
export default async function Layout({
children,
@@ -8,12 +8,13 @@ export default async function Layout({
params: Promise<{ id: string; reportId: string }>;
}) {
const { id, reportId } = await params;
- const queryClient = getQueryClient();
- await queryClient.prefetchQuery(
- trpc.statusReport.get.queryOptions({ id: Number.parseInt(reportId) }),
- );
- await queryClient.prefetchQuery(
- trpc.page.get.queryOptions({ id: Number.parseInt(id) }),
- );
+ await Promise.all([
+ fetchQueryOrNotFound(
+ trpc.statusReport.get.queryOptions({ id: Number.parseInt(reportId) }),
+ ),
+ fetchQueryOrNotFound(
+ trpc.page.get.queryOptions({ id: Number.parseInt(id) }),
+ ),
+ ]);
return <HydrateClient>{children}</HydrateClient>;
}
diff --git a/apps/dashboard/src/components/forms/components/form-components.tsx b/apps/dashboard/src/components/forms/components/form-components.tsx
index 4066c1db9..93030e502 100644
--- a/apps/dashboard/src/components/forms/components/form-components.tsx
+++ b/apps/dashboard/src/components/forms/components/form-components.tsx
@@ -1147,7 +1147,7 @@ function ComponentGroupRow({
onCheckedChange={field.onChange}
/>
</FormControl>
- <FormLabel className="!mt-0 text-muted-foreground text-sm font-normal">
+ <FormLabel className="!mt-0 font-normal text-muted-foreground text-sm">
Open by default
</FormLabel>
</FormItem>
diff --git a/apps/dashboard/src/components/nav/workspace-switcher.tsx b/apps/dashboard/src/components/nav/workspace-switcher.tsx
index ff5afeb3a..849003b7d 100644
--- a/apps/dashboard/src/components/nav/workspace-switcher.tsx
+++ b/apps/dashboard/src/components/nav/workspace-switcher.tsx
@@ -2,6 +2,7 @@
import { ChevronsUpDown, Plus } from "lucide-react";
+import { Link } from "@/components/common/link";
import { useTRPC } from "@/lib/trpc/client";
import {
DropdownMenu,
@@ -17,10 +18,15 @@ import {
SidebarMenuItem,
useSidebar,
} from "@openstatus/ui/components/ui/sidebar";
+import { cn } from "@openstatus/ui/lib/utils";
import { useQuery } from "@tanstack/react-query";
-import { Link } from "../common/link";
-export function WorkspaceSwitcher() {
+interface WorkspaceSwitcherProps {
+ className?: string;
+ side?: React.ComponentProps<typeof DropdownMenuContent>["side"];
+}
+
+export function WorkspaceSwitcher({ className, side }: WorkspaceSwitcherProps) {
const { isMobile, setOpenMobile } = useSidebar();
const trpc = useTRPC();
const { data: workspace } = useQuery(trpc.workspace.get.queryOptions());
@@ -40,7 +46,10 @@ export function WorkspaceSwitcher() {
<DropdownMenuTrigger asChild>
<SidebarMenuButton
size="lg"
- className="h-14 rounded-none px-4 ring-inset data-[state=open]:bg-sidebar-accent data-[state=open]:text-sidebar-accent-foreground group-data-[collapsible=icon]:mx-2! group-data-[collapsible=icon]:rounded-lg! group-data-[collapsible=icon]:px-0!"
+ className={cn(
+ "h-14 rounded-none px-4 ring-inset data-[state=open]:bg-sidebar-accent data-[state=open]:text-sidebar-accent-foreground group-data-[collapsible=icon]:mx-2! group-data-[collapsible=icon]:rounded-lg! group-data-[collapsible=icon]:px-0!",
+ className,
+ )}
>
<div className="flex aspect-square size-8 items-center justify-center rounded-lg bg-sidebar-primary">
<div className="size-8 overflow-hidden rounded-lg">
@@ -69,7 +78,7 @@ export function WorkspaceSwitcher() {
<DropdownMenuContent
className="w-(--radix-dropdown-menu-trigger-width) min-w-56 rounded-lg"
align="start"
- side={isMobile ? "bottom" : "right"}
+ side={side ?? (isMobile ? "bottom" : "right")}
sideOffset={4}
>
<DropdownMenuLabel className="text-muted-foreground text-xs">
diff --git a/apps/dashboard/src/lib/trpc/server.tsx b/apps/dashboard/src/lib/trpc/server.tsx
index 44769136a..1c4219686 100644
--- a/apps/dashboard/src/lib/trpc/server.tsx
+++ b/apps/dashboard/src/lib/trpc/server.tsx
@@ -4,12 +4,14 @@ import type { AppRouter } from "@openstatus/api";
import { HydrationBoundary } from "@tanstack/react-query";
import { dehydrate } from "@tanstack/react-query";
-import { createTRPCClient, loggerLink } from "@trpc/client";
+import { TRPCClientError, createTRPCClient, loggerLink } from "@trpc/client";
import {
+ type ResolverDef,
type TRPCQueryOptions,
createTRPCOptionsProxy,
} from "@trpc/tanstack-react-query";
import { cookies } from "next/headers";
+import { notFound } from "next/navigation";
import { cache } from "react";
import { makeQueryClient } from "./query-client";
import { endingLink } from "./shared";
@@ -86,3 +88,23 @@ export function batchPrefetch<T extends ReturnType<TRPCQueryOptions<any>>>(
}
}
}
+
+/**
+ * Fetches a query and calls `notFound()` if the server returns NOT_FOUND.
+ * Use this for gating queries in layouts where the resource must exist.
+ */
+export async function fetchQueryOrNotFound<
+ T extends ReturnType<TRPCQueryOptions<ResolverDef>>,
+>(queryOptions: T) {
+ const queryClient = getQueryClient();
+ try {
+ return (await queryClient.fetchQuery(queryOptions)) as Awaited<
+ ReturnType<Extract<T["queryFn"], (...args: never[]) => unknown>>
+ >;
+ } catch (error) {
+ if (error instanceof TRPCClientError && error.data?.code === "NOT_FOUND") {
+ notFound();
+ }
+ throw error;
+ }
+}
diff --git a/packages/api/src/router/monitor.ts b/packages/api/src/router/monitor.ts
index 4d177d771..ee6dfd1c1 100644
--- a/packages/api/src/router/monitor.ts
+++ b/packages/api/src/router/monitor.ts
@@ -206,7 +206,12 @@ export const monitorRouter = createTRPCRouter({
},
});
- if (!data) return null;
+ if (!data) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Monitor not found",
+ });
+ }
return selectMonitorSchema
.extend({
diff --git a/packages/api/src/router/page.ts b/packages/api/src/router/page.ts
index 1b64d83ef..beb54e004 100644
--- a/packages/api/src/router/page.ts
+++ b/packages/api/src/router/page.ts
@@ -247,6 +247,13 @@ export const pageRouter = createTRPCRouter({
},
});
+ if (!data) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Page not found",
+ });
+ }
+
return selectPageSchema
.extend({
pageComponentGroups: z
@@ -257,9 +264,9 @@ export const pageRouter = createTRPCRouter({
})
.parse({
...data,
- pageComponentGroups: data?.pageComponentGroups ?? [],
- maintenances: data?.maintenances,
- pageComponents: data?.pageComponents,
+ pageComponentGroups: data.pageComponentGroups ?? [],
+ maintenances: data.maintenances,
+ pageComponents: data.pageComponents,
});
}),