Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
chore: update onboarding (#2032)
Maximilian Kaske0d290776fdb1
diff --git a/apps/dashboard/src/app/(dashboard)/onboarding/client.tsx b/apps/dashboard/src/app/(dashboard)/onboarding/client.tsxindex bf83003c2..4a69a3e12 100644--- a/apps/dashboard/src/app/(dashboard)/onboarding/client.tsx+++ b/apps/dashboard/src/app/(dashboard)/onboarding/client.tsx@@ -24,73 +24,72 @@ import {} from "@/components/forms/form-card";import { CreateMonitorForm } from "@/components/forms/onboarding/create-monitor";import { CreatePageForm } from "@/components/forms/onboarding/create-page";-import { LearnFromForm } from "@/components/forms/onboarding/learn-from";+import { QuestionForm } from "@/components/forms/onboarding/question";import { extractDomain } from "@/lib/domains";import { useTRPC } from "@/lib/trpc/client";+import { cn } from "@/lib/utils";import { Button } from "@openstatus/ui/components/ui/button";import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";-import { ArrowUpRight } from "lucide-react";+import { Activity, ArrowUpRight, Layers, PanelTop } from "lucide-react";import Link from "next/link";-import { useRouter } from "next/navigation";+import { usePathname, useRouter } from "next/navigation";import { useQueryStates } from "nuqs";-import { useEffect } from "react";+import { useEffect, useMemo } from "react";+import type { Intent } from "./search-params";import { searchParamsParsers } from "./search-params";-const moreActions = [+const intents: {+ id: Intent;+ title: string;+ description: string;+ icon: typeof Activity;+}[] = [{- id: "notifier",- title: "Create a notifier",- description: "Get notified when your website or API is down.",- href: "/notifications",+ id: "status-page",+ title: "Status Page",+ description:+ "Keep your users informed with a public status page showing your system health.",+ icon: PanelTop,},{- id: "workspace",- title: "Setup workspace",- description: "Add a name to your workspace and share it with your team.",- href: "/settings/general",+ id: "monitoring",+ title: "Monitoring",+ description:+ "Track uptime and performance of your websites and APIs from multiple locations.",+ icon: Activity,},{- id: "monitor",- title: "Update monitor",- description: "Change region, schedule, timeout and more.",- href: "/monitors",- },- {- id: "cal",- title: "Schedule a call",- description: "Book a meeting with us to get you started with OpenStatus.",- href: "https://openstatus.dev/cal",- },- {- id: "docs",- title: "Documentation",- description: "Read our documentation to get started with OpenStatus.",- href: "https://docs.openstatus.dev",- },- {- id: "changelog",- title: "Changelog",- description: "See what's new in OpenStatus.",- href: "https://openstatus.dev/changelog",- },- {- id: "discord",- title: "Discord",- description: "Join our Discord server if you get stuck.",- href: "https://discord.gg/openstatus",- },- {- id: "github",- title: "GitHub",- description: "Leave a star on GitHub, request features or report issues.",- href: "https://github.com/openstatus-dev/openstatus",+ id: "both",+ title: "Status Page & Monitoring",+ description:+ "Monitor your services and share real-time status with your users.",+ icon: Layers,},];+function getTotalSteps(intent: Intent | null): number {+ if (intent === "both") return 4;+ return 3;+}++function getCurrentStepNumber(+ step: string,+ intent: Intent | null,+): number | null {+ if (step === "1") return 1;+ if (step === "2") return 2;+ if (step === "3" && intent === "both") return 3;+ if (step === "next") return null; // no counter on final page+ return null;+}+export function Client() {- const [{ step, callbackUrl }, setSearchParams] =- useQueryStates(searchParamsParsers);+ const [{ step, intent, callbackUrl }, setSearchParams] = useQueryStates(+ searchParamsParsers,+ { history: "push" },+ );const router = useRouter();+ const pathname = usePathname();const trpc = useTRPC();const queryClient = useQueryClient();const { data: workspace, refetch } = useQuery(@@ -102,7 +101,11 @@ export function Client() {const createMonitorMutation = useMutation(trpc.monitor.new.mutationOptions({onSuccess: async (data) => {- await setSearchParams({ step: "2" });+ if (intent === "both") {+ await setSearchParams({ step: "3" });+ } else {+ await setSearchParams({ step: "next" });+ }if (data.active) {triggerCheckMutation.mutate({ id: data.id });}@@ -113,58 +116,156 @@ export function Client() {},}),);- const createPageMutation = useMutation(- trpc.page.create.mutationOptions({- onSuccess: async () => {- await setSearchParams({ step: "next" });- refetch();- queryClient.invalidateQueries({- queryKey: trpc.page.list.queryKey(),- });- },- }),+ const createPageMutation = useMutation(trpc.page.create.mutationOptions({}));+ const updateComponentsMutation = useMutation(+ trpc.pageComponent.updateOrder.mutationOptions({}),);const createFeedbackMutation = useMutation(trpc.feedback.submit.mutationOptions({}),);+ const totalSteps = getTotalSteps(intent);+ const currentStepNumber = getCurrentStepNumber(step, intent);++ const nudgeCards = useMemo(() => {+ const cards = [+ {+ id: "upgrade",+ title: "Upgrade your plan",+ description:+ "Unlock more monitors, status pages, and advanced features.",+ href: "/settings/billing",+ },+ {+ id: "invite",+ title: "Invite your team",+ description:+ "Collaborate with your team by inviting them to your workspace.",+ href: "/settings/general",+ },+ ];++ if (intent === "monitoring") {+ cards.push({+ id: "status-page",+ title: "Create a status page",+ description:+ "Keep your users informed with a public page showing your system health.",+ href: "/status-pages",+ });+ }++ if (intent === "status-page") {+ cards.push({+ id: "monitor",+ title: "Create a monitor",+ description:+ "Start tracking uptime and performance of your websites and APIs.",+ href: "/monitors",+ });+ }++ cards.push({+ id: "notifier",+ title: "Create a notifier",+ description: "Get notified when your website or API is down.",+ href: "/notifications",+ });++ return cards;+ }, [intent]);+useEffect(() => {if (!callbackUrl) return;- // Validate and normalize the callbackUrl to prevent XSS via javascript: or other dangerous schemestry {const url = new URL(callbackUrl, window.location.origin);if (url.pathname === "/" || url.pathname === "") return;if (url.origin !== window.location.origin) return;if (url.protocol !== "http:" && url.protocol !== "https:") return;- // Navigate using the parsed URL to avoid raw-input parsing discrepanciesrouter.push(`${url.pathname}${url.search}${url.hash}`);} catch {// Malformed URLs are not safe to navigate to}}, [callbackUrl, router]);+ const showMonitorForm =+ (step === "2" && intent === "monitoring") ||+ (step === "2" && intent === "both");++ const showStatusPageForm =+ (step === "2" && intent === "status-page") ||+ (step === "3" && intent === "both");+return (<SectionGroup><Section><SectionHeader><SectionTitle>Getting Started</SectionTitle><SectionDescription>- Welcome to OpenStatus. Let's get you set up.+ Welcome to openstatus. Let's get you set up.</SectionDescription></SectionHeader></Section>{step === "1" && (+ <Section>+ <SectionHeader>+ <SectionDescription>What are you looking for?</SectionDescription>+ </SectionHeader>+ <ActionCardGroup className="grid-cols-1 sm:grid-cols-2">+ {intents.map((item) => {+ const Icon = item.icon;+ return (+ <button+ key={item.id}+ type="button"+ className={+ item.id === "both" ? "text-left sm:col-span-2" : "text-left"+ }+ onClick={async () => {+ setSearchParams({ step: "2", intent: item.id });+ await createFeedbackMutation.mutateAsync({+ message: `I'm looking for *${item.title}*`,+ path: pathname,+ });+ }}+ >+ <ActionCard className="h-full w-full cursor-pointer transition-colors hover:border-foreground/20">+ <ActionCardHeader>+ <ActionCardTitle className="flex items-center gap-2">+ <Icon className="size-4 shrink-0 text-muted-foreground" />+ {item.title}+ </ActionCardTitle>+ <ActionCardDescription>+ {item.description}+ </ActionCardDescription>+ </ActionCardHeader>+ </ActionCard>+ </button>+ );+ })}+ </ActionCardGroup>+ </Section>+ )}+ {showMonitorForm && (<Section><SectionHeader className="h-8 flex-row items-center justify-between"><SectionDescription className="tabular-nums">- Step <span className="font-medium text-foreground">1</span> of{" "}- <span className="font-medium text-foreground">2</span>+ Step{" "}+ <span className="font-medium text-foreground">+ {currentStepNumber}+ </span>{" "}+ of{" "}+ <span className="font-medium text-foreground">{totalSteps}</span></SectionDescription><Buttonvariant="ghost"size="sm"className="text-muted-foreground"- onClick={() => setSearchParams({ step: "2" })}+ onClick={() =>+ setSearchParams({+ step: intent === "both" ? "3" : "next",+ })+ }>Skip</Button>@@ -198,12 +299,16 @@ export function Client() {</FormCard></Section>)}- {step === "2" && (+ {showStatusPageForm && (<Section><SectionHeader className="h-8 flex-row items-center justify-between"><SectionDescription className="tabular-nums">- Step <span className="font-medium text-foreground">2</span> of{" "}- <span className="font-medium text-foreground">2</span>+ Step{" "}+ <span className="font-medium text-foreground">+ {currentStepNumber}+ </span>{" "}+ of{" "}+ <span className="font-medium text-foreground">{totalSteps}</span></SectionDescription><Buttonvariant="ghost"@@ -216,30 +321,63 @@ export function Client() {</SectionHeader><FormCard><FormCardHeader>- <FormCardTitle>Create a page</FormCardTitle>+ <FormCardTitle>Create a status page</FormCardTitle><FormCardDescription>- Inform your users about the status of your website or API.+ Inform your users about the status of your services.</FormCardDescription></FormCardHeader><FormCardContent><CreatePageFormid="create-page-form"+ showComponents={intent === "status-page"}defaultValues={{slug: extractDomain(createMonitorMutation.data?.url ?? ""),}}onSubmit={async (values) => {if (!workspace?.id) return;- await createPageMutation.mutateAsync({+ const newPage = await createPageMutation.mutateAsync({slug: values.slug,title: values.slug.replace(/-/g, " "),description: "",monitors: createMonitorMutation.data?.id- ? [{ monitorId: createMonitorMutation.data.id, order: 0 }]+ ? [+ {+ monitorId: createMonitorMutation.data.id,+ order: 0,+ },+ ]: [],workspaceId: workspace.id,legacyPage: false,});++ // Create static components if any were added+ const staticComponents = values.components?.filter(+ (c) => c.name.trim() !== "",+ );+ if (staticComponents?.length && newPage?.id) {+ const monitorComponentOffset = createMonitorMutation.data+ ?.id+ ? 1+ : 0;+ await updateComponentsMutation.mutateAsync({+ pageId: newPage.id,+ components: staticComponents.map((c, index) => ({+ name: c.name,+ type: "static" as const,+ monitorId: null,+ order: index + monitorComponentOffset,+ })),+ groups: [],+ });+ }++ await setSearchParams({ step: "next" });+ refetch();+ queryClient.invalidateQueries({+ queryKey: trpc.page.list.queryKey(),+ });}}/></FormCardContent>@@ -254,16 +392,16 @@ export function Client() {<Section><SectionHeader className="h-8 flex-row items-center justify-between"><SectionDescription>- We'd love to know what you are looking for with openstatus.- This will help us improve our product and services.+ How did you hear about openstatus?</SectionDescription></SectionHeader>- <LearnFromForm+ <QuestionFormonSubmit={async (values) => {await createFeedbackMutation.mutateAsync({- message: `I want to use OpenStatus for *${values.from}${- values.other ? `: ${values.other || "others"}` : ""+ message: `Heard about us via *${values.source}${+ values.other ? `: ${values.other}` : ""}*`,+ path: pathname,});}}/>@@ -275,21 +413,18 @@ export function Client() {</SectionDescription></SectionHeader><ActionCardGroup className="sm:grid-cols-2">- {moreActions.map((action) => {+ {nudgeCards.map((action) => {const isExternal = action.href.startsWith("http");- const isMonitor = action.id === "monitor";- const href =- isMonitor && createMonitorMutation.data?.id- ? `${action.href}/${createMonitorMutation.data.id}`- : action.href;+ const className =+ action.id === "upgrade" ? "bg-muted" : undefined;return (<Linkkey={action.id}- href={href}+ href={action.href}target={isExternal ? "_blank" : undefined}rel={isExternal ? "noopener noreferrer" : undefined}>- <ActionCard className="h-full w-full">+ <ActionCard className={cn("h-full w-full", className)}><ActionCardHeader><ActionCardTitle className="flex items-center justify-between gap-2">{action.title}diff --git a/apps/dashboard/src/app/(dashboard)/onboarding/search-params.ts b/apps/dashboard/src/app/(dashboard)/onboarding/search-params.tsindex 376e2c708..292f40462 100644--- a/apps/dashboard/src/app/(dashboard)/onboarding/search-params.ts+++ b/apps/dashboard/src/app/(dashboard)/onboarding/search-params.ts@@ -4,10 +4,14 @@ import {parseAsStringLiteral,} from "nuqs/server";-const STEPS = ["1", "2", "next"] as const;+const STEPS = ["1", "2", "3", "next"] as const;+const INTENTS = ["monitoring", "status-page", "both"] as const;++export type Intent = (typeof INTENTS)[number];export const searchParamsParsers = {step: parseAsStringLiteral(STEPS).withDefault("1"),+ intent: parseAsStringLiteral(INTENTS),callbackUrl: parseAsString,};diff --git a/apps/dashboard/src/components/forms/onboarding/create-page.tsx b/apps/dashboard/src/components/forms/onboarding/create-page.tsxindex f891a3afd..edfd85060 100644--- a/apps/dashboard/src/components/forms/onboarding/create-page.tsx+++ b/apps/dashboard/src/components/forms/onboarding/create-page.tsx@@ -4,6 +4,7 @@import { InputWithAddons } from "@/components/common/input-with-addons";import { useTRPC } from "@/lib/trpc/client";import { zodResolver } from "@hookform/resolvers/zod";+import { Button } from "@openstatus/ui/components/ui/button";import {Form,FormControl,@@ -13,11 +14,13 @@ import {FormLabel,FormMessage,} from "@openstatus/ui/components/ui/form";+import { Input } from "@openstatus/ui/components/ui/input";import { useDebounce } from "@openstatus/ui/hooks/use-debounce";import { useQuery } from "@tanstack/react-query";import { isTRPCClientError } from "@trpc/client";+import { Plus, X } from "lucide-react";import { useEffect, useTransition } from "react";-import { useForm } from "react-hook-form";+import { useFieldArray, useForm } from "react-hook-form";import { toast } from "sonner";import { z } from "zod";@@ -26,6 +29,13 @@ const SLUG_UNIQUE_ERROR_MESSAGE =const schema = z.object({slug: z.string().min(3),+ components: z+ .array(+ z.object({+ name: z.string().min(1, "Component name is required"),+ }),+ )+ .optional(),});export type FormValues = z.infer<typeof schema>;@@ -33,15 +43,21 @@ export type FormValues = z.infer<typeof schema>;export function CreatePageForm({defaultValues,onSubmit,+ showComponents = false,...props}: Omit<React.ComponentProps<"form">, "onSubmit"> & {- defaultValues?: FormValues;+ defaultValues?: Partial<FormValues>;onSubmit: (values: FormValues) => Promise<void>;+ showComponents?: boolean;}) {const trpc = useTRPC();- const form = useForm({+ const form = useForm<FormValues>({resolver: zodResolver(schema),- defaultValues: defaultValues ?? { slug: "" },+ defaultValues: {+ slug: "",+ components: showComponents ? [{ name: "Website" }] : undefined,+ ...defaultValues,+ },});const [isPending, startTransition] = useTransition();const watchSlug = form.watch("slug");@@ -53,6 +69,11 @@ export function CreatePageForm({),);+ const { fields, append, remove } = useFieldArray({+ control: form.control,+ name: "components",+ });+useEffect(() => {if (isUnique === false) {form.setError("slug", { message: SLUG_UNIQUE_ERROR_MESSAGE });@@ -93,7 +114,11 @@ export function CreatePageForm({return (<Form {...form}>- <form onSubmit={form.handleSubmit(submitAction)} {...props}>+ <form+ onSubmit={form.handleSubmit(submitAction)}+ className="space-y-4"+ {...props}+ ><FormFieldcontrol={form.control}name="slug"@@ -115,6 +140,56 @@ export function CreatePageForm({</FormItem>)}/>+ {showComponents && (+ <div className="space-y-3">+ <FormLabel>Components</FormLabel>+ <FormDescription>+ Add the services your users care about. You can attach monitors+ later.+ </FormDescription>+ <div className="space-y-2">+ {fields.map((field, index) => (+ <FormField+ key={field.id}+ control={form.control}+ name={`components.${index}.name`}+ render={({ field }) => (+ <FormItem>+ <div className="flex items-center gap-2">+ <FormControl>+ <Input placeholder="e.g. API, Dashboard" {...field} />+ </FormControl>+ {fields.length > 1 && (+ <Button+ type="button"+ variant="ghost"+ size="icon"+ className="shrink-0"+ onClick={() => remove(index)}+ >+ <X className="size-4" />+ </Button>+ )}+ </div>+ <FormMessage />+ </FormItem>+ )}+ />+ ))}+ </div>+ {fields.length < 3 && (+ <Button+ type="button"+ variant="outline"+ size="sm"+ onClick={() => append({ name: "" })}+ >+ <Plus className="mr-1 size-4" />+ Add another+ </Button>+ )}+ </div>+ )}</form></Form>);diff --git a/apps/dashboard/src/components/forms/onboarding/learn-from.tsx b/apps/dashboard/src/components/forms/onboarding/question.tsxsimilarity index 86%rename from apps/dashboard/src/components/forms/onboarding/learn-from.tsxrename to apps/dashboard/src/components/forms/onboarding/question.tsxindex 60e1e93d7..b6c5c65e6 100644--- a/apps/dashboard/src/components/forms/onboarding/learn-from.tsx+++ b/apps/dashboard/src/components/forms/onboarding/question.tsx@@ -23,18 +23,26 @@ import { useForm } from "react-hook-form";import { toast } from "sonner";import { z } from "zod";-const wantFrom = [+const sources = [{- id: "statuspage",- title: "Status Page",+ id: "social-media",+ title: "Twitter / LinkedIn / Bsky",},{- id: "uptime-monitoring",- title: "Uptime Monitoring",+ id: "github",+ title: "GitHub",},{- id: "both",- title: "Both",+ id: "google",+ title: "Google Search",+ },+ {+ id: "recommendation",+ title: "Friend / Colleague",+ },+ {+ id: "blog",+ title: "Blog / Article",},{id: "other",@@ -43,13 +51,13 @@ const wantFrom = [] as const;const schema = z.object({- from: z.string(),+ source: z.string().min(1, "Please select an option"),other: z.string().optional(),});export type FormValues = z.infer<typeof schema>;-export function LearnFromForm({+export function QuestionForm({onSubmit,defaultValues,className,@@ -62,11 +70,11 @@ export function LearnFromForm({const form = useForm<FormValues>({resolver: zodResolver(schema),defaultValues: defaultValues ?? {- from: "",+ source: "",other: "",},});- const watchFrom = form.watch("from");+ const watchSource = form.watch("source");function handleSubmit(values: FormValues) {if (isPending) return;@@ -104,7 +112,7 @@ export function LearnFromForm({><FormFieldcontrol={form.control}- name="from"+ name="source"render={({ field }) => (<FormItem><FormControl>@@ -113,7 +121,7 @@ export function LearnFromForm({defaultValue={field.value}className="grid grid-cols-1 gap-4 sm:grid-cols-2">- {wantFrom.map((item) => (+ {sources.map((item) => (<FormItem key={item.id} className="flex items-center gap-3"><FormControl><RadioGroupItem value={item.id} id={item.id} />@@ -132,7 +140,7 @@ export function LearnFromForm({</FormItem>)}/>- {watchFrom === "other" && (+ {watchSource === "other" && (<FormFieldcontrol={form.control}name="other"diff --git a/packages/api/src/router/feedback.ts b/packages/api/src/router/feedback.tsindex 3d2e2bd84..55b75c23f 100644--- a/packages/api/src/router/feedback.ts+++ b/packages/api/src/router/feedback.ts@@ -26,6 +26,11 @@ export const feedbackRouter = createTRPCRouter({});}+ if (process.env.NODE_ENV === "development") {+ console.log("feedback.submit", opts.input);+ return { success: true } as const;+ }+const textLines: string[] = [];if (opts.input.name) textLines.push(`*Name:* ${opts.input.name}`);if (opts.input.email) textLines.push(`*Email:* ${opts.input.email}`);