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.

Fallback to database querying when provider outage

Rafi59a939a62aab
diff --git a/apps/web/lib/api/partners/get-partners-count.ts b/apps/web/lib/api/partners/get-partners-count.ts
index 5c7ca34064..03a9d4546f 100644
--- a/apps/web/lib/api/partners/get-partners-count.ts
+++ b/apps/web/lib/api/partners/get-partners-count.ts
@@ -11,6 +11,7 @@ import {
} from "./program-enrollment-query";
import {
buildPartnerSearchCandidateQuery,
+ findPartnerSearchCandidates,
getPartnerSearchProvider,
PartnerSearchProvider,
} from "./search";
@@ -26,7 +27,11 @@ export async function getPartnersCount<T>(
filters: PartnersCountFilters,
{
searchProvider = getPartnerSearchProvider(),
- }: { searchProvider?: PartnerSearchProvider | null } = {},
+ throwOnSearchError = false,
+ }: {
+ searchProvider?: PartnerSearchProvider | null;
+ throwOnSearchError?: boolean;
+ } = {},
): Promise<T> {
const { groupBy, programId, ...enrollmentFilters } = filters;
const candidateQuery = searchProvider
@@ -34,7 +39,9 @@ export async function getPartnersCount<T>(
: null;
const candidateResult =
searchProvider && candidateQuery
- ? await searchProvider.searchCandidates(candidateQuery)
+ ? await findPartnerSearchCandidates(searchProvider, candidateQuery, {
+ throwOnError: throwOnSearchError,
+ })
: null;
const candidateIds = candidateResult?.hits.map(({ id }) => id);
const enrollmentBase = {
diff --git a/apps/web/lib/api/partners/get-partners.ts b/apps/web/lib/api/partners/get-partners.ts
index 83d5fc407b..43117e3f60 100644
--- a/apps/web/lib/api/partners/get-partners.ts
+++ b/apps/web/lib/api/partners/get-partners.ts
@@ -3,6 +3,7 @@ import { toCentsNumber } from "@dub/utils";
import { buildProgramEnrollmentWhereForList } from "./program-enrollment-query";
import {
buildPartnerSearchCandidateQuery,
+ findPartnerSearchCandidates,
getPartnerSearchProvider,
orderByPartnerSearchHits,
PartnerSearchProvider,
@@ -15,11 +16,15 @@ type PartnerFilters = PartnerSearchQueryInput & {
interface GetPartnersOptions {
searchProvider?: PartnerSearchProvider | null;
+ throwOnSearchError?: boolean;
}
export async function getPartners(
filters: PartnerFilters,
- { searchProvider = getPartnerSearchProvider() }: GetPartnersOptions = {},
+ {
+ searchProvider = getPartnerSearchProvider(),
+ throwOnSearchError = false,
+ }: GetPartnersOptions = {},
) {
const {
page = 1,
@@ -37,7 +42,9 @@ export async function getPartners(
: null;
const candidateResult =
searchProvider && candidateQuery
- ? await searchProvider.searchCandidates(candidateQuery)
+ ? await findPartnerSearchCandidates(searchProvider, candidateQuery, {
+ throwOnError: throwOnSearchError,
+ })
: null;
const databaseSortBy = sortBy === "relevance" ? "totalSaleAmount" : sortBy;
const relevanceHits =
diff --git a/apps/web/lib/api/partners/search/find-candidates.ts b/apps/web/lib/api/partners/search/find-candidates.ts
new file mode 100644
index 0000000000..10ae038865
--- /dev/null
+++ b/apps/web/lib/api/partners/search/find-candidates.ts
@@ -0,0 +1,40 @@
+import type {
+ PartnerSearchCandidateQuery,
+ PartnerSearchProvider,
+ PartnerSearchResult,
+} from "./types";
+
+interface FindPartnerSearchCandidatesOptions {
+ /**
+ * Surface provider failures instead of degrading. The benchmark needs this so
+ * a broken provider cannot be reported as a fast, error-free run.
+ */
+ throwOnError?: boolean;
+}
+
+/**
+ * Resolves relevance candidates, falling back to the database search path when
+ * the provider fails. Returning null here is what the callers already do when
+ * no provider is configured, so a provider outage costs relevance ranking and
+ * the wider field coverage rather than the entire partners list.
+ */
+export async function findPartnerSearchCandidates(
+ searchProvider: PartnerSearchProvider,
+ query: PartnerSearchCandidateQuery,
+ { throwOnError = false }: FindPartnerSearchCandidatesOptions = {},
+): Promise<PartnerSearchResult | null> {
+ try {
+ return await searchProvider.searchCandidates(query);
+ } catch (error) {
+ if (throwOnError) {
+ throw error;
+ }
+
+ console.error(
+ "[Partner Search] Candidate lookup failed, falling back to the database search path.",
+ error,
+ );
+
+ return null;
+ }
+}
diff --git a/apps/web/lib/api/partners/search/index.ts b/apps/web/lib/api/partners/search/index.ts
index 171cd56859..1291ae42dc 100644
--- a/apps/web/lib/api/partners/search/index.ts
+++ b/apps/web/lib/api/partners/search/index.ts
@@ -1,5 +1,6 @@
export * from "./backfill";
export * from "./build-search-query";
+export * from "./find-candidates";
export * from "./order-search-results";
export * from "./provider";
export * from "./providers/upstash-redis";
diff --git a/apps/web/scripts/dev/benchmark-partner-search.ts b/apps/web/scripts/dev/benchmark-partner-search.ts
index 9bd3971090..c3b634a3d0 100644
--- a/apps/web/scripts/dev/benchmark-partner-search.ts
+++ b/apps/web/scripts/dev/benchmark-partner-search.ts
@@ -402,7 +402,12 @@ async function main() {
const startedAt = performance.now();
try {
- const partners = await getPartners(filters, { searchProvider });
+ // Opt out of the database fallback: a provider failure has to surface as
+ // an error here, not as a fast run measuring the wrong code path.
+ const partners = await getPartners(filters, {
+ searchProvider,
+ throwOnSearchError: true,
+ });
if (partners.length === 0) {
throw new Error(
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 1af823cb3c..6de9b926ac 100644
--- a/apps/web/tests/partners/get-partners-count-search.test.ts
+++ b/apps/web/tests/partners/get-partners-count-search.test.ts
@@ -219,7 +219,28 @@ describe("getPartnersCount search", () => {
expect(JSON.stringify(where)).toContain('"search":"examp"');
});
- it("propagates search provider errors", async () => {
+ it("falls back to the database search path when the provider fails", async () => {
+ const searchProvider = createSearchProvider();
+ vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
+ new Error("Provider Connection Timeout"),
+ );
+ vi.spyOn(console, "error").mockImplementation(() => {});
+ mocks.count.mockResolvedValue(7);
+
+ const count = await getPartnersCount<number>(
+ { programId: "prog_test", search: "examp" },
+ { searchProvider },
+ );
+
+ expect(count).toBe(7);
+
+ const { where } = mocks.count.mock.calls.at(-1)![0];
+ expect(where.id).toBeUndefined();
+ expect(JSON.stringify(where)).toContain('"search":"examp"');
+ vi.mocked(console.error).mockRestore();
+ });
+
+ it("surfaces provider errors when the caller opts out of the fallback", async () => {
const searchProvider = createSearchProvider();
vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
new Error("Provider Connection Timeout"),
@@ -228,7 +249,7 @@ describe("getPartnersCount search", () => {
await expect(
getPartnersCount<number>(
{ programId: "prog_test", search: "examp" },
- { searchProvider },
+ { searchProvider, throwOnSearchError: true },
),
).rejects.toThrow("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 05d5be9e50..d1d87f0822 100644
--- a/apps/web/tests/partners/get-partners-search.test.ts
+++ b/apps/web/tests/partners/get-partners-search.test.ts
@@ -155,7 +155,36 @@ describe("getPartners search", () => {
expect(partners.map(({ id }) => id)).toEqual(["pn_3"]);
});
- it("propagates search provider errors", async () => {
+ it("falls back to the database search path when the provider fails", async () => {
+ const searchProvider = createSearchProvider();
+ vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
+ new Error("Provider Connection Timeout"),
+ );
+ vi.spyOn(console, "error").mockImplementation(() => {});
+ mocks.findMany.mockResolvedValue([enrollment("pge_1", "pn_1")]);
+
+ const partners = await getPartners(
+ {
+ programId: "prog_test",
+ search: "examp",
+ page: 1,
+ pageSize: 25,
+ sortBy: "totalSaleAmount",
+ sortOrder: "desc",
+ },
+ { searchProvider },
+ );
+
+ expect(partners).toHaveLength(1);
+
+ // The database keeps its own search predicate and no candidate filter.
+ const { where } = mocks.findMany.mock.calls.at(-1)![0];
+ expect(where.id).toBeUndefined();
+ expect(JSON.stringify(where)).toContain('"search":"examp"');
+ vi.mocked(console.error).mockRestore();
+ });
+
+ it("surfaces provider errors when the caller opts out of the fallback", async () => {
const searchProvider = createSearchProvider();
vi.mocked(searchProvider.searchCandidates).mockRejectedValue(
new Error("Provider Connection Timeout"),
@@ -171,11 +200,9 @@ describe("getPartners search", () => {
sortBy: "totalSaleAmount",
sortOrder: "desc",
},
- { searchProvider },
+ { searchProvider, throwOnSearchError: true },
),
).rejects.toThrow("Provider Connection Timeout");
-
- expect(mocks.findMany).not.toHaveBeenCalled();
});
it("uses the existing database sort when relevance has no provider", async () => {