Spaces:
Sleeping
Sleeping
File size: 5,503 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 | import { Response } from "express";
import { config } from "../../config";
import { v7 as uuidv7 } from "uuid";
import {
CrawlRequest,
crawlRequestSchema,
CrawlResponse,
RequestWithAuth,
toLegacyCrawlerOptions,
} from "./types";
import {
crawlToCrawler,
saveCrawl,
StoredCrawl,
markCrawlActive,
} from "../../lib/crawl-redis";
import { _addScrapeJobToBullMQ } from "../../services/queue-jobs";
import { logger as _logger } from "../../lib/logger";
import { fromV1ScrapeOptions } from "../v2/types";
import { checkPermissions } from "../../lib/permissions";
import { crawlGroup } from "../../services/worker/nuq";
import { logRequest } from "../../services/logging/log_job";
import { getScrapeZDR } from "../../lib/zdr-helpers";
export async function crawlController(
req: RequestWithAuth<{}, CrawlResponse, CrawlRequest>,
res: Response<CrawlResponse>,
) {
const preNormalizedBody = req.body;
req.body = crawlRequestSchema.parse(req.body);
const permissions = checkPermissions(
{ ...req.body, crawlerOptions: req.body },
req.acuc?.flags,
);
if (permissions.error) {
return res.status(403).json({
success: false,
error: permissions.error,
});
}
const zeroDataRetention =
getScrapeZDR(req.acuc?.flags) === "forced" || req.body.zeroDataRetention;
const id = uuidv7();
const logger = _logger.child({
crawlId: id,
module: "api/v1",
method: "crawlController",
teamId: req.auth.team_id,
zeroDataRetention,
});
logger.debug("Crawl " + id + " starting", {
request: req.body,
originalRequest: preNormalizedBody,
account: req.account,
});
await logRequest({
id,
kind: "crawl",
api_version: "v1",
team_id: req.auth.team_id,
origin: req.body.origin ?? "api",
integration: req.body.integration,
target_hint: req.body.url,
zeroDataRetention: zeroDataRetention || false,
api_key_id: req.acuc?.api_key_id ?? null,
});
let { remainingCredits } = req.account!;
const useDbAuthentication = config.USE_DB_AUTHENTICATION;
if (!useDbAuthentication) {
remainingCredits = Infinity;
}
const crawlerOptions = {
...req.body,
url: undefined,
scrapeOptions: undefined,
};
const bodyScrapeOptions =
req.body.scrapeOptions ?? ({} as typeof req.body.scrapeOptions);
const { scrapeOptions, internalOptions } = fromV1ScrapeOptions(
bodyScrapeOptions,
bodyScrapeOptions.timeout,
req.auth.team_id,
);
// TODO: @rafa, is this right? copied from v0
if (Array.isArray(crawlerOptions.includePaths)) {
for (const x of crawlerOptions.includePaths) {
try {
new RegExp(x);
} catch (e) {
return res.status(400).json({ success: false, error: e.message });
}
}
}
if (Array.isArray(crawlerOptions.excludePaths)) {
for (const x of crawlerOptions.excludePaths) {
try {
new RegExp(x);
} catch (e) {
return res.status(400).json({ success: false, error: e.message });
}
}
}
const originalLimit = crawlerOptions.limit;
crawlerOptions.limit = Math.min(remainingCredits, crawlerOptions.limit);
logger.debug("Determined limit: " + crawlerOptions.limit, {
remainingCredits,
bodyLimit: originalLimit,
originalBodyLimit: preNormalizedBody.limit,
});
const sc: StoredCrawl = {
originUrl: req.body.url,
crawlerOptions: toLegacyCrawlerOptions(crawlerOptions),
scrapeOptions,
internalOptions: {
...internalOptions,
disableSmartWaitCache: true,
teamId: req.auth.team_id,
saveScrapeResultToGCS: config.GCS_FIRE_ENGINE_BUCKET_NAME ? true : false,
zeroDataRetention,
agentIndexOnly: (req as any).agentIndexOnly ?? false,
}, // NOTE: smart wait disabled for crawls to ensure contentful scrape, speed does not matter
team_id: req.auth.team_id,
createdAt: Date.now(),
maxConcurrency:
req.body.maxConcurrency !== undefined
? req.acuc?.concurrency !== undefined
? Math.min(req.body.maxConcurrency, req.acuc.concurrency)
: req.body.maxConcurrency
: undefined,
zeroDataRetention,
};
const crawler = crawlToCrawler(id, sc, req.acuc?.flags ?? null);
try {
sc.robots = await crawler.getRobotsTxt(scrapeOptions.skipTlsVerification);
// const robotsCrawlDelay = crawler.getRobotsCrawlDelay();
// if (robotsCrawlDelay !== null && !sc.crawlerOptions.delay) {
// sc.crawlerOptions.delay = robotsCrawlDelay;
// }
} catch (e) {
logger.debug("Failed to get robots.txt (this is probably fine!)", {
error: e,
});
}
await crawlGroup.addGroup(
id,
sc.team_id,
(req.acuc?.flags?.crawlTtlHours ?? 24) * 60 * 60 * 1000,
);
await saveCrawl(id, sc);
await markCrawlActive(id);
await _addScrapeJobToBullMQ(
{
mode: "kickoff" as const,
url: req.body.url,
team_id: req.auth.team_id,
crawlerOptions,
scrapeOptions: sc.scrapeOptions,
internalOptions: sc.internalOptions,
origin: req.body.origin,
integration: req.body.integration,
billing: { endpoint: "crawl", jobId: id },
crawl_id: id,
webhook: req.body.webhook,
v1: true,
zeroDataRetention: zeroDataRetention || false,
apiKeyId: req.acuc?.api_key_id ?? null,
},
uuidv7(),
);
const protocol = req.protocol;
return res.status(200).json({
success: true,
id,
url: `${protocol}://${req.get("host")}/v1/crawl/${id}`,
});
}
|