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.

Use search candidates to filter database partner queries

Rafi332245c2055a
diff --git a/apps/web/lib/api/partners/get-partners-count.ts b/apps/web/lib/api/partners/get-partners-count.ts
index 8bf0c4c6ff..c2560537b5 100644
--- a/apps/web/lib/api/partners/get-partners-count.ts
+++ b/apps/web/lib/api/partners/get-partners-count.ts
@@ -10,7 +10,7 @@ import {
mergePartnerCountryAndSearchWhere,
} from "./program-enrollment-query";
import {
- buildPartnerSearchCountQuery,
+ buildPartnerSearchCandidateQuery,
getPartnerSearchProvider,
PartnerSearchProvider,
} from "./search";
@@ -29,35 +29,19 @@ export async function getPartnersCount<T>(
}: { searchProvider?: PartnerSearchProvider | null } = {},
): Promise<T> {
const { groupBy, programId, ...enrollmentFilters } = filters;
- const enrollmentBase = { ...enrollmentFilters, programId };
-
- const searchQuery = searchProvider
- ? buildPartnerSearchCountQuery(enrollmentBase)
+ const candidateQuery = searchProvider
+ ? buildPartnerSearchCandidateQuery({ ...enrollmentFilters, programId })
: null;
-
- if (searchProvider && searchQuery) {
- if (!groupBy) {
- return (await searchProvider.count(searchQuery)) as T;
- }
-
- const groups = await searchProvider.groupBy(searchQuery, groupBy);
- const results = groups
- .sort((left, right) => right.count - left.count)
- .map(({ value, count }) => ({
- [groupBy]: value,
- _count: count,
- }));
-
- if (groupBy === "status") {
- for (const status of Object.values(ProgramEnrollmentStatus)) {
- if (!results.some((result) => result.status === status)) {
- results.push({ status, _count: 0 });
- }
- }
- }
-
- return results as T;
- }
+ const candidateResult =
+ searchProvider && candidateQuery
+ ? await searchProvider.searchCandidates(candidateQuery)
+ : null;
+ const candidateIds = candidateResult?.hits.map(({ id }) => id);
+ const enrollmentBase = {
+ ...enrollmentFilters,
+ programId,
+ ...(candidateResult ? { search: undefined } : {}),
+ };
const {
status,
@@ -76,6 +60,7 @@ export async function getPartnersCount<T>(
const enrollmentScope: Prisma.ProgramEnrollmentWhereInput = {
programId,
...(tenantId ? { tenantId } : {}),
+ ...(candidateIds ? { id: { in: candidateIds } } : {}),
};
const partnerTagIdNotIn = partnerTagIdOperator === "NOT IN";
@@ -208,10 +193,13 @@ export async function getPartnersCount<T>(
}
if (groupBy === "partnerTagId") {
- const enrollmentWhere = buildProgramEnrollmentWhereForList({
- ...enrollmentBase,
- partnerTagId: undefined,
- });
+ const enrollmentWhere: Prisma.ProgramEnrollmentWhereInput = {
+ ...buildProgramEnrollmentWhereForList({
+ ...enrollmentBase,
+ partnerTagId: undefined,
+ }),
+ ...(candidateIds ? { id: { in: candidateIds } } : {}),
+ };
const partners = await prisma.programPartnerTag.groupBy({
by: ["partnerTagId"],
@@ -262,7 +250,10 @@ export async function getPartnersCount<T>(
// Get absolute count of partners
const count = await prisma.programEnrollment.count({
- where: buildProgramEnrollmentWhereForList(enrollmentBase),
+ where: {
+ ...buildProgramEnrollmentWhereForList(enrollmentBase),
+ ...(candidateIds ? { id: { in: candidateIds } } : {}),
+ },
});
return count as T;
diff --git a/apps/web/lib/api/partners/get-partners.ts b/apps/web/lib/api/partners/get-partners.ts
index 59f37b9efe..83d5fc407b 100644
--- a/apps/web/lib/api/partners/get-partners.ts
+++ b/apps/web/lib/api/partners/get-partners.ts
@@ -2,7 +2,7 @@ import { prisma } from "@/lib/prisma";
import { toCentsNumber } from "@dub/utils";
import { buildProgramEnrollmentWhereForList } from "./program-enrollment-query";
import {
- buildPartnerSearchQuery,
+ buildPartnerSearchCandidateQuery,
getPartnerSearchProvider,
orderByPartnerSearchHits,
PartnerSearchProvider,
@@ -32,23 +32,29 @@ export async function getPartners(
...enrollmentRest
} = filters;
- const searchQuery = searchProvider ? buildPartnerSearchQuery(filters) : null;
- const searchResult =
- searchProvider && searchQuery
- ? await searchProvider.search(searchQuery)
+ const candidateQuery = searchProvider
+ ? buildPartnerSearchCandidateQuery(filters)
+ : null;
+ const candidateResult =
+ searchProvider && candidateQuery
+ ? await searchProvider.searchCandidates(candidateQuery)
: null;
const databaseSortBy = sortBy === "relevance" ? "totalSaleAmount" : sortBy;
+ const relevanceHits =
+ candidateResult && sortBy === "relevance" ? candidateResult.hits : null;
+ const enrollmentWhere = buildProgramEnrollmentWhereForList({
+ ...enrollmentRest,
+ programId,
+ ...(candidateResult ? { search: undefined } : {}),
+ });
const programEnrollments = await prisma.programEnrollment.findMany({
- where: searchResult
- ? {
- programId,
- id: { in: searchResult.hits.map(({ id }) => id) },
- }
- : buildProgramEnrollmentWhereForList({
- ...enrollmentRest,
- programId,
- }),
+ where: {
+ ...enrollmentWhere,
+ ...(candidateResult
+ ? { id: { in: candidateResult.hits.map(({ id }) => id) } }
+ : {}),
+ },
include: {
partner: {
include: {
@@ -74,19 +80,22 @@ export async function getPartners(
}
: {}),
},
- ...(searchResult
- ? {}
- : {
+ ...(relevanceHits === null
+ ? {
take: pageSize,
skip: (page - 1) * pageSize,
orderBy: {
[databaseSortBy]: sortOrder,
},
- }),
+ }
+ : {}),
});
- const partners = searchResult
- ? orderByPartnerSearchHits(programEnrollments, searchResult.hits)
+ const partners = relevanceHits
+ ? orderByPartnerSearchHits(programEnrollments, relevanceHits).slice(
+ (page - 1) * pageSize,
+ page * pageSize,
+ )
: programEnrollments;
return partners.map(
diff --git a/apps/web/lib/api/partners/search/build-search-query.ts b/apps/web/lib/api/partners/search/build-search-query.ts
index 1a66f7a770..495c1fb4ed 100644
--- a/apps/web/lib/api/partners/search/build-search-query.ts
+++ b/apps/web/lib/api/partners/search/build-search-query.ts
@@ -1,6 +1,8 @@
import { getPartnersQuerySchemaExtended } from "@/lib/zod/schemas/partners";
import * as z from "zod/v4";
+import { PARTNER_SEARCH_CANDIDATE_LIMIT } from "./constants";
import {
+ PartnerSearchCandidateQuery,
PartnerSearchCountQuery,
PartnerSearchFilters,
PartnerSearchListFilter,
@@ -23,6 +25,27 @@ export type PartnerSearchCountQueryInput = Omit<
"page" | "pageSize" | "sortBy" | "sortOrder"
>;
+export function buildPartnerSearchCandidateQuery({
+ programId,
+ search,
+ email,
+ tenantId,
+}: PartnerSearchCountQueryInput): PartnerSearchCandidateQuery | null {
+ const query = search?.trim();
+
+ // Exact email and tenant lookups remain database-only. The search provider
+ // is responsible only for finding relevance-ranked free-text candidates.
+ if (!query || email || tenantId) {
+ return null;
+ }
+
+ return {
+ programId,
+ query,
+ limit: PARTNER_SEARCH_CANDIDATE_LIMIT,
+ };
+}
+
function buildListFilter(
values: string | string[] | undefined,
operator: "IN" | "NOT IN" | undefined,
diff --git a/apps/web/tests/partners/get-partners-count-search.test.ts b/apps/web/tests/partners/get-partners-count-search.test.ts
index 5126721fdb..b31c45f12c 100644
--- a/apps/web/tests/partners/get-partners-count-search.test.ts
+++ b/apps/web/tests/partners/get-partners-count-search.test.ts
@@ -1,15 +1,39 @@
import { getPartnersCount } from "@/lib/api/partners/get-partners-count";
import { PartnerSearchProvider } from "@/lib/api/partners/search";
-import { describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, vi } from "vitest";
-vi.mock("@/lib/prisma", () => ({ prisma: {} }));
+const mocks = vi.hoisted(() => ({
+ count: vi.fn(),
+ enrollmentGroupBy: vi.fn(),
+ partnerGroupBy: vi.fn(),
+ partnerTagGroupBy: vi.fn(),
+ applicationEventGroupBy: vi.fn(),
+}));
+
+vi.mock("@/lib/prisma", () => ({
+ sanitizeFullTextSearch: (value: string) => value,
+ prisma: {
+ programEnrollment: {
+ count: mocks.count,
+ groupBy: mocks.enrollmentGroupBy,
+ },
+ partner: { groupBy: mocks.partnerGroupBy },
+ programPartnerTag: { groupBy: mocks.partnerTagGroupBy },
+ programApplicationEvent: { groupBy: mocks.applicationEventGroupBy },
+ },
+}));
function createSearchProvider(): PartnerSearchProvider {
return {
- searchCandidates: vi.fn(),
+ searchCandidates: vi.fn().mockResolvedValue({
+ hits: [
+ { id: "pge_2", partnerId: "pn_2" },
+ { id: "pge_1", partnerId: "pn_1" },
+ ],
+ }),
search: vi.fn(),
- count: vi.fn().mockResolvedValue(2),
- groupBy: vi.fn().mockResolvedValue([{ value: "approved", count: 2 }]),
+ count: vi.fn(),
+ groupBy: vi.fn(),
waitForIndexing: vi.fn(),
upsert: vi.fn(),
delete: vi.fn(),
@@ -17,46 +41,138 @@ function createSearchProvider(): PartnerSearchProvider {
}
describe("getPartnersCount search", () => {
- it("uses the provider for an absolute searched count", async () => {
+ beforeEach(() => {
+ for (const mock of Object.values(mocks)) {
+ mock.mockReset();
+ }
+ });
+
+ it("counts database-filtered relevance candidates", async () => {
const searchProvider = createSearchProvider();
+ mocks.count.mockResolvedValue(1);
const count = await getPartnersCount<number>(
- { programId: "prog_test", search: "examp" },
+ {
+ programId: "prog_test",
+ search: "examp",
+ status: "approved",
+ country: ["CA"],
+ },
{ searchProvider },
);
- expect(count).toBe(2);
- expect(searchProvider.count).toHaveBeenCalledWith(
- expect.objectContaining({
+ expect(count).toBe(1);
+ expect(searchProvider.searchCandidates).toHaveBeenCalledWith({
+ programId: "prog_test",
+ query: "examp",
+ limit: 100,
+ });
+ expect(searchProvider.count).not.toHaveBeenCalled();
+ expect(mocks.count).toHaveBeenCalledWith({
+ where: expect.objectContaining({
programId: "prog_test",
- query: "examp",
+ status: "approved",
+ id: { in: ["pge_2", "pge_1"] },
+ partner: { country: "CA" },
}),
- );
+ });
});
- it("uses the provider for grouped searched counts", async () => {
+ it("groups database-filtered relevance candidates", async () => {
const searchProvider = createSearchProvider();
+ mocks.enrollmentGroupBy.mockResolvedValue([
+ { status: "approved", _count: 1 },
+ ]);
const groups = await getPartnersCount<{ status: string; _count: number }[]>(
{ programId: "prog_test", search: "examp", groupBy: "status" },
{ searchProvider },
);
- expect(searchProvider.groupBy).toHaveBeenCalledWith(
- expect.objectContaining({ query: "examp" }),
- "status",
+ expect(searchProvider.groupBy).not.toHaveBeenCalled();
+ expect(mocks.enrollmentGroupBy).toHaveBeenCalledWith(
+ expect.objectContaining({
+ by: ["status"],
+ where: expect.objectContaining({
+ programId: "prog_test",
+ id: { in: ["pge_2", "pge_1"] },
+ }),
+ }),
);
expect(groups).toEqual(
expect.arrayContaining([
- { status: "approved", _count: 2 },
+ { status: "approved", _count: 1 },
{ status: "pending", _count: 0 },
]),
);
});
+ it("scopes every database grouping path to relevance candidates", async () => {
+ const searchProvider = createSearchProvider();
+ mocks.partnerGroupBy.mockResolvedValue([]);
+ mocks.partnerTagGroupBy.mockResolvedValue([]);
+ mocks.applicationEventGroupBy.mockResolvedValue([]);
+
+ await getPartnersCount(
+ {
+ programId: "prog_test",
+ search: "examp",
+ groupBy: "country",
+ },
+ { searchProvider },
+ );
+ expect(mocks.partnerGroupBy).toHaveBeenCalledWith(
+ expect.objectContaining({
+ where: expect.objectContaining({
+ programs: {
+ some: expect.objectContaining({
+ id: { in: ["pge_2", "pge_1"] },
+ }),
+ },
+ }),
+ }),
+ );
+
+ await getPartnersCount(
+ {
+ programId: "prog_test",
+ search: "examp",
+ groupBy: "partnerTagId",
+ },
+ { searchProvider },
+ );
+ expect(mocks.partnerTagGroupBy).toHaveBeenCalledWith(
+ expect.objectContaining({
+ where: expect.objectContaining({
+ programEnrollment: expect.objectContaining({
+ id: { in: ["pge_2", "pge_1"] },
+ }),
+ }),
+ }),
+ );
+
+ await getPartnersCount(
+ {
+ programId: "prog_test",
+ search: "examp",
+ groupBy: "referredByPartnerId",
+ },
+ { searchProvider },
+ );
+ expect(mocks.applicationEventGroupBy).toHaveBeenCalledWith(
+ expect.objectContaining({
+ where: expect.objectContaining({
+ programEnrollment: expect.objectContaining({
+ id: { in: ["pge_2", "pge_1"] },
+ }),
+ }),
+ }),
+ );
+ });
+
it("propagates search provider errors", async () => {
const searchProvider = createSearchProvider();
- vi.mocked(searchProvider.count).mockRejectedValue(
+ vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
new Error("Provider Connection Timeout"),
);
diff --git a/apps/web/tests/partners/get-partners-search.test.ts b/apps/web/tests/partners/get-partners-search.test.ts
index 8465745456..2b8004fa6c 100644
--- a/apps/web/tests/partners/get-partners-search.test.ts
+++ b/apps/web/tests/partners/get-partners-search.test.ts
@@ -32,30 +32,34 @@ function enrollment(id: string, partnerId: string) {
};
}
+function createSearchProvider(
+ hits: { id: string; partnerId: string }[] = [],
+): PartnerSearchProvider {
+ return {
+ searchCandidates: vi.fn().mockResolvedValue({ hits }),
+ search: vi.fn(),
+ count: vi.fn(),
+ groupBy: vi.fn(),
+ waitForIndexing: vi.fn(),
+ upsert: vi.fn(),
+ delete: vi.fn(),
+ };
+}
+
describe("getPartners search", () => {
beforeEach(() => {
mocks.findMany.mockReset();
});
- it("hydrates provider hits from the database in provider order", async () => {
+ it("lets the database filter, sort, and paginate search candidates", async () => {
mocks.findMany.mockResolvedValue([
enrollment("pge_1", "pn_1"),
enrollment("pge_2", "pn_2"),
]);
- const searchProvider: PartnerSearchProvider = {
- searchCandidates: vi.fn(),
- search: vi.fn().mockResolvedValue({
- hits: [
- { id: "pge_2", partnerId: "pn_2" },
- { id: "pge_1", partnerId: "pn_1" },
- ],
- }),
- count: vi.fn(),
- groupBy: vi.fn(),
- waitForIndexing: vi.fn(),
- upsert: vi.fn(),
- delete: vi.fn(),
- };
+ const searchProvider = createSearchProvider([
+ { id: "pge_2", partnerId: "pn_2" },
+ { id: "pge_1", partnerId: "pn_1" },
+ ]);
const partners = await getPartners(
{
@@ -65,41 +69,70 @@ describe("getPartners search", () => {
pageSize: 25,
sortBy: "totalSaleAmount",
sortOrder: "desc",
+ status: "approved",
},
{ searchProvider },
);
- expect(searchProvider.search).toHaveBeenCalledWith(
- expect.objectContaining({
- programId: "prog_test",
- query: "examp",
- page: 1,
- pageSize: 25,
- }),
- );
+ expect(searchProvider.searchCandidates).toHaveBeenCalledWith({
+ programId: "prog_test",
+ query: "examp",
+ limit: 100,
+ });
+ expect(searchProvider.search).not.toHaveBeenCalled();
expect(mocks.findMany).toHaveBeenCalledWith(
expect.objectContaining({
- where: {
+ where: expect.objectContaining({
programId: "prog_test",
+ status: "approved",
id: { in: ["pge_2", "pge_1"] },
- },
+ }),
+ take: 25,
+ skip: 0,
+ orderBy: { totalSaleAmount: "desc" },
}),
);
- expect(partners.map(({ id }) => id)).toEqual(["pn_2", "pn_1"]);
+ expect(partners.map(({ id }) => id)).toEqual(["pn_1", "pn_2"]);
+ });
+
+ it("restores relevance order before slicing a page", async () => {
+ mocks.findMany.mockResolvedValue([
+ enrollment("pge_3", "pn_3"),
+ enrollment("pge_1", "pn_1"),
+ ]);
+ const searchProvider = createSearchProvider([
+ { id: "pge_1", partnerId: "pn_1" },
+ { id: "pge_2", partnerId: "pn_2" },
+ { id: "pge_3", partnerId: "pn_3" },
+ ]);
+
+ const partners = await getPartners(
+ {
+ programId: "prog_test",
+ search: "examp",
+ page: 2,
+ pageSize: 1,
+ sortBy: "relevance",
+ sortOrder: "desc",
+ },
+ { searchProvider },
+ );
+
+ expect(mocks.findMany).toHaveBeenCalledWith(
+ expect.not.objectContaining({
+ take: expect.anything(),
+ skip: expect.anything(),
+ orderBy: expect.anything(),
+ }),
+ );
+ expect(partners.map(({ id }) => id)).toEqual(["pn_3"]);
});
it("propagates search provider errors", async () => {
- const searchProvider: PartnerSearchProvider = {
- searchCandidates: vi.fn(),
- search: vi
- .fn()
- .mockRejectedValue(new Error("Provider Connection Timeout")),
- count: vi.fn(),
- groupBy: vi.fn(),
- waitForIndexing: vi.fn(),
- upsert: vi.fn(),
- delete: vi.fn(),
- };
+ const searchProvider = createSearchProvider();
+ vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
+ new Error("Provider Connection Timeout"),
+ );
await expect(
getPartners(
diff --git a/apps/web/tests/partners/partner-search-query.test.ts b/apps/web/tests/partners/partner-search-query.test.ts
index c57ea4122e..61bd483072 100644
--- a/apps/web/tests/partners/partner-search-query.test.ts
+++ b/apps/web/tests/partners/partner-search-query.test.ts
@@ -1,4 +1,7 @@
-import { buildPartnerSearchQuery } from "@/lib/api/partners/search";
+import {
+ buildPartnerSearchCandidateQuery,
+ buildPartnerSearchQuery,
+} from "@/lib/api/partners/search";
import { describe, expect, it } from "vitest";
const defaultInput = {
@@ -11,6 +14,20 @@ const defaultInput = {
};
describe("buildPartnerSearchQuery", () => {
+ it("builds a provider-neutral relevance candidate request", () => {
+ expect(
+ buildPartnerSearchCandidateQuery({
+ ...defaultInput,
+ status: "approved",
+ country: ["CA"],
+ }),
+ ).toEqual({
+ programId: "prog_test",
+ query: "examp",
+ limit: 100,
+ });
+ });
+
it("maps API pagination, filters, ranges, and sorting", () => {
expect(
buildPartnerSearchQuery({
@@ -76,5 +93,6 @@ describe("buildPartnerSearchQuery", () => {
["tenant ID", { ...defaultInput, tenantId: "tenant_test" }],
])("keeps %s on the database path", (_name, input) => {
expect(buildPartnerSearchQuery(input)).toBeNull();
+ expect(buildPartnerSearchCandidateQuery(input)).toBeNull();
});
});