Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Return plain messages for single custom Zod validation errors.

Kiran Kef55717c70e1
diff --git a/apps/web/lib/api/commissions/create-manual-commissions.ts b/apps/web/lib/api/commissions/create-manual-commissions.ts
index ffbd3f7ebe..0680901517 100644
--- a/apps/web/lib/api/commissions/create-manual-commissions.ts
+++ b/apps/web/lib/api/commissions/create-manual-commissions.ts
@@ -121,13 +121,6 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
productId,
} = args;
- if (!importStripeInvoices && !saleAmount) {
- throw new DubApiError({
- code: "bad_request",
- message: "Either saleAmount or importStripeInvoices must be provided.",
- });
- }
-
const hasManualSaleFields =
saleAmount || saleEventDate || invoiceId || productId;
diff --git a/apps/web/lib/api/errors.ts b/apps/web/lib/api/errors.ts
index 0f129910fd..c4e623f8d4 100644
--- a/apps/web/lib/api/errors.ts
+++ b/apps/web/lib/api/errors.ts
@@ -63,6 +63,19 @@ export class DubApiError extends Error {
const docErrorUrl = "https://dub.co/docs/api-reference/errors";
export function fromZodError(error: z.ZodError): ErrorResponse {
+ const [issue] = error.issues;
+
+ // Custom business rules already include human-readable messages.
+ if (error.issues.length === 1 && issue.code === "custom") {
+ return {
+ error: {
+ code: "unprocessable_entity",
+ message: issue.message,
+ doc_url: `${docErrorUrl}#unprocessable-entity`,
+ },
+ };
+ }
+
return {
error: {
code: "unprocessable_entity",
diff --git a/apps/web/lib/zod/schemas/commissions.ts b/apps/web/lib/zod/schemas/commissions.ts
index 7cf8af8034..147c882f64 100644
--- a/apps/web/lib/zod/schemas/commissions.ts
+++ b/apps/web/lib/zod/schemas/commissions.ts
@@ -577,7 +577,7 @@ export const createManualCommissionBodySchema = z
ctx.addIssue({
code: z.ZodIssueCode.custom,
message:
- "`description` is required when creating a clawback (negative amount).",
+ "Description is required when creating a clawback (negative amount).",
path: ["description"],
});
}
@@ -589,8 +589,7 @@ export const createManualCommissionBodySchema = z
if (!data.importStripeInvoices && data.saleAmount == null) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
- message:
- "`saleAmount` is required when `importStripeInvoices` is false.",
+ message: "saleAmount is required when importStripeInvoices is false.",
path: ["saleAmount"],
});
}
diff --git a/apps/web/playwright/api/clawbacks/clawbacks.spec.ts b/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
index 8a0a6a9fb7..e36e29103a 100644
--- a/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
+++ b/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
@@ -162,7 +162,7 @@ const clawbackErrorCases = [
},
expected: apiError({
code: "unprocessable_entity",
- message: "custom: amount: Amount cannot be 0.",
+ message: "Amount cannot be 0.",
}),
},
{
@@ -171,7 +171,7 @@ const clawbackErrorCases = [
expected: apiError({
code: "unprocessable_entity",
message:
- "custom: description: `description` is required when creating a clawback (negative amount).",
+ "Description is required when creating a clawback (negative amount).",
}),
},
];
diff --git a/apps/web/tests/commissions/create-commission.test.ts b/apps/web/tests/commissions/create-commission.test.ts
index 903a87033b..e4a88fc97a 100644
--- a/apps/web/tests/commissions/create-commission.test.ts
+++ b/apps/web/tests/commissions/create-commission.test.ts
@@ -31,7 +31,7 @@ const validationCases = [
name: "custom commission with amount 0",
body: { type: "custom", partnerId: E2E_PARTNER.id, amount: 0 },
expectedStatus: 422,
- expectedMessage: "custom: amount: Amount cannot be 0.",
+ expectedMessage: "Amount cannot be 0.",
},
{
name: "sale commission missing saleAmount",
@@ -43,7 +43,7 @@ const validationCases = [
},
expectedStatus: 422,
expectedMessage:
- "custom: saleAmount: `saleAmount` is required when `importStripeInvoices` is false.",
+ "saleAmount is required when importStripeInvoices is false.",
},
];