Merge pull request firecrawl#3688 from firecrawl/nick/search-zdr-forced

fix(api): allow search for teams with searchZDR forced

Author: Chadha93

apps/api/src/__tests__/snips/v2/zdr.test.ts

@@ -6,6 +6,7 @@ import {
   scrapeStatusRaw,
   zdrcleaner,
   idmux,
+  searchRaw,
 } from "./lib";
 import { describeIf, TEST_PRODUCTION } from "../lib";
 import {
@@ -148,4 +149,20 @@ describeIf(TEST_PRODUCTION)("Zero Data Retention", () => {
       600000 + 20000,
     );
   });
+
+  it("should allow search when searchZDR is forced", async () => {
+    const identity = await idmux({
+      name: "zdr/search-forced",
+      credits: 10000,
+      flags: { searchZDR: "forced" },
+    });
+
+    const response = await searchRaw(
+      { query: "firecrawl", limit: 1 },
+      identity,
+    );
+
+    expect(response.statusCode).toBe(200);
+    expect(response.body.success).toBe(true);
+  }, 60000);
 });

apps/api/src/controllers/v0/search.ts

@@ -186,7 +186,8 @@ export async function searchController(req: Request, res: Response) {
     }
     const { team_id, chunk } = auth;
 
-    if (getSearchZDR(chunk?.flags) === "forced") {
+    const v0SearchZDRMode = getSearchZDR(chunk?.flags);
+    if (v0SearchZDRMode === "forced-zdr" || v0SearchZDRMode === "forced-anon") {
       return res.status(400).json({
         error:
           "Your team has zero data retention enabled. This is not supported on the v0 API. Please update your code to use the v1 API.",

apps/api/src/controllers/v1/search.ts

@@ -26,7 +26,7 @@ import {
   filterDocumentsWithContent,
 } from "../../search/transform";
 import { fromV1ScrapeOptions } from "../v2/types";
-import { getSearchZDR } from "../../lib/zdr-helpers";
+import { getSearchForcedKind } from "../../lib/zdr-helpers";
 
 // Used for deep research
 export async function searchAndScrapeSearchResult(
@@ -86,23 +86,19 @@ export async function searchController(
   const controllerStartTime = new Date().getTime();
 
   const jobId = uuidv7();
+  const teamForcedKind = getSearchForcedKind(req.acuc?.flags);
+  const zeroDataRetention = teamForcedKind !== null;
+  const teamEnterprise = teamForcedKind ? [teamForcedKind] : undefined;
   let logger = _logger.child({
     jobId,
     teamId: req.auth.team_id,
     module: "search",
     method: "searchController",
-    zeroDataRetention: getSearchZDR(req.acuc?.flags) === "forced",
+    zeroDataRetention,
+    teamForcedKind,
     searchQuery: req.body.query.slice(0, 100),
   });
 
-  if (getSearchZDR(req.acuc?.flags) === "forced") {
-    return res.status(400).json({
-      success: false,
-      error:
-        "Your team has zero data retention enabled. This is not supported on search. Please contact support@firecrawl.com to unblock this feature.",
-    });
-  }
-
   let responseData: SearchResponse = {
     success: true,
     data: [],
@@ -130,7 +126,7 @@ export async function searchController(
       origin: req.body.origin ?? "api",
       integration: req.body.integration,
       target_hint: req.body.query,
-      zeroDataRetention: false,
+      zeroDataRetention,
       api_key_id: req.acuc?.api_key_id ?? null,
     });
 
@@ -159,6 +155,7 @@ export async function searchController(
         sources: [{ type: "web" }], // v1 only supports web
         scrapeOptions: shouldScrape ? scrapeOptions : undefined,
         timeout: req.body.timeout,
+        enterprise: teamEnterprise,
       },
       {
         teamId: req.auth.team_id,
@@ -169,7 +166,7 @@ export async function searchController(
         jobId,
         apiVersion: "v1",
         bypassBilling: false,
-        zeroDataRetention: false,
+        zeroDataRetention,
         agentIndexOnly: (req as any).agentIndexOnly ?? false,
       },
       logger,
@@ -235,7 +232,7 @@ export async function searchController(
           scrapeOptions: undefined,
         },
         credits_cost: result.searchCredits,
-        zeroDataRetention: false,
+        zeroDataRetention,
       },
       false,
     );
@@ -276,7 +273,7 @@ export async function searchController(
     }
 
     captureExceptionWithZdrCheck(error, {
-      extra: { zeroDataRetention: false },
+      extra: { zeroDataRetention },
     });
     logger.error("Unhandled error occurred in search", {
       version: "v1",

apps/api/src/controllers/v1/types.ts

@@ -1290,7 +1290,7 @@ export type TeamFlags = {
   forceZDR?: boolean;
   allowZDR?: boolean;
   scrapeZDR?: "disabled" | "allowed" | "forced";
-  searchZDR?: "disabled" | "allowed" | "forced";
+  searchZDR?: "disabled" | "allowed" | "forced" | "forced-zdr" | "forced-anon";
   zdrCost?: number;
   checkRobotsOnScrape?: boolean;
   crawlTtlHours?: number;

apps/api/src/controllers/v1/x402-search.ts

@@ -27,7 +27,7 @@ import {
   captureExceptionWithZdrCheck,
 } from "../../services/sentry";
 import { getJobPriority } from "../../lib/job-priority";
-import { getSearchZDR } from "../../lib/zdr-helpers";
+import { getSearchForcedKind } from "../../lib/zdr-helpers";
 
 interface DocumentWithCostTracking {
   document: Document;
@@ -52,7 +52,7 @@ async function scrapeX402SearchResult(
 
   const costTracking = new CostTracking();
 
-  const zeroDataRetention = getSearchZDR(flags) === "forced";
+  const zeroDataRetention = getSearchForcedKind(flags) !== null;
   applyZdrScope(zeroDataRetention);
 
   try {
@@ -186,22 +186,17 @@ export async function x402SearchController(
   res: Response<SearchResponse & { request?: any }>,
 ) {
   const jobId = uuidv7();
+  const teamForcedKind = getSearchForcedKind(req.acuc?.flags);
+  const zeroDataRetention = teamForcedKind !== null;
   let logger = _logger.child({
     jobId,
     teamId: req.auth.team_id,
     module: "x402-search",
     method: "x402SearchController",
-    zeroDataRetention: getSearchZDR(req.acuc?.flags) === "forced",
+    zeroDataRetention,
+    teamForcedKind,
   });
 
-  if (getSearchZDR(req.acuc?.flags) === "forced") {
-    return res.status(400).json({
-      success: false,
-      error:
-        "Your team has zero data retention enabled. This is not supported on x402/search. Please contact support@firecrawl.com to unblock this feature.",
-    });
-  }
-
   let responseData: SearchResponse = {
     success: true,
     data: [],
@@ -234,7 +229,7 @@ export async function x402SearchController(
       origin: req.body.origin ?? "api",
       integration: req.body.integration,
       target_hint: req.body.query,
-      zeroDataRetention: false, // not supported for x402 search
+      zeroDataRetention,
       api_key_id: req.acuc?.api_key_id ?? null,
     });
 
@@ -351,7 +346,7 @@ export async function x402SearchController(
         team_id: req.auth.team_id,
         options: { ...req.body, scrapeOptions: undefined, query: undefined },
         credits_cost: responseData.data.length,
-        zeroDataRetention: false, // not supported
+        zeroDataRetention,
       },
       false,
     );
@@ -367,7 +362,7 @@ export async function x402SearchController(
     }
 
     captureExceptionWithZdrCheck(error, {
-      extra: { zeroDataRetention: false },
+      extra: { zeroDataRetention },
     });
     logger.error("Unhandled error occurred in search [x402]", { error });
     return res.status(500).json({

apps/api/src/controllers/v2/search.ts

@@ -19,7 +19,7 @@ import {
 } from "../../services/sentry";
 import { executeSearch } from "../../search/execute";
 import type { BillingMetadata } from "../../services/billing/types";
-import { getSearchZDR } from "../../lib/zdr-helpers";
+import { getSearchForcedKind, getSearchZDR } from "../../lib/zdr-helpers";
 
 export async function searchController(
   req: RequestWithAuth<{}, SearchResponse, SearchRequest>,
@@ -30,28 +30,23 @@ export async function searchController(
   const controllerStartTime = new Date().getTime();
 
   const jobId = uuidv7();
+  const searchZDRMode = getSearchZDR(req.acuc?.flags);
+  const teamForcedKind = getSearchForcedKind(req.acuc?.flags);
   let logger = _logger.child({
     jobId,
     teamId: req.auth.team_id,
     module: "api/v2",
     method: "searchController",
-    zeroDataRetention: getSearchZDR(req.acuc?.flags) === "forced",
+    zeroDataRetention: teamForcedKind !== null,
+    teamForcedKind,
   });
 
-  if (getSearchZDR(req.acuc?.flags) === "forced") {
-    return res.status(400).json({
-      success: false,
-      error:
-        "Your team has zero data retention enabled. This is not supported on search. Please contact support@firecrawl.com to unblock this feature.",
-    });
-  }
-
   const middlewareTime = controllerStartTime - middlewareStartTime;
   const isSearchPreview =
     config.SEARCH_PREVIEW_TOKEN !== undefined &&
     config.SEARCH_PREVIEW_TOKEN === req.body.__searchPreviewToken;
 
-  let zeroDataRetention = false;
+  let zeroDataRetention = teamForcedKind !== null;
 
   try {
     req.body = searchRequestSchema.parse(req.body);
@@ -84,16 +79,25 @@ export async function searchController(
       origin: req.body.origin,
     });
 
+    // Inject the team-forced enterprise mode so downstream billing,
+    // upstream routing, and ZDR cleanup all see it.
+    if (teamForcedKind) {
+      const existing = req.body.enterprise ?? [];
+      if (!existing.includes(teamForcedKind)) {
+        req.body.enterprise = [...existing, teamForcedKind];
+      }
+    }
+
     const isZDR = req.body.enterprise?.includes("zdr");
     const isAnon = req.body.enterprise?.includes("anon");
     const isZDROrAnon = isZDR || isAnon;
     zeroDataRetention = isZDROrAnon ?? false;
-    applyZdrScope(isZDROrAnon ?? false);
+    logger = logger.child({ zeroDataRetention });
+    applyZdrScope(zeroDataRetention);
 
     // Verify the team has searchZDR enabled before allowing enterprise ZDR/anon
-    if (isZDROrAnon) {
-      const searchMode = getSearchZDR(req.acuc?.flags);
-      if (searchMode !== "allowed" && searchMode !== "forced") {
+    if (isZDROrAnon && !teamForcedKind) {
+      if (searchZDRMode !== "allowed") {
         return res.status(403).json({
           success: false,
           error:
@@ -111,7 +115,7 @@ export async function searchController(
         origin: req.body.origin ?? "api",
         integration: req.body.integration,
         target_hint: req.body.query,
-        zeroDataRetention: isZDROrAnon ?? false,
+        zeroDataRetention,
         api_key_id: req.acuc?.api_key_id ?? null,
       });
     }
@@ -142,7 +146,7 @@ export async function searchController(
         jobId,
         apiVersion: "v2",
         bypassBilling: !shouldBill,
-        zeroDataRetention: isZDROrAnon,
+        zeroDataRetention,
         billing,
         agentIndexOnly: (req as any).agentIndexOnly ?? false,
       },
@@ -180,7 +184,7 @@ export async function searchController(
         team_id: req.auth.team_id,
         options: req.body,
         credits_cost: shouldBill ? result.searchCredits : 0,
-        zeroDataRetention: isZDROrAnon ?? false,
+        zeroDataRetention,
       },
       false,
     );

apps/api/src/controllers/v2/types.ts

@@ -1513,7 +1513,7 @@ export type TeamFlags = {
   forceZDR?: boolean;
   allowZDR?: boolean;
   scrapeZDR?: "disabled" | "allowed" | "forced";
-  searchZDR?: "disabled" | "allowed" | "forced";
+  searchZDR?: "disabled" | "allowed" | "forced" | "forced-zdr" | "forced-anon";
   zdrCost?: number;
   checkRobotsOnScrape?: boolean;
   crawlTtlHours?: number;