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.

Add partner search filters and metric sorting

Rafi735d6515d3a4
diff --git a/apps/web/lib/api/partners/search/mock-provider.ts b/apps/web/lib/api/partners/search/mock-provider.ts
index a2a3bd0455..9897020c77 100644
--- a/apps/web/lib/api/partners/search/mock-provider.ts
+++ b/apps/web/lib/api/partners/search/mock-provider.ts
@@ -4,10 +4,109 @@ import {
} from "./searchable-values";
import {
PartnerSearchDocument,
+ PartnerSearchFilters,
+ PartnerSearchListFilter,
+ PartnerSearchMetricField,
PartnerSearchProvider,
PartnerSearchQuery,
} from "./types";
+function matchesListFilter(
+ value: string | null,
+ filter: PartnerSearchListFilter,
+): boolean {
+ const matches = value !== null && filter.values.includes(value);
+ return filter.operator === "IN" ? matches : !matches;
+}
+
+function matchesArrayFilter(
+ values: string[],
+ filter: PartnerSearchListFilter,
+): boolean {
+ const matches = values.some((value) => filter.values.includes(value));
+ return filter.operator === "IN" ? matches : !matches;
+}
+
+function matchesFilters(
+ document: PartnerSearchDocument,
+ filters: PartnerSearchFilters | undefined,
+): boolean {
+ if (!filters) {
+ return true;
+ }
+
+ if (filters.status && document.status !== filters.status) {
+ return false;
+ }
+ if (filters.tenantId && document.tenantId !== filters.tenantId) {
+ return false;
+ }
+ if (filters.partnerIds && !filters.partnerIds.includes(document.partnerId)) {
+ return false;
+ }
+ if (
+ filters.groupIds &&
+ !matchesListFilter(document.groupId, filters.groupIds)
+ ) {
+ return false;
+ }
+ if (
+ filters.countries &&
+ !matchesListFilter(document.country, filters.countries)
+ ) {
+ return false;
+ }
+ if (
+ filters.partnerTagIds &&
+ !matchesArrayFilter(document.partnerTagIds, filters.partnerTagIds)
+ ) {
+ return false;
+ }
+ if (
+ filters.referredByPartnerId &&
+ document.referredByPartnerId !== filters.referredByPartnerId
+ ) {
+ return false;
+ }
+
+ for (const [field, range] of Object.entries(filters.metrics ?? {})) {
+ const value = document[field as PartnerSearchMetricField];
+ if (value === null) {
+ return false;
+ }
+ if (range.min !== undefined && value < range.min) {
+ return false;
+ }
+ if (range.max !== undefined && value > range.max) {
+ return false;
+ }
+ }
+
+ return true;
+}
+
+function compareDocuments(
+ left: PartnerSearchDocument,
+ right: PartnerSearchDocument,
+ sort: NonNullable<PartnerSearchQuery["sort"]>,
+): number {
+ const leftValue = left[sort.field];
+ const rightValue = right[sort.field];
+
+ if (leftValue === rightValue) {
+ return left.id.localeCompare(right.id);
+ }
+ if (leftValue === null) {
+ return 1;
+ }
+ if (rightValue === null) {
+ return -1;
+ }
+
+ const comparison = leftValue < rightValue ? -1 : 1;
+ return sort.order === "asc" ? comparison : -comparison;
+}
+
/**
* In-memory search used for unit tests and API plumbing. It is not
* intended for production or performance testing.
@@ -20,16 +119,28 @@ export function createMockPartnerSearchProvider(
);
return {
- async search({ programId, query, limit, offset }: PartnerSearchQuery) {
+ async search({
+ programId,
+ query,
+ limit,
+ offset,
+ filters,
+ sort,
+ }: PartnerSearchQuery) {
const normalizedQuery = normalizePartnerSearchQuery(query);
const matches = Array.from(documents.values()).filter(
(document) =>
document.programId === programId &&
+ matchesFilters(document, filters) &&
getPartnerSearchableValues(document).some((value) =>
normalizePartnerSearchQuery(value).includes(normalizedQuery),
),
);
+ if (sort) {
+ matches.sort((left, right) => compareDocuments(left, right, sort));
+ }
+
return {
hits: matches.slice(offset, offset + limit).map((document) => ({
id: document.id,
diff --git a/apps/web/lib/api/partners/search/serialize-document.ts b/apps/web/lib/api/partners/search/serialize-document.ts
index e84de21d1a..be726aeddd 100644
--- a/apps/web/lib/api/partners/search/serialize-document.ts
+++ b/apps/web/lib/api/partners/search/serialize-document.ts
@@ -6,7 +6,20 @@ export const partnerSearchDocumentSelect = {
programId: true,
partnerId: true,
status: true,
+ tenantId: true,
groupId: true,
+ totalClicks: true,
+ totalLeads: true,
+ totalConversions: true,
+ totalSaleAmount: true,
+ totalCommissions: true,
+ netRevenue: true,
+ earningsPerClick: true,
+ averageLifetimeValue: true,
+ clickToLeadRate: true,
+ clickToConversionRate: true,
+ leadToConversionRate: true,
+ returnOnAdSpend: true,
createdAt: true,
updatedAt: true,
partner: {
@@ -35,6 +48,16 @@ export const partnerSearchDocumentSelect = {
updatedAt: true,
},
},
+ programPartnerTags: {
+ select: {
+ partnerTagId: true,
+ },
+ },
+ applicationEvent: {
+ select: {
+ referredByPartnerId: true,
+ },
+ },
} satisfies Prisma.ProgramEnrollmentSelect;
export type PartnerSearchDocumentSource = Prisma.ProgramEnrollmentGetPayload<{
@@ -80,8 +103,26 @@ export function serializePartnerSearchDocument(
shortLinks: unique(links.map(({ shortLink }) => shortLink)),
destinationUrls: unique(links.map(({ url }) => url)),
status: enrollment.status,
+ tenantId: enrollment.tenantId,
groupId: enrollment.groupId,
country: partner.country,
+ partnerTagIds: unique(
+ enrollment.programPartnerTags.map(({ partnerTagId }) => partnerTagId),
+ ),
+ referredByPartnerId:
+ enrollment.applicationEvent?.referredByPartnerId ?? null,
+ totalClicks: enrollment.totalClicks,
+ totalLeads: enrollment.totalLeads,
+ totalConversions: enrollment.totalConversions,
+ totalSaleAmount: Number(enrollment.totalSaleAmount),
+ totalCommissions: Number(enrollment.totalCommissions),
+ netRevenue: Number(enrollment.netRevenue),
+ earningsPerClick: enrollment.earningsPerClick,
+ averageLifetimeValue: enrollment.averageLifetimeValue,
+ clickToLeadRate: enrollment.clickToLeadRate,
+ clickToConversionRate: enrollment.clickToConversionRate,
+ leadToConversionRate: enrollment.leadToConversionRate,
+ returnOnAdSpend: enrollment.returnOnAdSpend,
createdAt: enrollment.createdAt.toISOString(),
updatedAt: getDocumentUpdatedAt(enrollment),
};
diff --git a/apps/web/lib/api/partners/search/types.ts b/apps/web/lib/api/partners/search/types.ts
index 784c0e71a3..2526941236 100644
--- a/apps/web/lib/api/partners/search/types.ts
+++ b/apps/web/lib/api/partners/search/types.ts
@@ -27,17 +27,78 @@ export interface PartnerSearchDocument {
// Program-scoped fields needed to constrain search results
status: ProgramEnrollmentStatus;
+ tenantId: string | null;
groupId: string | null;
country: string | null;
+ partnerTagIds: string[];
+ referredByPartnerId: string | null;
+ totalClicks: number;
+ totalLeads: number;
+ totalConversions: number;
+ totalSaleAmount: number;
+ totalCommissions: number;
+ netRevenue: number;
+ earningsPerClick: number;
+ averageLifetimeValue: number | null;
+ clickToLeadRate: number | null;
+ clickToConversionRate: number | null;
+ leadToConversionRate: number | null;
+ returnOnAdSpend: number | null;
createdAt: string;
updatedAt: string;
}
+export type PartnerSearchSortField =
+ | "createdAt"
+ | "totalClicks"
+ | "totalLeads"
+ | "totalConversions"
+ | "totalSaleAmount"
+ | "totalCommissions"
+ | "netRevenue"
+ | "earningsPerClick"
+ | "averageLifetimeValue"
+ | "clickToLeadRate"
+ | "clickToConversionRate"
+ | "leadToConversionRate"
+ | "returnOnAdSpend";
+
+export type PartnerSearchMetricField = Exclude<
+ PartnerSearchSortField,
+ "createdAt"
+>;
+
+export interface PartnerSearchListFilter {
+ values: string[];
+ operator: "IN" | "NOT_IN";
+}
+
+export interface PartnerSearchRangeFilter {
+ min?: number;
+ max?: number;
+}
+
+export interface PartnerSearchFilters {
+ status?: ProgramEnrollmentStatus;
+ tenantId?: string;
+ partnerIds?: string[];
+ groupIds?: PartnerSearchListFilter;
+ countries?: PartnerSearchListFilter;
+ partnerTagIds?: PartnerSearchListFilter;
+ referredByPartnerId?: string;
+ metrics?: Partial<Record<PartnerSearchMetricField, PartnerSearchRangeFilter>>;
+}
+
export interface PartnerSearchQuery {
programId: string;
query: string;
limit: number;
offset: number;
+ filters?: PartnerSearchFilters;
+ sort?: {
+ field: PartnerSearchSortField;
+ order: "asc" | "desc";
+ };
}
export interface PartnerSearchHit {
diff --git a/apps/web/tests/partners/partner-search-document.test.ts b/apps/web/tests/partners/partner-search-document.test.ts
index 087e9ed58e..487b55e851 100644
--- a/apps/web/tests/partners/partner-search-document.test.ts
+++ b/apps/web/tests/partners/partner-search-document.test.ts
@@ -9,7 +9,20 @@ const source: PartnerSearchDocumentSource = {
programId: "prog_test",
partnerId: "pn_test",
status: "approved",
+ tenantId: "tenant_test",
groupId: "grp_test",
+ totalClicks: 100,
+ totalLeads: 20,
+ totalConversions: 10,
+ totalSaleAmount: BigInt(50_000),
+ totalCommissions: BigInt(10_000),
+ netRevenue: BigInt(40_000),
+ earningsPerClick: 5,
+ averageLifetimeValue: 5_000,
+ clickToLeadRate: 0.2,
+ clickToConversionRate: 0.1,
+ leadToConversionRate: 0.5,
+ returnOnAdSpend: 5,
createdAt: new Date("2026-01-01T00:00:00.000Z"),
updatedAt: new Date("2026-01-02T00:00:00.000Z"),
partner: {
@@ -48,6 +61,13 @@ const source: PartnerSearchDocumentSource = {
updatedAt: new Date("2026-01-07T00:00:00.000Z"),
},
],
+ programPartnerTags: [
+ { partnerTagId: "ptag_test" },
+ { partnerTagId: "ptag_test" },
+ ],
+ applicationEvent: {
+ referredByPartnerId: "pn_referrer",
+ },
};
describe("serializePartnerSearchDocument", () => {
@@ -70,8 +90,23 @@ describe("serializePartnerSearchDocument", () => {
"https://rafi.dev/tools",
],
status: "approved",
+ tenantId: "tenant_test",
groupId: "grp_test",
country: "CA",
+ partnerTagIds: ["ptag_test"],
+ referredByPartnerId: "pn_referrer",
+ totalClicks: 100,
+ totalLeads: 20,
+ totalConversions: 10,
+ totalSaleAmount: 50_000,
+ totalCommissions: 10_000,
+ netRevenue: 40_000,
+ earningsPerClick: 5,
+ averageLifetimeValue: 5_000,
+ clickToLeadRate: 0.2,
+ clickToConversionRate: 0.1,
+ leadToConversionRate: 0.5,
+ returnOnAdSpend: 5,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-07T00:00:00.000Z",
});
diff --git a/apps/web/tests/partners/partner-search-provider.test.ts b/apps/web/tests/partners/partner-search-provider.test.ts
index 8fc430d1d2..ab9f0af6a4 100644
--- a/apps/web/tests/partners/partner-search-provider.test.ts
+++ b/apps/web/tests/partners/partner-search-provider.test.ts
@@ -19,8 +19,23 @@ const partnerDocument: PartnerSearchDocument = {
shortLinks: ["https://dub.sh/rafi"],
destinationUrls: ["https://example.com/referrals/rafi"],
status: "approved",
+ tenantId: "tenant_test",
groupId: null,
country: "CA",
+ partnerTagIds: ["ptag_test"],
+ referredByPartnerId: "pn_referrer",
+ totalClicks: 100,
+ totalLeads: 20,
+ totalConversions: 10,
+ totalSaleAmount: 50_000,
+ totalCommissions: 10_000,
+ netRevenue: 40_000,
+ earningsPerClick: 5,
+ averageLifetimeValue: 5_000,
+ clickToLeadRate: 0.2,
+ clickToConversionRate: 0.1,
+ leadToConversionRate: 0.5,
+ returnOnAdSpend: 5,
createdAt: "2026-08-08T00:00:00.000Z",
updatedAt: "2026-08-08T00:00:00.000Z",
};
@@ -63,4 +78,50 @@ describe("partner search provider contract", () => {
expect(result).toEqual({ hits: [], total: 0 });
});
+
+ it("combines search with filters", async () => {
+ const provider = createMockPartnerSearchProvider([partnerDocument]);
+
+ const result = await provider.search({
+ programId: partnerDocument.programId,
+ query: "examp",
+ limit: 10,
+ offset: 0,
+ filters: {
+ status: "approved",
+ countries: { values: ["CA"], operator: "IN" },
+ partnerTagIds: { values: ["ptag_test"], operator: "IN" },
+ metrics: { totalSaleAmount: { min: 40_000 } },
+ },
+ });
+
+ expect(result.total).toBe(1);
+ });
+
+ it("sorts filtered search results", async () => {
+ const higherRevenuePartner: PartnerSearchDocument = {
+ ...partnerDocument,
+ id: "pge_higher_revenue",
+ partnerId: "pn_higher_revenue",
+ email: "[email protected]",
+ totalSaleAmount: 100_000,
+ };
+ const provider = createMockPartnerSearchProvider([
+ partnerDocument,
+ higherRevenuePartner,
+ ]);
+
+ const result = await provider.search({
+ programId: partnerDocument.programId,
+ query: "examp",
+ limit: 10,
+ offset: 0,
+ sort: { field: "totalSaleAmount", order: "desc" },
+ });
+
+ expect(result.hits.map(({ partnerId }) => partnerId)).toEqual([
+ "pn_higher_revenue",
+ "pn_test",
+ ]);
+ });
});