Skip to content

Open-source status page, incident response and uptime monitoring

feat: add form error if slug not unique (#77)

Maximilian Kaskeff48cd1f1d51
diff --git a/apps/web/src/components/forms/status-page-form.tsx b/apps/web/src/components/forms/status-page-form.tsx
index 3188ebd22..a5a5a2dd7 100644
--- a/apps/web/src/components/forms/status-page-form.tsx
+++ b/apps/web/src/components/forms/status-page-form.tsx
@@ -18,7 +18,10 @@ import {
FormMessage,
} from "@/components/ui/form";
import { Input } from "@/components/ui/input";
+import { useDebounce } from "@/hooks/use-debounce";
+import { api } from "@/trpc/client";
import { Checkbox } from "../ui/checkbox";
+import { useToast } from "../ui/use-toast";
// REMINDER: only use the props you need!
@@ -41,19 +44,54 @@ export function StatusPageForm({
resolver: zodResolver(insertPageSchemaWithMonitors),
defaultValues: {
title: defaultValues?.title || "",
- slug: defaultValues?.slug || "", // TODO: verify if is unique
+ slug: defaultValues?.slug || "",
description: defaultValues?.description || "",
monitors: [],
workspaceId: 0,
},
});
+ const watchSlug = form.watch("slug");
+ const debouncedSlug = useDebounce(watchSlug, 1000); // using debounce to not exhaust the server
+ const { toast } = useToast();
+
+ const checkUniqueSlug = React.useCallback(async () => {
+ const isUnique = await api.page.getSlugUniqueness.query({
+ slug: debouncedSlug,
+ });
+ return isUnique || debouncedSlug === defaultValues?.slug;
+ }, [debouncedSlug, defaultValues?.slug]);
+
+ React.useEffect(() => {
+ async function watchSlugChanges() {
+ const isUnique = await checkUniqueSlug();
+ if (!isUnique) {
+ form.setError("slug", {
+ message: "Already taken. Please select another slug.",
+ });
+ } else {
+ form.clearErrors("slug");
+ }
+ }
+ watchSlugChanges();
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [checkUniqueSlug]);
+
return (
<Form {...form}>
<form
- onSubmit={form.handleSubmit(onSubmit, (e) => {
- console.log(e);
- console.log(form.getValues());
- })}
+ onSubmit={async (e) => {
+ e.preventDefault();
+ const isUnique = await checkUniqueSlug();
+ if (!isUnique) {
+ // the user will already have the "error" message - we include a toast as well
+ toast({
+ title: "Slug is already taken.",
+ description: "Please select another slug. Every slug is unique.",
+ });
+ } else {
+ form.handleSubmit(onSubmit)(e);
+ }
+ }}
id={id}
>
<div className="grid w-full items-center space-y-6">
@@ -66,7 +104,7 @@ export function StatusPageForm({
<FormControl>
<Input placeholder="" {...field} />
</FormControl>
- <FormDescription>This is title of your page.</FormDescription>
+ <FormDescription>The title of your page.</FormDescription>
<FormMessage />
</FormItem>
)}
@@ -81,7 +119,7 @@ export function StatusPageForm({
<Input placeholder="" {...field} />
</FormControl>
<FormDescription>
- This is your url of your page.
+ The subdomain slug for your status page. At least 3 chars.
</FormDescription>
<FormMessage />
</FormItem>
diff --git a/apps/web/src/hooks/use-debounce.ts b/apps/web/src/hooks/use-debounce.ts
new file mode 100644
index 000000000..3a34896de
--- /dev/null
+++ b/apps/web/src/hooks/use-debounce.ts
@@ -0,0 +1,16 @@
+import * as React from "react";
+
+// consider using https://github.com/xnimorz/use-debounce
+export function useDebounce<T>(value: T, delay?: number): T {
+ const [debouncedValue, setDebouncedValue] = React.useState<T>(value);
+
+ React.useEffect(() => {
+ const timer = setTimeout(() => setDebouncedValue(value), delay ?? 500);
+
+ return () => {
+ clearTimeout(timer);
+ };
+ }, [value, delay]);
+
+ return debouncedValue;
+}
diff --git a/packages/api/src/router/page.ts b/packages/api/src/router/page.ts
index fa1eece33..730596895 100644
--- a/packages/api/src/router/page.ts
+++ b/packages/api/src/router/page.ts
@@ -96,4 +96,13 @@ export const pageRouter = createTRPCRouter({
return selectPageSchemaWithRelation.parse(result);
}),
+
+ getSlugUniqueness: protectedProcedure
+ .input(z.object({ slug: z.string() }))
+ .query(async (opts) => {
+ const result = await opts.ctx.db.query.page.findMany({
+ where: eq(page.slug, opts.input.slug),
+ });
+ return result?.length > 0 ? false : true;
+ }),
});
diff --git a/packages/db/src/schema/page.ts b/packages/db/src/schema/page.ts
index a945a1a54..c46998420 100644
--- a/packages/db/src/schema/page.ts
+++ b/packages/db/src/schema/page.ts
@@ -40,6 +40,7 @@ export const pageRelations = relations(page, ({ many, one }) => ({
// Schema for inserting a Page - can be used to validate API requests
export const insertPageSchema = createInsertSchema(page, {
customDomain: z.string().optional(),
+ slug: z.string().min(3), // minimum subdomain length
});
export const insertPageSchemaWithMonitors = insertPageSchema.extend({