The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Update partner search pagination and ID matching
Rafia767400bd3f4
diff --git a/apps/web/lib/api/partners/search/build-search-query.ts b/apps/web/lib/api/partners/search/build-search-query.tsnew file mode 100644index 0000000000..1b51df0814--- /dev/null+++ b/apps/web/lib/api/partners/search/build-search-query.ts@@ -0,0 +1,140 @@+import { getPartnersQuerySchemaExtended } from "@/lib/zod/schemas/partners";+import * as z from "zod/v4";+import {+ PartnerSearchFilters,+ PartnerSearchListFilter,+ PartnerSearchMetricField,+ PartnerSearchQuery,+ PartnerSearchRangeFilter,+} from "./types";++export type PartnerSearchQueryInput = z.infer<+ typeof getPartnersQuerySchemaExtended+> & {+ programId: string;+ partnerTagIdOperator?: "IN" | "NOT IN";+ groupIdOperator?: "IN" | "NOT IN";+ countryOperator?: "IN" | "NOT IN";+};++function buildListFilter(+ values: string | string[] | undefined,+ operator: "IN" | "NOT IN" | undefined,+): PartnerSearchListFilter | undefined {+ if (values === undefined) {+ return undefined;+ }++ const normalizedValues = (Array.isArray(values) ? values : [values]).filter(+ Boolean,+ );+ if (normalizedValues.length === 0) {+ return undefined;+ }++ return {+ values: normalizedValues,+ operator: operator === "NOT IN" ? "NOT_IN" : "IN",+ };+}++function addMetricRange(+ metrics: NonNullable<PartnerSearchFilters["metrics"]>,+ field: PartnerSearchMetricField,+ min: number | undefined,+ max: number | undefined,+) {+ if (min === undefined && max === undefined) {+ return;+ }++ const range: PartnerSearchRangeFilter = {};+ if (min !== undefined) {+ range.min = min;+ }+ if (max !== undefined) {+ range.max = max;+ }+ metrics[field] = range;+}++export function buildPartnerSearchQuery({+ programId,+ search,+ email,+ tenantId,+ page = 1,+ pageSize,+ sortBy,+ sortOrder,+ status,+ partnerIds,+ groupId,+ groupIdOperator,+ country,+ countryOperator,+ partnerTagId,+ partnerTagIdOperator,+ referredByPartnerId,+ totalClicksMin,+ totalClicksMax,+ totalLeadsMin,+ totalLeadsMax,+ totalConversionsMin,+ totalConversionsMax,+ totalSaleAmountMin,+ totalSaleAmountMax,+ totalCommissionsMin,+ totalCommissionsMax,+}: PartnerSearchQueryInput): PartnerSearchQuery | null {+ const query = search?.trim();++ // Keep exact lookups on the database and use search for free-text queries.+ if (!query || email || tenantId) {+ return null;+ }++ const metrics: NonNullable<PartnerSearchFilters["metrics"]> = {};+ addMetricRange(metrics, "totalClicks", totalClicksMin, totalClicksMax);+ addMetricRange(metrics, "totalLeads", totalLeadsMin, totalLeadsMax);+ addMetricRange(+ metrics,+ "totalConversions",+ totalConversionsMin,+ totalConversionsMax,+ );+ addMetricRange(+ metrics,+ "totalSaleAmount",+ totalSaleAmountMin,+ totalSaleAmountMax,+ );+ addMetricRange(+ metrics,+ "totalCommissions",+ totalCommissionsMin,+ totalCommissionsMax,+ );++ const filters: PartnerSearchFilters = {+ status,+ partnerIds,+ groupIds: buildListFilter(groupId, groupIdOperator),+ countries: buildListFilter(country, countryOperator),+ partnerTagIds: buildListFilter(partnerTagId, partnerTagIdOperator),+ referredByPartnerId,+ ...(Object.keys(metrics).length > 0 && { metrics }),+ };++ return {+ programId,+ query,+ page,+ pageSize,+ filters,+ sort: {+ field: sortBy,+ order: sortOrder,+ },+ };+}diff --git a/apps/web/lib/api/partners/search/index.ts b/apps/web/lib/api/partners/search/index.tsindex ebe5ce1b5d..1f211e7de9 100644--- a/apps/web/lib/api/partners/search/index.ts+++ b/apps/web/lib/api/partners/search/index.ts@@ -1,3 +1,4 @@+export * from "./build-search-query";export * from "./mock-provider";export * from "./searchable-values";export * from "./serialize-document";diff --git a/apps/web/lib/api/partners/search/mock-provider.ts b/apps/web/lib/api/partners/search/mock-provider.tsindex 9897020c77..e57dac0f3b 100644--- a/apps/web/lib/api/partners/search/mock-provider.ts+++ b/apps/web/lib/api/partners/search/mock-provider.ts@@ -122,8 +122,8 @@ export function createMockPartnerSearchProvider(async search({programId,query,- limit,- offset,+ page,+ pageSize,filters,sort,}: PartnerSearchQuery) {@@ -141,8 +141,10 @@ export function createMockPartnerSearchProvider(matches.sort((left, right) => compareDocuments(left, right, sort));}+ const offset = (page - 1) * pageSize;+return {- hits: matches.slice(offset, offset + limit).map((document) => ({+ hits: matches.slice(offset, offset + pageSize).map((document) => ({id: document.id,partnerId: document.partnerId,})),diff --git a/apps/web/lib/api/partners/search/searchable-values.ts b/apps/web/lib/api/partners/search/searchable-values.tsindex f3549b9f24..4b3f8d49ed 100644--- a/apps/web/lib/api/partners/search/searchable-values.ts+++ b/apps/web/lib/api/partners/search/searchable-values.ts@@ -8,6 +8,7 @@ export function getPartnerSearchableValues(document: PartnerSearchDocument,): string[] {return [+ document.partnerId,document.name,document.email,document.companyName,diff --git a/apps/web/lib/api/partners/search/types.ts b/apps/web/lib/api/partners/search/types.tsindex 2526941236..90e0ab53b7 100644--- a/apps/web/lib/api/partners/search/types.ts+++ b/apps/web/lib/api/partners/search/types.ts@@ -25,7 +25,7 @@ export interface PartnerSearchDocument {shortLinks: string[];destinationUrls: string[];- // Program-scoped fields needed to constrain search results+ // Program-scoped fields used by search filters and sortingstatus: ProgramEnrollmentStatus;tenantId: string | null;groupId: string | null;@@ -92,8 +92,8 @@ export interface PartnerSearchFilters {export interface PartnerSearchQuery {programId: string;query: string;- limit: number;- offset: number;+ page: number;+ pageSize: number;filters?: PartnerSearchFilters;sort?: {field: PartnerSearchSortField;diff --git a/apps/web/tests/partners/partner-search-provider.test.ts b/apps/web/tests/partners/partner-search-provider.test.tsindex ab9f0af6a4..f88de2b6f6 100644--- a/apps/web/tests/partners/partner-search-provider.test.ts+++ b/apps/web/tests/partners/partner-search-provider.test.ts@@ -43,6 +43,7 @@ const partnerDocument: PartnerSearchDocument = {describe("partner search provider contract", () => {it.each([["name", "rafi"],+ ["partner ID", "pn_test"],["partial email", "examp"],["company name", "dub partners"],["description", "educator"],@@ -58,8 +59,8 @@ describe("partner search provider contract", () => {const result = await provider.search({programId: partnerDocument.programId,query,- limit: 10,- offset: 0,+ page: 1,+ pageSize: 10,});expect(result.total).toBe(1);@@ -72,8 +73,8 @@ describe("partner search provider contract", () => {const result = await provider.search({programId: "prog_other",query: "rafi",- limit: 10,- offset: 0,+ page: 1,+ pageSize: 10,});expect(result).toEqual({ hits: [], total: 0 });@@ -85,8 +86,8 @@ describe("partner search provider contract", () => {const result = await provider.search({programId: partnerDocument.programId,query: "examp",- limit: 10,- offset: 0,+ page: 1,+ pageSize: 10,filters: {status: "approved",countries: { values: ["CA"], operator: "IN" },@@ -114,8 +115,8 @@ describe("partner search provider contract", () => {const result = await provider.search({programId: partnerDocument.programId,query: "examp",- limit: 10,- offset: 0,+ page: 1,+ pageSize: 10,sort: { field: "totalSaleAmount", order: "desc" },});diff --git a/apps/web/tests/partners/partner-search-query.test.ts b/apps/web/tests/partners/partner-search-query.test.tsnew file mode 100644index 0000000000..8e0188a6ba--- /dev/null+++ b/apps/web/tests/partners/partner-search-query.test.ts@@ -0,0 +1,58 @@+import { buildPartnerSearchQuery } from "@/lib/api/partners/search";+import { describe, expect, it } from "vitest";++const defaultInput = {+ programId: "prog_test",+ search: " examp ",+ page: 3,+ pageSize: 25,+ sortBy: "totalSaleAmount" as const,+ sortOrder: "desc" as const,+};++describe("buildPartnerSearchQuery", () => {+ it("maps API pagination, filters, ranges, and sorting", () => {+ expect(+ buildPartnerSearchQuery({+ ...defaultInput,+ status: "approved",+ partnerIds: ["pn_1", "pn_2"],+ groupId: ["grp_1"],+ groupIdOperator: "NOT IN",+ country: ["CA", "US"],+ partnerTagId: ["ptag_1"],+ referredByPartnerId: "pn_referrer",+ totalClicksMin: 10,+ totalClicksMax: 100,+ totalSaleAmountMin: 5_000,+ }),+ ).toEqual({+ programId: "prog_test",+ query: "examp",+ page: 3,+ pageSize: 25,+ filters: {+ status: "approved",+ partnerIds: ["pn_1", "pn_2"],+ groupIds: { values: ["grp_1"], operator: "NOT_IN" },+ countries: { values: ["CA", "US"], operator: "IN" },+ partnerTagIds: { values: ["ptag_1"], operator: "IN" },+ referredByPartnerId: "pn_referrer",+ metrics: {+ totalClicks: { min: 10, max: 100 },+ totalSaleAmount: { min: 5_000 },+ },+ },+ sort: { field: "totalSaleAmount", order: "desc" },+ });+ });++ it.each([+ ["missing search", { ...defaultInput, search: undefined }],+ ["empty search", { ...defaultInput, search: " " }],+ ["exact email", { ...defaultInput, email: "[email protected]" }],+ ["tenant ID", { ...defaultInput, tenantId: "tenant_test" }],+ ])("keeps %s on the database path", (_name, input) => {+ expect(buildPartnerSearchQuery(input)).toBeNull();+ });+});