The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Parse domain JSON configs with clearer field-specific API errors
Kiran Kb6af8e2daa54
diff --git a/apps/web/app/api/domains/[domain]/route.ts b/apps/web/app/api/domains/[domain]/route.tsindex 434e0d4bbb..cac616f5b1 100644--- a/apps/web/app/api/domains/[domain]/route.ts+++ b/apps/web/app/api/domains/[domain]/route.ts@@ -1,6 +1,7 @@import { addDomainToVercel } from "@/lib/api/domains/add-domain-vercel";import { getDomainOrThrow } from "@/lib/api/domains/get-domain-or-throw";import { markDomainAsDeleted } from "@/lib/api/domains/mark-domain-deleted";+import { parseDomainJsonConfig } from "@/lib/api/domains/parse-domain-json-config";import { queueDomainUpdate } from "@/lib/api/domains/queue-domain-update";import { removeDomainFromVercel } from "@/lib/api/domains/remove-domain-vercel";import { transformDomain } from "@/lib/api/domains/transform-domain";@@ -12,10 +13,7 @@ import { withWorkspace } from "@/lib/auth";import { setRenewOption } from "@/lib/dynadot/set-renew-option";import { prisma } from "@/lib/prisma";import { storage } from "@/lib/storage";-import {- domainJsonConfigSchema,- updateDomainBodySchema,-} from "@/lib/zod/schemas/domains";+import { updateDomainBodySchema } from "@/lib/zod/schemas/domains";import { combineWords, nanoid, R2_URL } from "@dub/utils";import { Prisma } from "@prisma/client";import { waitUntil } from "@vercel/functions";@@ -24,7 +22,7 @@ import { NextResponse } from "next/server";import * as z from "zod/v4";const updateDomainBodySchemaExtended = updateDomainBodySchema.extend({- deepviewData: domainJsonConfigSchema,+ deepviewData: z.string().nullish(),autoRenew: z.boolean().nullish(),});@@ -150,15 +148,22 @@ export const PATCH = withWorkspace(notFoundUrl,logo: deleteLogo ? null : logoUploaded?.url || existingDomain.logo,...(assetLinks !== undefined && {- assetLinks: assetLinks ? JSON.parse(assetLinks) : Prisma.DbNull,+ assetLinks: assetLinks+ ? parseDomainJsonConfig(assetLinks, "assetLinks")+ : Prisma.DbNull,}),...(appleAppSiteAssociation !== undefined && {appleAppSiteAssociation: appleAppSiteAssociation- ? JSON.parse(appleAppSiteAssociation)+ ? parseDomainJsonConfig(+ appleAppSiteAssociation,+ "appleAppSiteAssociation",+ ): Prisma.DbNull,}),...(deepviewData !== undefined && {- deepviewData: deepviewData ? JSON.parse(deepviewData) : Prisma.DbNull,+ deepviewData: deepviewData+ ? parseDomainJsonConfig(deepviewData, "deepviewData")+ : Prisma.DbNull,}),},include: {diff --git a/apps/web/app/api/domains/route.ts b/apps/web/app/api/domains/route.tsindex 9587796feb..2d56d9925e 100644--- a/apps/web/app/api/domains/route.ts+++ b/apps/web/app/api/domains/route.ts@@ -1,5 +1,6 @@import { createId } from "@/lib/api/create-id";import { addDomainToVercel } from "@/lib/api/domains/add-domain-vercel";+import { parseDomainJsonConfig } from "@/lib/api/domains/parse-domain-json-config";import { transformDomain } from "@/lib/api/domains/transform-domain";import { validateDomain } from "@/lib/api/domains/utils";import { DubApiError } from "@/lib/api/errors";@@ -224,12 +225,17 @@ export const POST = withWorkspace(expiredUrl,notFoundUrl,...(logoUploaded && { logo: logoUploaded.url }),- ...(assetLinks && { assetLinks: JSON.parse(assetLinks) }),+ ...(assetLinks && {+ assetLinks: parseDomainJsonConfig(assetLinks, "assetLinks"),+ }),...(appleAppSiteAssociation && {- appleAppSiteAssociation: JSON.parse(appleAppSiteAssociation),+ appleAppSiteAssociation: parseDomainJsonConfig(+ appleAppSiteAssociation,+ "appleAppSiteAssociation",+ ),}),...(deepviewData && {- deepviewData: JSON.parse(deepviewData),+ deepviewData: parseDomainJsonConfig(deepviewData, "deepviewData"),}),},});diff --git a/apps/web/lib/api/domains/parse-domain-json-config.ts b/apps/web/lib/api/domains/parse-domain-json-config.tsnew file mode 100644index 0000000000..bd2a7a7637--- /dev/null+++ b/apps/web/lib/api/domains/parse-domain-json-config.ts@@ -0,0 +1,27 @@+import { DubApiError } from "@/lib/api/errors";++const DOMAIN_JSON_CONFIG_LABELS = {+ assetLinks: "Asset Links",+ appleAppSiteAssociation: "Apple App Site Association",+ deepviewData: "Deep View data",+} as const;++type DomainJsonConfigField = keyof typeof DOMAIN_JSON_CONFIG_LABELS;++export function parseDomainJsonConfig(+ value: string | null | undefined,+ field: DomainJsonConfigField,+) {+ if (value == null || value === "") {+ return value;+ }++ try {+ return JSON.parse(value);+ } catch {+ throw new DubApiError({+ code: "unprocessable_entity",+ message: `Invalid ${DOMAIN_JSON_CONFIG_LABELS[field]}`,+ });+ }+}diff --git a/apps/web/lib/zod/schemas/domains.ts b/apps/web/lib/zod/schemas/domains.tsindex 907cb56b0c..719eb28c05 100644--- a/apps/web/lib/zod/schemas/domains.ts+++ b/apps/web/lib/zod/schemas/domains.ts@@ -103,27 +103,6 @@ export const getDefaultDomainsQuerySchema = getDomainsQuerySchema.pick({search: true,});-export const domainJsonConfigSchema = z- .string()- .nullish()- .refine(- (val) => {- if (val == null || val === "") {- return true;- }-- try {- JSON.parse(val);- return true;- } catch {- return false;- }- },- {- error: "Invalid JSON",- },- );-export const createDomainBodySchema = z.object({slug: z.string({ error: "slug is required" })@@ -162,16 +141,22 @@ export const createDomainBodySchema = z.object({).meta({ example: "https://dub.co/help/article/dub-links" }),logo: uploadedImageSchema.nullish().describe("The logo of the domain."),- assetLinks: domainJsonConfigSchema.describe(- "assetLinks.json configuration file (for deep link support on Android).",- ),- appleAppSiteAssociation: domainJsonConfigSchema.describe(- "apple-app-site-association configuration file (for deep link support on iOS).",- ),+ assetLinks: z+ .string()+ .nullish()+ .describe(+ "assetLinks.json configuration file (for deep link support on Android).",+ ),+ appleAppSiteAssociation: z+ .string()+ .nullish()+ .describe(+ "apple-app-site-association configuration file (for deep link support on iOS).",+ ),});export const createDomainBodySchemaExtended = createDomainBodySchema.extend({- deepviewData: domainJsonConfigSchema,+ deepviewData: z.string().nullish(),isOnboardingSubdomainFlow: z.boolean().default(false),});diff --git a/apps/web/playwright/api/domains/domains.spec.ts b/apps/web/playwright/api/domains/domains.spec.tsindex d449703535..cd32e4c714 100644--- a/apps/web/playwright/api/domains/domains.spec.ts+++ b/apps/web/playwright/api/domains/domains.spec.ts@@ -66,18 +66,21 @@ type DomainCreateBody = ReturnType<typeof domainBody> & JsonConfigFields;const jsonFields = [{field: "assetLinks" as const,+ label: "Asset Links",valid: VALID_ASSET_LINKS,updated: UPDATED_ASSET_LINKS,emptyCreateExpected: null,},{field: "appleAppSiteAssociation" as const,+ label: "Apple App Site Association",valid: VALID_AASA,updated: UPDATED_AASA,emptyCreateExpected: null,},{field: "deepviewData" as const,+ label: "Deep View data",valid: VALID_DEEPVIEW,updated: UPDATED_DEEPVIEW,emptyCreateExpected: "{}",@@ -374,7 +377,13 @@ test("GET /domains/{slug} – not found", async ({ api }) => {});test.describe("JSON config fields", () => {- for (const { field, valid, updated, emptyCreateExpected } of jsonFields) {+ for (const {+ field,+ label,+ valid,+ updated,+ emptyCreateExpected,+ } of jsonFields) {test(`POST /domains – valid ${field}`, async ({ api }) => {let slug: string | undefined;@@ -486,7 +495,7 @@ test.describe("JSON config fields", () => {data: {error: {code: "unprocessable_entity",- message: `custom: ${field}: Invalid JSON`,+ message: `Invalid ${label}`,doc_url:"https://dub.co/docs/api-reference/errors#unprocessable-entity",},@@ -510,7 +519,7 @@ test.describe("JSON config fields", () => {data: {error: {code: "unprocessable_entity",- message: `custom: ${field}: Invalid JSON`,+ message: `Invalid ${label}`,doc_url:"https://dub.co/docs/api-reference/errors#unprocessable-entity",},