Spaces:
Sleeping
Sleeping
File size: 6,377 Bytes
097eaf0 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | import { v7 as uuidv7 } from "uuid";
import { Request, Response } from "express";
import {
RequestWithAuth,
ExtractRequest,
extractRequestSchema,
ExtractResponse,
} from "./types";
import { addExtractJobToQueue } from "../../services/queue-service";
import { saveExtract } from "../../lib/extract/extract-redis";
import { getTeamIdSyncB } from "../../lib/extract/team-id-sync";
import { ExtractResult } from "../../lib/extract/extraction-service";
import { performExtraction_F0 } from "../../lib/extract/fire-0/extraction-service-f0";
import { UNSUPPORTED_SITE_MESSAGE } from "../../lib/strings";
import { isUrlBlocked } from "../../scraper/WebScraper/utils/blocklist";
import { logger as _logger } from "../../lib/logger";
import {
fromV1ScrapeOptions,
ExtractRequest as V2ExtractRequest,
} from "../v2/types";
import { createWebhookSender, WebhookEvent } from "../../services/webhook";
import { logRequest } from "../../services/logging/log_job";
import { getScrapeZDR } from "../../lib/zdr-helpers";
import { config } from "../../config";
async function oldExtract(
req: RequestWithAuth<{}, ExtractResponse, ExtractRequest>,
res: Response<ExtractResponse>,
extractId: string,
) {
// Means that are in the non-queue system
// TODO: Remove this once all teams have transitioned to the new system
const sender = await createWebhookSender({
teamId: req.auth.team_id,
jobId: extractId,
webhook: req.body.webhook,
v0: false,
});
sender?.send(WebhookEvent.EXTRACT_STARTED, { success: true });
try {
// Convert v1 scrapeOptions to v2 format
const scrapeOptions = req.body.scrapeOptions
? fromV1ScrapeOptions(
req.body.scrapeOptions,
req.body.scrapeOptions.timeout,
req.auth.team_id,
).scrapeOptions
: undefined;
// Create request with converted scrapeOptions (v2 format)
const request: V2ExtractRequest = {
...req.body,
scrapeOptions,
} as V2ExtractRequest;
let result: ExtractResult;
result = await performExtraction_F0(extractId, {
request,
teamId: req.auth.team_id,
subId: req.acuc?.sub_id ?? undefined,
apiKeyId: req.acuc?.api_key_id ?? null,
});
if (sender) {
if (result.success) {
sender.send(WebhookEvent.EXTRACT_COMPLETED, {
success: true,
data: [result],
});
} else {
sender.send(WebhookEvent.EXTRACT_FAILED, {
success: false,
error: result.error ?? "Unknown error",
});
}
}
return res.status(200).json(result);
} catch (error) {
sender?.send(WebhookEvent.EXTRACT_FAILED, {
success: false,
error: error instanceof Error ? error.message : "Unknown error",
});
return res.status(500).json({
success: false,
error: error instanceof Error ? error.message : "Unknown error",
});
}
}
/**
* Extracts data from the provided URLs based on the request parameters.
* Currently in beta.
* @param req - The request object containing authentication and extraction details.
* @param res - The response object to send the extraction results.
* @returns A promise that resolves when the extraction process is complete.
*/
export async function extractController(
req: RequestWithAuth<{}, ExtractResponse, ExtractRequest>,
res: Response<ExtractResponse>,
) {
const selfHosted = config.USE_DB_AUTHENTICATION !== true;
const originalRequest = { ...req.body };
req.body = extractRequestSchema.parse(req.body);
if (getScrapeZDR(req.acuc?.flags) === "forced") {
return res.status(400).json({
success: false,
error:
"Your team has zero data retention enabled. This is not supported on extract. Please contact support@firecrawl.com to unblock this feature.",
});
}
const invalidURLs: string[] =
req.body.urls?.filter((url: string) =>
isUrlBlocked(url, req.acuc?.flags ?? null, {
team_id: req.auth.team_id,
origin: req.body.origin ?? null,
}),
) ?? [];
const createdAt = Date.now();
if (invalidURLs.length > 0 && !req.body.ignoreInvalidURLs) {
if (!res.headersSent) {
return res.status(403).json({
success: false,
error: UNSUPPORTED_SITE_MESSAGE,
});
}
}
const extractId = uuidv7();
_logger.info("Extract starting...", {
request: req.body,
originalRequest,
teamId: req.auth.team_id,
team_id: req.auth.team_id,
subId: req.acuc?.sub_id,
extractId,
zeroDataRetention: getScrapeZDR(req.acuc?.flags) === "forced",
});
await logRequest({
id: extractId,
kind: "extract",
api_version: "v1",
team_id: req.auth.team_id,
origin: req.body.origin ?? "api",
integration: req.body.integration,
target_hint: req.body.urls?.[0] ?? "",
zeroDataRetention: false, // not supported for extract
api_key_id: req.acuc?.api_key_id ?? null,
});
const scrapeOptions = req.body.scrapeOptions
? fromV1ScrapeOptions(
req.body.scrapeOptions,
req.body.scrapeOptions.timeout,
req.auth.team_id,
).scrapeOptions
: undefined;
const jobData = {
request: {
...req.body,
scrapeOptions,
},
teamId: req.auth.team_id,
subId: req.acuc?.sub_id,
extractId,
agent: req.body.agent,
apiKeyId: req.acuc?.api_key_id ?? null,
createdAt,
};
if (
(await getTeamIdSyncB(req.auth.team_id)) &&
req.body.origin !== "api-sdk" &&
req.body.origin !== "website" &&
!req.body.origin.startsWith("python-sdk@") &&
!req.body.origin.startsWith("js-sdk@")
) {
return await oldExtract(req, res, extractId);
}
await saveExtract(extractId, {
id: extractId,
team_id: req.auth.team_id,
createdAt,
status: "processing",
showSteps: req.body.__experimental_streamSteps,
showLLMUsage: req.body.__experimental_llmUsage,
showSources: req.body.__experimental_showSources || req.body.showSources,
showCostTracking: req.body.__experimental_showCostTracking,
zeroDataRetention: getScrapeZDR(req.acuc?.flags) === "forced",
});
await addExtractJobToQueue(extractId, jobData);
return res.status(200).json({
success: true,
id: extractId,
urlTrace: [],
...(invalidURLs.length > 0 && req.body.ignoreInvalidURLs
? {
invalidURLs,
}
: {}),
});
}
|