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.

Share events pagination schema and support max page size.

Kiran Kbc451b0ddaf2
diff --git a/apps/web/lib/analytics/get-events.ts b/apps/web/lib/analytics/get-events.ts
index 7869051ce3..4834bb0b23 100644
--- a/apps/web/lib/analytics/get-events.ts
+++ b/apps/web/lib/analytics/get-events.ts
@@ -49,6 +49,8 @@ export const getEvents = async (params: EventsFilters) => {
dataAvailableFrom,
query,
includeMetadata = true,
+ page,
+ limit,
} = params;
const { startDate, endDate } = getStartEndDates({
@@ -155,8 +157,8 @@ export const getEvents = async (params: EventsFilters) => {
...(params.root !== undefined ? { root: params.root } : {}),
...(params.saleType ? { saleType: params.saleType } : {}),
order: sortOrder,
- offset: Math.max(0, (params.page - 1) * params.limit),
- limit: params.limit,
+ offset: (page - 1) * limit,
+ limit,
sortBy: params.sortBy,
start: formatUTCDateTimeClickhouse(startDate),
end: formatUTCDateTimeClickhouse(endDate),
diff --git a/apps/web/lib/zod/schemas/analytics.ts b/apps/web/lib/zod/schemas/analytics.ts
index 84dcfe0c9a..b4ec4aa301 100644
--- a/apps/web/lib/zod/schemas/analytics.ts
+++ b/apps/web/lib/zod/schemas/analytics.ts
@@ -13,7 +13,7 @@ import {
parseFilterValue,
} from "@dub/utils";
import * as z from "zod/v4";
-import { booleanQuerySchema } from "./misc";
+import { booleanQuerySchema, getPaginationQuerySchema } from "./misc";
import { parseDateSchema } from "./utils";
const analyticsEvents = z
@@ -526,6 +526,11 @@ const sortOrder = z
.optional()
.describe("The sort order. The default is `desc`.");
+const eventsPaginationQuerySchema = getPaginationQuerySchema({
+ pageSize: DEFAULT_PAGINATION_LIMIT,
+ maxPageSize: 1000,
+});
+
export const eventsQuerySchema = analyticsQuerySchema
.omit({ groupBy: true })
.extend({
@@ -535,23 +540,8 @@ export const eventsQuerySchema = analyticsQuerySchema
.describe(
"The type of event to retrieve analytics for. Defaults to 'clicks'.",
),
- page: z.coerce
- .number({ error: "Page must be a number." })
- .int({ message: "Page must be an integer." })
- .positive({ message: "Page must be greater than 0." })
- .default(1)
- .describe(
- "The page number for pagination (1-based). The first page is `1`.",
- )
- .meta({ example: 1 }),
- limit: z.coerce
- .number({ error: "Limit must be a number." })
- .int({ message: "Limit must be an integer." })
- .positive({ message: "Limit must be greater than 0." })
- .max(1000, { message: "Max pagination limit is 1000 items per page." })
- .default(DEFAULT_PAGINATION_LIMIT)
- .describe("The number of events to return per page.")
- .meta({ example: DEFAULT_PAGINATION_LIMIT }),
+ page: eventsPaginationQuerySchema.page.default(1),
+ limit: eventsPaginationQuerySchema.pageSize,
sortOrder,
sortBy: z
.enum(["timestamp"])
diff --git a/apps/web/lib/zod/schemas/misc.ts b/apps/web/lib/zod/schemas/misc.ts
index 8f46a81836..8bde58e965 100644
--- a/apps/web/lib/zod/schemas/misc.ts
+++ b/apps/web/lib/zod/schemas/misc.ts
@@ -33,9 +33,11 @@ export const booleanQuerySchema = z
export const getPaginationQuerySchema = ({
pageSize,
deprecated = false,
+ maxPageSize,
}: {
pageSize: number;
deprecated?: boolean;
+ maxPageSize?: number;
}) => ({
page: z.coerce
.number({ error: "Page must be a number." })
@@ -45,7 +47,7 @@ export const getPaginationQuerySchema = ({
.describe(
deprecated
? "DEPRECATED. Use `startingAfter` instead."
- : "The page number for pagination.",
+ : "The page number for pagination. The first page is `1`.",
)
.meta({
example: 1,
@@ -55,8 +57,8 @@ export const getPaginationQuerySchema = ({
.number({ error: "Page size must be a number." })
.int({ message: "Page size must be an integer." })
.positive({ message: "Page size must be greater than 0." })
- .max(pageSize, {
- message: `Max page size is ${pageSize}.`,
+ .max(maxPageSize ?? pageSize, {
+ message: `Max page size is ${maxPageSize ?? pageSize}.`,
})
.optional()
.default(pageSize)