Spaces:
Sleeping
Sleeping
File size: 7,469 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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 | import { Response } from "express";
import {
mapRequestSchema,
RequestWithAuth,
MapRequest,
MapResponse,
} from "./types";
import { configDotenv } from "dotenv";
import { billTeam } from "../../services/billing/credit_billing";
import { logMap, logRequest } from "../../services/logging/log_job";
import { logger as _logger } from "../../lib/logger";
import { MapTimeoutError, MapFailedError } from "../../lib/error";
import { checkPermissions } from "../../lib/permissions";
import { getMapResults, MapResult } from "../../lib/map-utils";
import { v7 as uuidv7 } from "uuid";
import { isBaseDomain, extractBaseDomain } from "../../lib/url-utils";
import { getScrapeZDR } from "../../lib/zdr-helpers";
import { resolveViaAvgrab } from "../../lib/avgrab-resolve";
configDotenv();
export async function mapController(
req: RequestWithAuth<{}, MapResponse, MapRequest>,
res: Response<MapResponse>,
) {
const logger = _logger.child({
jobId: uuidv7(),
teamId: req.auth.team_id,
module: "api/v2",
method: "mapController",
zeroDataRetention: getScrapeZDR(req.acuc?.flags) === "forced",
});
// Get timing data from middleware (includes all middleware processing time)
const middlewareStartTime =
(req as any).requestTiming?.startTime || new Date().getTime();
const controllerStartTime = new Date().getTime();
const originalRequest = req.body;
req.body = mapRequestSchema.parse(req.body);
const permissions = checkPermissions(req.body, req.acuc?.flags);
if (permissions.error) {
return res.status(403).json({
success: false,
error: permissions.error,
});
}
const middlewareTime = controllerStartTime - middlewareStartTime;
const mapId = uuidv7();
logger.info("Map request", {
request: req.body,
originalRequest,
teamId: req.auth.team_id,
mapId,
});
await logRequest({
id: mapId,
kind: "map",
api_version: "v2",
team_id: req.auth.team_id,
origin: req.body.origin ?? "api",
integration: req.body.integration,
target_hint: req.body.url,
zeroDataRetention: false, // not supported for map
api_key_id: req.acuc?.api_key_id ?? null,
});
// Short-circuit: if the URL matches avgrab's resolve pattern, delegate entirely
try {
const avgrabResults = await resolveViaAvgrab(
req.body.url,
req.body.limit,
logger,
);
if (avgrabResults !== null) {
const creditsCost = avgrabResults.length;
billTeam(
req.auth.team_id,
req.acuc?.sub_id ?? undefined,
creditsCost,
req.acuc?.api_key_id ?? null,
{ endpoint: "map", jobId: mapId },
).catch(error => {
logger.error(
`Failed to bill team ${req.auth.team_id} for ${creditsCost} credits: ${error}`,
);
});
logMap({
id: mapId,
request_id: mapId,
url: req.body.url,
team_id: req.auth.team_id,
options: {
search: req.body.search,
sitemap: req.body.sitemap,
includeSubdomains: req.body.includeSubdomains,
ignoreQueryParameters: req.body.ignoreQueryParameters,
limit: req.body.limit,
timeout: req.body.timeout,
location: req.body.location,
},
results: avgrabResults,
credits_cost: creditsCost,
zeroDataRetention: false,
}).catch(error => {
logger.error(
`Failed to log job for team ${req.auth.team_id}: ${error}`,
);
});
return res.status(200).json({
success: true,
links: avgrabResults,
});
}
} catch (error) {
if (error instanceof MapFailedError) {
return res.status(500).json({
success: false,
error: error.message,
});
}
logger.warn("avgrab resolve failed, falling back to standard map", {
error,
});
}
let result: MapResult;
let timeoutHandle: NodeJS.Timeout | null = null;
const abort = new AbortController();
try {
result = (await Promise.race([
getMapResults({
url: req.body.url,
search: req.body.search,
limit: req.body.limit,
includeSubdomains: req.body.includeSubdomains,
crawlerOptions: {
...req.body,
sitemap: req.body.sitemap,
},
origin: req.body.origin,
teamId: req.auth.team_id,
allowExternalLinks: req.body.allowExternalLinks,
abort: abort.signal,
mock: req.body.useMock,
filterByPath: req.body.filterByPath !== false,
flags: req.acuc?.flags ?? null,
useIndex: req.body.useIndex,
ignoreCache: req.body.ignoreCache,
location: req.body.location,
headers: req.body.headers,
id: mapId,
}),
...(req.body.timeout !== undefined
? [
new Promise(
(_resolve, reject) =>
(timeoutHandle = setTimeout(() => {
abort.abort(new MapTimeoutError());
reject(new MapTimeoutError());
}, req.body.timeout)),
),
]
: []),
])) as any;
} catch (error) {
if (error instanceof MapTimeoutError) {
return res.status(408).json({
success: false,
code: error.code,
error: error.message,
});
} else {
throw error;
}
} finally {
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
}
// Bill the team
billTeam(
req.auth.team_id,
req.acuc?.sub_id ?? undefined,
1,
req.acuc?.api_key_id ?? null,
{ endpoint: "map", jobId: mapId },
).catch(error => {
logger.error(
`Failed to bill team ${req.auth.team_id} for 1 credit: ${error}`,
);
});
logMap({
id: result.job_id,
request_id: result.job_id,
url: req.body.url,
team_id: req.auth.team_id,
options: {
search: req.body.search,
sitemap: req.body.sitemap,
includeSubdomains: req.body.includeSubdomains,
ignoreQueryParameters: req.body.ignoreQueryParameters,
limit: req.body.limit,
timeout: req.body.timeout,
location: req.body.location,
},
results: result.mapResults,
credits_cost: 1,
zeroDataRetention: false, // not supported
}).catch(error => {
logger.error(`Failed to log job for team ${req.auth.team_id}: ${error}`);
});
// Log final timing information
const totalRequestTime = new Date().getTime() - middlewareStartTime;
const controllerTime = new Date().getTime() - controllerStartTime;
logger.info("Request metrics", {
version: "v2",
jobId: result.job_id,
mode: "map",
middlewareStartTime,
controllerStartTime,
middlewareTime,
controllerTime,
totalRequestTime,
linksCount: result.mapResults.length,
});
// Check if we should warn about base domain
let warning: string | undefined;
// Only show warning if results <= 1 AND user didn't explicitly request limit=1 AND URL is not base domain
if (
result.mapResults.length <= 1 &&
req.body.limit !== 1 &&
!isBaseDomain(req.body.url)
) {
const baseDomain = extractBaseDomain(req.body.url);
if (baseDomain) {
warning = `Only ${result.mapResults.length} result(s) found. For broader coverage, try mapping the base domain: ${baseDomain}`;
}
}
const response = {
success: true as const,
links: result.mapResults,
...(warning && { warning }),
};
return res.status(200).json(response);
}
|