Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
fix(dashboard): custom domain configuration (#1433)
Maximilian Kaskec145c32a6583
diff --git a/apps/dashboard/src/components/domains/domain-configuration.tsx b/apps/dashboard/src/components/domains/domain-configuration.tsxindex 385b5d314..4832dd3f2 100644--- a/apps/dashboard/src/components/domains/domain-configuration.tsx+++ b/apps/dashboard/src/components/domains/domain-configuration.tsx@@ -1,5 +1,6 @@"use client";+import { Badge } from "@/components/ui/badge";import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs";import { cn } from "@/lib/utils";@@ -30,7 +31,7 @@ export const InlineSnippet = ({// FIXME: add loading state!export default function DomainConfiguration({ domain }: { domain: string }) {- const { status, domainJson } = useDomainStatus(domain);+ const { status, domainJson, isLoading } = useDomainStatus(domain);if (!status || !domainJson) return null;@@ -55,8 +56,9 @@ export default function DomainConfiguration({ domain }: { domain: string }) {return (<div><div className="mb-4 flex items-center space-x-2">- <DomainStatusIcon status={status} />+ <DomainStatusIcon status={status} loading={isLoading} /><p className="font-semibold">{status}</p>+ <Badge variant="secondary">{domain}</Badge></div>{txtVerification ? (<>@@ -107,57 +109,48 @@ export default function DomainConfiguration({ domain }: { domain: string }) {CNAME Record{subdomain && " (recommended)"}</TabsTrigger></TabsList>- <TabsContent value="A">- <div className="my-3 text-left">- <p className="my-5 text-sm">- To configure your apex domain (- <InlineSnippet>{domainJson.apexName}</InlineSnippet>- ), set the following A record on your DNS provider to- continue:- </p>- <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">- <div>- <p className="font-bold text-sm">Type</p>- <p className="mt-2 font-mono text-sm">A</p>- </div>- <div>- <p className="font-bold text-sm">Name</p>- <p className="mt-2 font-mono text-sm">@</p>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">76.76.21.21</p>- </div>- <div>- <p className="font-bold text-sm">TTL</p>- <p className="mt-2 font-mono text-sm">86400</p>- </div>+ <TabsContent value="A" className="space-y-2">+ <p className="text-sm">+ To configure your apex domain (+ <InlineSnippet>{domainJson.apexName}</InlineSnippet>+ ), set the following A record on your DNS provider to continue:+ </p>+ <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">+ <div>+ <p className="font-bold text-sm">Type</p>+ <p className="mt-2 font-mono text-sm">A</p>+ </div>+ <div>+ <p className="font-bold text-sm">Name</p>+ <p className="mt-2 font-mono text-sm">@</p>+ </div>+ <div>+ <p className="font-bold text-sm">Value</p>+ <p className="mt-2 font-mono text-sm">76.76.21.21</p>+ </div>+ <div>+ <p className="font-bold text-sm">TTL</p>+ <p className="mt-2 font-mono text-sm">86400</p></div></div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">cname.vercel-dns.com</p>- <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">- <div>- <p className="font-bold text-sm">Type</p>- <p className="mt-2 font-mono text-sm">CNAME</p>- </div>- <div>- <p className="font-bold text-sm">Name</p>- <p className="mt-2 font-mono text-sm">- {subdomain ?? "www"}- </p>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">- {"cname.vercel-dns.com"}- </p>- </div>- <div>- <p className="font-bold text-sm">TTL</p>- <p className="mt-2 font-mono text-sm">86400</p>- </div>+ </TabsContent>+ <TabsContent value="CNAME">+ <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">+ <div>+ <p className="font-bold text-sm">Type</p>+ <p className="mt-2 font-mono text-sm">CNAME</p>+ </div>+ <div>+ <p className="font-bold text-sm">Name</p>+ <p className="mt-2 font-mono text-sm">{subdomain ?? "www"}</p>+ </div>+ <div>+ <p className="font-bold text-sm">Value</p>+ <p className="mt-2 font-mono text-sm">cname.vercel-dns.com</p>+ </div>+ <div>+ <p className="font-bold text-sm">TTL</p>+ <p className="mt-2 font-mono text-sm">86400</p></div></div></TabsContent>diff --git a/apps/dashboard/src/components/domains/domain-status-icon.tsx b/apps/dashboard/src/components/domains/domain-status-icon.tsxindex 3de439ca5..b1444729f 100644--- a/apps/dashboard/src/components/domains/domain-status-icon.tsx+++ b/apps/dashboard/src/components/domains/domain-status-icon.tsx@@ -12,7 +12,10 @@ export default function DomainStatusIcon({loading?: boolean;}) {return loading ? (- <LoaderCircle className="text-background" stroke="currentColor" />+ <LoaderCircle+ className="animate-spin text-muted-foreground"+ stroke="currentColor"+ />) : status === "Valid Configuration" ? (<CheckCircle2fill="#22c55e"diff --git a/apps/dashboard/src/components/domains/use-domain-status.ts b/apps/dashboard/src/components/domains/use-domain-status.tsindex a5dc9a741..120dc1c75 100644--- a/apps/dashboard/src/components/domains/use-domain-status.ts+++ b/apps/dashboard/src/components/domains/use-domain-status.ts@@ -2,31 +2,38 @@ import type { DomainVerificationStatusProps } from "@openstatus/api/src/router/dimport { useTRPC } from "@/lib/trpc/client";import { useQuery } from "@tanstack/react-query";-import { useEffect } from "react";+import { useCallback } from "react";-export function useDomainStatus(domain: string) {+export function useDomainStatus(domain?: string) {const trpc = useTRPC();- const { data: domainJson, refetch: refetchDomain } = useQuery(- trpc.domain.getDomainResponse.queryOptions({ domain }),- );- const { data: configJson, refetch: refetchConfig } = useQuery(- trpc.domain.getConfigResponse.queryOptions({ domain }),- );- const { data: verificationJson, refetch: refetchVerification } = useQuery(+ const {+ data: domainJson,+ refetch: refetchDomain,+ isLoading: isLoadingDomain,+ isRefetching: isRefetchingDomain,+ } = useQuery(trpc.domain.getDomainResponse.queryOptions({ domain }));+ const {+ data: configJson,+ refetch: refetchConfig,+ isLoading: isLoadingConfig,+ isRefetching: isRefetchingConfig,+ } = useQuery(trpc.domain.getConfigResponse.queryOptions({ domain }));+ const {+ data: verificationJson,+ refetch: refetchVerification,+ isLoading: isLoadingVerification,+ isRefetching: isRefetchingVerification,+ } = useQuery(trpc.domain.verifyDomain.queryOptions({ domain },{ enabled: !domainJson?.verified },),);- // NOTE: refetch every 5 seconds to check for the status- useEffect(() => {- const interval = setInterval(() => {- refetchDomain();- refetchConfig();- refetchVerification();- }, 5000);- return () => clearInterval(interval);+ const refreshAll = useCallback(() => {+ refetchDomain();+ refetchConfig();+ refetchVerification();}, [refetchDomain, refetchConfig, refetchVerification]);let status: DomainVerificationStatusProps = "Valid Configuration";@@ -52,8 +59,17 @@ export function useDomainStatus(domain: string) {} else {status = "Valid Configuration";}+return {status,domainJson,+ refresh: refreshAll,+ isLoading:+ isLoadingDomain ||+ isLoadingConfig ||+ isLoadingVerification ||+ isRefetchingDomain ||+ isRefetchingConfig ||+ isRefetchingVerification,};}diff --git a/apps/dashboard/src/components/forms/status-page/form-custom-domain.tsx b/apps/dashboard/src/components/forms/status-page/form-custom-domain.tsxindex d812b22dc..431d679e8 100644--- a/apps/dashboard/src/components/forms/status-page/form-custom-domain.tsx+++ b/apps/dashboard/src/components/forms/status-page/form-custom-domain.tsx@@ -23,10 +23,11 @@ import { z } from "zod";import { Link } from "@/components/common/link";import DomainConfiguration from "@/components/domains/domain-configuration";+import { useDomainStatus } from "@/components/domains/use-domain-status";import { Form, FormField, FormItem, FormMessage } from "@/components/ui/form";import { isTRPCClientError } from "@trpc/client";import type React from "react";-import { useTransition } from "react";+import { useEffect, useTransition } from "react";import { toast } from "sonner";const schema = z.object({@@ -52,6 +53,7 @@ export function FormCustomDomain({},});const [isPending, startTransition] = useTransition();+ const { refresh, isLoading } = useDomainStatus(defaultValues?.domain);function submitAction(values: FormValues) {if (isPending) return;@@ -76,6 +78,12 @@ export function FormCustomDomain({});}+ // NOTE: poll every 30 seconds to check for the status+ useEffect(() => {+ const interval = setInterval(() => refresh(), 30_000);+ return () => clearInterval(interval);+ }, [refresh]);+return (<Form {...form}><form onSubmit={form.handleSubmit(submitAction)} {...props}>@@ -133,9 +141,20 @@ export function FormCustomDomain({</Link></Button>) : (- <Button type="submit" disabled={isPending}>- {isPending ? "Submitting..." : "Submit"}- </Button>+ <div className="flex items-center gap-2">+ <Button+ type="button"+ variant="ghost"+ disabled={isPending || isLoading}+ onClick={refresh}+ className="hidden sm:block"+ >+ {isLoading ? "Refreshing..." : "Refresh Configuration"}+ </Button>+ <Button type="submit" disabled={isPending}>+ {isPending ? "Submitting..." : "Submit"}+ </Button>+ </div>)}</FormCardFooter></FormCard>diff --git a/apps/web/src/components/domains/domain-configuration.tsx b/apps/web/src/components/domains/domain-configuration.tsxdeleted file mode 100644index b69020227..000000000--- a/apps/web/src/components/domains/domain-configuration.tsx+++ /dev/null@@ -1,163 +0,0 @@-"use client";--import { Tabs, TabsContent, TabsList, TabsTrigger } from "@openstatus/ui";--import { useDomainStatus } from "@/hooks/use-domain-status";-import { getSubdomain } from "@/lib/domains";-import { cn } from "@/lib/utils";-import DomainStatusIcon from "./domain-status-icon";--export const InlineSnippet = ({- className,- children,-}: {- className?: string;- children?: string;-}) => {- return (- <span- className={cn(- "inline-block rounded-md bg-muted px-1 py-0.5 font-mono",- className,- )}- >- {children}- </span>- );-};-export default function DomainConfiguration({ domain }: { domain: string }) {- const domainStatus = useDomainStatus(domain);- const { status, domainJson } = domainStatus || {};-- if (!status || status === "Valid Configuration" || !domainJson) return null;-- const subdomain =- domainJson?.name && domainJson?.apexName- ? getSubdomain(domainJson.name, domainJson.apexName)- : null;-- const txtVerification =- (status === "Pending Verification" &&- domainJson?.verification?.find((x) => x.type === "TXT")) ||- null;-- return (- <div>- <div className="mb-4 flex items-center space-x-2">- <DomainStatusIcon status={status} />- <p className="font-semibold text-lg">{status}</p>- </div>- {txtVerification ? (- <>- <p className="text-sm">- Please set the following TXT record on{" "}- <InlineSnippet>{domainJson.apexName}</InlineSnippet> to prove- ownership of <InlineSnippet>{domainJson.name}</InlineSnippet>:- </p>- <div className="my-5 flex items-start justify-start space-x-10 rounded-md bg-muted p-2">- <div>- <p className="font-bold text-sm">Type</p>- <p className="mt-2 font-mono text-sm">{txtVerification.type}</p>- </div>- <div>- <p className="font-bold text-sm">Name</p>- <p className="mt-2 font-mono text-sm">- {txtVerification.domain.slice(- 0,- txtVerification.domain.length -- (domainJson?.apexName?.length || 0) -- 1,- )}- </p>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">- <span className="text-ellipsis">{txtVerification.value}</span>- </p>- </div>- </div>- <p className="text-muted-foreground text-sm">- Warning: if you are using this domain for another site, setting this- TXT record will transfer domain ownership away from that site and- break it. Please exercise caution when setting this record.- </p>- </>- ) : status === "Unknown Error" ? (- <p className="mb-5 text-sm">{domainJson?.error?.message}</p>- ) : (- <>- <Tabs defaultValue={subdomain ? "CNAME" : "A"}>- <TabsList>- <TabsTrigger value="A">- A Record{!subdomain && " (recommended)"}- </TabsTrigger>- <TabsTrigger value="CNAME">- CNAME Record{subdomain && " (recommended)"}- </TabsTrigger>- </TabsList>- <TabsContent value="A">- <div className="my-3 text-left">- <p className="my-5 text-sm">- To configure your apex domain (- <InlineSnippet>{domainJson.apexName}</InlineSnippet>- ), set the following A record on your DNS provider to- continue:- </p>- <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">- <div>- <p className="font-bold text-sm">Type</p>- <p className="mt-2 font-mono text-sm">A</p>- </div>- <div>- <p className="font-bold text-sm">Name</p>- <p className="mt-2 font-mono text-sm">@</p>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">76.76.21.21</p>- </div>- <div>- <p className="font-bold text-sm">TTL</p>- <p className="mt-2 font-mono text-sm">86400</p>- </div>- </div>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">cname.vercel-dns.com</p>- <div className="flex items-center justify-start space-x-10 rounded-md bg-muted p-2">- <div>- <p className="font-bold text-sm">Type</p>- <p className="mt-2 font-mono text-sm">CNAME</p>- </div>- <div>- <p className="font-bold text-sm">Name</p>- <p className="mt-2 font-mono text-sm">- {subdomain ?? "www"}- </p>- </div>- <div>- <p className="font-bold text-sm">Value</p>- <p className="mt-2 font-mono text-sm">- {"cname.vercel-dns.com"}- </p>- </div>- <div>- <p className="font-bold text-sm">TTL</p>- <p className="mt-2 font-mono text-sm">86400</p>- </div>- </div>- </div>- </TabsContent>- </Tabs>- <p className="muted-foreground mt-5 text-sm">- Note: for TTL, if <InlineSnippet>86400</InlineSnippet> is not- available, set the highest value possible. Also, domain propagation- can take up to an hour.- </p>- </>- )}- </div>- );-}diff --git a/apps/web/src/components/domains/domain-status-icon.tsx b/apps/web/src/components/domains/domain-status-icon.tsxdeleted file mode 100644index 6d180f73c..000000000--- a/apps/web/src/components/domains/domain-status-icon.tsx+++ /dev/null@@ -1,33 +0,0 @@-"use client";--import { AlertCircle, CheckCircle2, XCircle } from "lucide-react";--import type { DomainVerificationStatusProps } from "@openstatus/api/src/router/domain";--import { LoadingAnimation } from "../loading-animation";--export default function DomainStatusIcon({- status,- loading,-}: {- status: DomainVerificationStatusProps;- loading?: boolean;-}) {- return loading ? (- <LoadingAnimation />- ) : status === "Valid Configuration" ? (- <CheckCircle2- fill="#22c55e"- stroke="currentColor"- className="text-background"- />- ) : status === "Pending Verification" ? (- <AlertCircle- fill="#eab308"- stroke="currentColor"- className="text-background"- />- ) : (- <XCircle fill="#ef4444" stroke="currentColor" className="text-background" />- );-}diff --git a/apps/web/src/components/forms/custom-domain-form.tsx b/apps/web/src/components/forms/custom-domain-form.tsxdeleted file mode 100644index fd7e8d3ca..000000000--- a/apps/web/src/components/forms/custom-domain-form.tsx+++ /dev/null@@ -1,135 +0,0 @@-"use client";--import { zodResolver } from "@hookform/resolvers/zod";-import { useRouter } from "next/navigation";-import { useTransition } from "react";-import { useForm } from "react-hook-form";-import type * as z from "zod";--import { selectPageSchema } from "@openstatus/db/src/schema";-import {- Button,- Form,- FormControl,- FormDescription,- FormField,- FormItem,- FormLabel,- FormMessage,- InputWithAddons,-} from "@openstatus/ui";--import { useDomainStatus } from "@/hooks/use-domain-status";-import { toast, toastAction } from "@/lib/toast";-import { api } from "@/trpc/client";-import DomainConfiguration from "../domains/domain-configuration";-import DomainStatusIcon from "../domains/domain-status-icon";-import { LoadingAnimation } from "../loading-animation";--const customDomain = selectPageSchema.pick({- customDomain: true,- id: true,-});--type Schema = z.infer<typeof customDomain>;--// TODO: check--export function CustomDomainForm({ defaultValues }: { defaultValues: Schema }) {- const form = useForm<Schema>({- resolver: zodResolver(customDomain),- defaultValues,- });- const router = useRouter();- const [isPending, startTransition] = useTransition();- const domainStatus = useDomainStatus(defaultValues?.customDomain);- const { status } = domainStatus || {};-- async function onSubmit(data: Schema) {- startTransition(async () => {- try {- if (data.customDomain.toLowerCase().includes("openstatus")) {- toast.error("Domain cannot contain 'openstatus'");- return;- }-- await api.page.addCustomDomain.mutate({- customDomain: data.customDomain,- pageId: defaultValues?.id,- });-- if (data.customDomain && !defaultValues.customDomain) {- await api.domain.addDomainToVercel.mutate({- domain: data.customDomain,- });- // if changed, remove old domain and add new one- } else if (- defaultValues.customDomain &&- data.customDomain !== defaultValues.customDomain- ) {- await api.domain.removeDomainFromVercelProject.mutate({- domain: defaultValues.customDomain,- });- await api.domain.addDomainToVercel.mutate({- domain: data.customDomain,- });- // if removed- } else if (data.customDomain === "") {- await api.domain.removeDomainFromVercelProject.mutate({- domain: defaultValues.customDomain,- });- }- toastAction("saved");- router.refresh();- } catch {- toastAction("error");- }- });- }-- return (- <Form {...form}>- <form- onSubmit={form.handleSubmit(onSubmit)}- className="grid w-full grid-cols-1 items-center gap-6 sm:grid-cols-6"- >- <FormField- control={form.control}- name="customDomain"- render={({ field }) => (- <FormItem className="sm:col-span-4">- <FormLabel>Custom Domain</FormLabel>- <FormControl>- <div className="flex items-center space-x-3">- <InputWithAddons- placeholder="status.documenso.com"- leading="https://"- {...field}- />- <div className="h-full w-7">- {/* TODO: add loading state */}- {status ? <DomainStatusIcon status={status} /> : null}- </div>- </div>- </FormControl>- <FormDescription>- The custom domain for your status page.- </FormDescription>- <FormMessage />- </FormItem>- )}- />- <div className="sm:col-span-full">- <Button className="w-full sm:w-auto" size="lg">- {!isPending ? "Confirm" : <LoadingAnimation />}- </Button>- </div>- <div className="sm:col-span-5">- {defaultValues?.customDomain ? (- <DomainConfiguration domain={defaultValues.customDomain} />- ) : null}- </div>- </form>- </Form>- );-}diff --git a/apps/web/src/hooks/use-domain-status.ts b/apps/web/src/hooks/use-domain-status.tsdeleted file mode 100644index 899de22d7..000000000--- a/apps/web/src/hooks/use-domain-status.ts+++ /dev/null@@ -1,62 +0,0 @@-import { useEffect, useState } from "react";--import type {- DomainResponse,- DomainVerificationStatusProps,-} from "@openstatus/api/src/router/domain";--import { api } from "@/trpc/client";--export function useDomainStatus(domain: string) {- const [domainVerification, setDomainVerification] = useState<{- status: DomainVerificationStatusProps;- domainJson: DomainResponse & { error?: { code: string; message: string } };- }>();-- useEffect(() => {- async function checkDomain() {- const data = await verifyDomain(domain);- setDomainVerification(data);- }- checkDomain(); // first render!- setInterval(checkDomain, 5000);- // clearInterval(myInterval)- }, [domain]);-- return domainVerification;-}--export async function verifyDomain(domain: string) {- let status: DomainVerificationStatusProps = "Valid Configuration";- const [domainJson, configJson] = await Promise.all([- api.domain.getDomainResponse.query({ domain }),- api.domain.getConfigResponse.query({ domain }),- ]);-- if (domainJson?.error?.code === "not_found") {- // domain not found on Vercel project- status = "Domain Not Found";-- // unknown error- } else if (domainJson.error) {- status = "Unknown Error";-- // if domain is not verified, we try to verify now- } else if (!domainJson.verified) {- status = "Pending Verification";- const verificationJson = await api.domain.verifyDomain.query({ domain });-- // domain was just verified- if (verificationJson?.verified) {- status = "Valid Configuration";- }- } else if (configJson.misconfigured) {- status = "Invalid Configuration";- } else {- status = "Valid Configuration";- }- return {- status,- domainJson,- };-}diff --git a/packages/api/src/router/domain.ts b/packages/api/src/router/domain.tsindex e73a71d90..29c29acb5 100644--- a/packages/api/src/router/domain.ts+++ b/packages/api/src/router/domain.ts@@ -106,8 +106,11 @@ export const domainRouter = createTRPCRouter({// return await data.json();// }),getDomainResponse: protectedProcedure- .input(z.object({ domain: z.string() }))+ .input(z.object({ domain: z.string().optional() })).query(async (opts) => {+ if (!opts.input.domain) {+ return null;+ }const data = await fetch(`https://api.vercel.com/v9/projects/${env.PROJECT_ID_VERCEL}/domains/${opts.input.domain}?teamId=${env.TEAM_ID_VERCEL}`,{@@ -129,11 +132,15 @@ export const domainRouter = createTRPCRouter({.optional(),}).parse(json);+ console.log({ result });return result;}),getConfigResponse: protectedProcedure- .input(z.object({ domain: z.string() }))+ .input(z.object({ domain: z.string().optional() })).query(async (opts) => {+ if (!opts.input.domain) {+ return null;+ }const data = await fetch(`https://api.vercel.com/v6/domains/${opts.input.domain}/config?teamId=${env.TEAM_ID_VERCEL}`,{@@ -149,8 +156,11 @@ export const domainRouter = createTRPCRouter({return result;}),verifyDomain: protectedProcedure- .input(z.object({ domain: z.string() }))+ .input(z.object({ domain: z.string().optional() })).query(async (opts) => {+ if (!opts.input.domain) {+ return null;+ }const data = await fetch(`https://api.vercel.com/v9/projects/${env.PROJECT_ID_VERCEL}/domains/${opts.input.domain}/verify?teamId=${env.TEAM_ID_VERCEL}`,{