Spaces:
Sleeping
Sleeping
File size: 35,190 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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 | import { AxiosError } from "axios";
import { config } from "../../config";
import { load } from "cheerio"; // rustified
import { URL } from "url";
import { getLinksFromSitemap } from "./sitemap";
import robotsParser, { Robot } from "robots-parser";
import { getURLDepth } from "./utils/maxDepthUtils";
import { logger as _logger } from "../../lib/logger";
import { redisEvictConnection } from "../../services/redis";
import { extractLinks } from "@mendable/firecrawl-rs";
import {
fetchRobotsTxt,
createRobotsChecker,
isUrlAllowedByRobots,
} from "../../lib/robots-txt";
import { ScrapeJobTimeoutError } from "../../lib/error";
import { ScrapeOptions } from "../../controllers/v2/types";
import { filterLinks, filterUrl } from "@mendable/firecrawl-rs";
export const SITEMAP_LIMIT = 25;
const SITEMAP_MAX_AGE = 7 * 24 * 60 * 60 * 1000;
interface FilterResult {
allowed: boolean;
url?: string;
denialReason?: string;
}
enum DenialReason {
DEPTH_LIMIT = "This URL exceeds the maximum crawl depth you configured. The URL's depth (number of path segments) is greater than the maxDepth parameter. To crawl this URL, increase the maxDepth value in your crawl request.",
EXCLUDE_PATTERN = "This URL's path matches one of the regex patterns you provided in the excludePaths parameter. URLs matching excludePaths are intentionally skipped during crawling. If this URL should be crawled, adjust your excludePaths patterns.",
INCLUDE_PATTERN = "This URL's path does not match any of the regex patterns you provided in the includePaths parameter. When includePaths is specified, only URLs matching at least one pattern are crawled. If this URL should be crawled, add a matching pattern to includePaths or remove the includePaths restriction.",
ROBOTS_TXT = "This URL is blocked by the website's robots.txt file, which instructs crawlers not to access this page. Firecrawl respects robots.txt by default. To crawl this URL anyway, set ignoreRobotsTxt: true in your crawl request (note: this may violate the website's crawling policies).",
FILE_TYPE = "This URL points to a file type that Firecrawl does not crawl (e.g., images, videos, fonts, archives). Firecrawl automatically skips non-document file extensions like .png, .jpg, .mp4, .zip, .css, .js, etc.",
URL_PARSE_ERROR = "This URL could not be parsed as a valid URL. The URL may be malformed, contain invalid characters, or use an unsupported format. Please verify the URL is correctly formatted.",
BACKWARD_CRAWLING = "This URL is outside the initial URL's path hierarchy, and backward crawling is disabled. By default, Firecrawl only crawls URLs that are 'below' or 'within' the starting URL path. To crawl this URL, either set allowBackwardCrawling: true or set crawlEntireDomain: true to crawl the entire domain.",
SOCIAL_MEDIA = "This URL points to a social media platform or is an email link. Firecrawl automatically skips social media links and mailto: links during crawling.",
EXTERNAL_LINK = "This URL points to a different domain than the one being crawled, and external links are disabled. By default, Firecrawl only crawls URLs on the same domain as the starting URL. To crawl external links, set allowExternalLinks: true in your crawl request.",
SECTION_LINK = "This URL contains a section anchor (#) and points to a specific section of a page rather than a separate page. Firecrawl treats these as duplicates of the base URL and skips them to avoid crawling the same content multiple times.",
NON_WEB_PROTOCOL = "This URL uses a non-web protocol (such as mailto:, tel:, ftp:, ssh:, file:, or telnet:) that Firecrawl cannot scrape. Firecrawl only supports HTTP and HTTPS protocols.",
}
interface FilterLinksResult {
links: string[];
denialReasons: Map<string, string>;
}
export class WebCrawler {
private jobId: string;
private initialUrl: string;
private baseUrl: string;
private includes: string[];
private excludes: string[];
private maxCrawledLinks: number;
private maxCrawledDepth: number;
private visited: Set<string> = new Set();
private crawledUrls: Map<string, string> = new Map();
private limit: number;
private robotsTxt: string;
private robotsTxtUrl: string;
public robots: Robot;
private robotsCrawlDelay: number | null = null;
private generateImgAltText: boolean;
private allowBackwardCrawling: boolean;
private allowExternalContentLinks: boolean;
private allowSubdomains: boolean;
private ignoreRobotsTxt: boolean;
private regexOnFullURL: boolean;
private logger: typeof _logger;
private sitemapsHit: Set<string> = new Set();
private maxDiscoveryDepth: number | undefined;
private currentDiscoveryDepth: number;
private zeroDataRetention: boolean;
private location?: ScrapeOptions["location"];
private headers?: Record<string, string>;
private robotsUserAgent?: string;
constructor({
jobId,
initialUrl,
baseUrl,
includes,
excludes,
maxCrawledLinks = 10000,
limit = 10000,
generateImgAltText = false,
maxCrawledDepth = 10,
allowBackwardCrawling = false,
allowExternalContentLinks = false,
allowSubdomains = false,
ignoreRobotsTxt = false,
regexOnFullURL = false,
maxDiscoveryDepth,
currentDiscoveryDepth,
zeroDataRetention,
location,
headers,
robotsUserAgent,
}: {
jobId: string;
initialUrl: string;
baseUrl?: string;
includes?: string[];
excludes?: string[];
maxCrawledLinks?: number;
limit?: number;
generateImgAltText?: boolean;
maxCrawledDepth?: number;
allowBackwardCrawling?: boolean;
allowExternalContentLinks?: boolean;
allowSubdomains?: boolean;
ignoreRobotsTxt?: boolean;
regexOnFullURL?: boolean;
maxDiscoveryDepth?: number;
currentDiscoveryDepth?: number;
zeroDataRetention?: boolean;
location?: ScrapeOptions["location"];
headers?: Record<string, string>;
robotsUserAgent?: string;
}) {
this.jobId = jobId;
this.initialUrl = initialUrl;
this.baseUrl = baseUrl ?? new URL(initialUrl).origin;
this.includes = Array.isArray(includes) ? includes : [];
this.excludes = Array.isArray(excludes) ? excludes : [];
this.limit = limit;
this.robotsTxt = "";
this.robotsTxtUrl = `${this.baseUrl}${this.baseUrl.endsWith("/") ? "" : "/"}robots.txt`;
this.robots = robotsParser(this.robotsTxtUrl, this.robotsTxt);
// Deprecated, use limit instead
this.maxCrawledLinks = maxCrawledLinks ?? limit;
this.maxCrawledDepth = maxCrawledDepth ?? 10;
this.generateImgAltText = generateImgAltText ?? false;
this.allowBackwardCrawling = allowBackwardCrawling ?? false;
this.allowExternalContentLinks = allowExternalContentLinks ?? false;
this.allowSubdomains = allowSubdomains ?? false;
this.ignoreRobotsTxt = ignoreRobotsTxt ?? false;
this.regexOnFullURL = regexOnFullURL ?? false;
this.zeroDataRetention = zeroDataRetention ?? false;
this.logger = _logger.child({
crawlId: this.jobId,
module: "WebCrawler",
zeroDataRetention: this.zeroDataRetention,
});
this.maxDiscoveryDepth = maxDiscoveryDepth;
this.currentDiscoveryDepth = currentDiscoveryDepth ?? 0;
this.location = location;
this.headers = headers;
this.robotsUserAgent = robotsUserAgent;
}
public setBaseUrl(newBase: string): void {
this.baseUrl = newBase;
this.robotsTxtUrl = `${this.baseUrl}${this.baseUrl.endsWith("/") ? "" : "/"}robots.txt`;
}
public async filterLinks(
sitemapLinks: string[],
limit: number,
maxDepth: number,
fromMap: boolean = false,
skipRobots: boolean = false,
): Promise<FilterLinksResult> {
const denialReasons = new Map<string, string>();
if (this.currentDiscoveryDepth === this.maxDiscoveryDepth) {
this.logger.debug("Max discovery depth hit, filtering off all links", {
currentDiscoveryDepth: this.currentDiscoveryDepth,
maxDiscoveryDepth: this.maxDiscoveryDepth,
});
sitemapLinks.forEach(link => {
denialReasons.set(
link,
`This URL was not crawled because the maximum discovery depth (${this.maxDiscoveryDepth}) has been reached. Discovery depth counts how many 'hops' from the starting URL a page is. To crawl more pages, increase the maxDiscoveryDepth value in your crawl request.`,
);
});
return { links: [], denialReasons };
}
// If the initial URL is a sitemap.xml, skip filtering
if (this.initialUrl.endsWith("sitemap.xml") && fromMap) {
return { links: sitemapLinks.slice(0, limit), denialReasons };
}
try {
const res = await filterLinks({
links: sitemapLinks,
limit: isFinite(limit) ? limit : undefined,
maxDepth: maxDepth,
baseUrl: this.baseUrl,
initialUrl: this.initialUrl,
regexOnFullUrl: this.regexOnFullURL,
excludes: this.excludes,
includes: this.includes,
allowBackwardCrawling: this.allowBackwardCrawling,
ignoreRobotsTxt: this.ignoreRobotsTxt || skipRobots,
robotsTxt: this.robotsTxt,
robotsUserAgent: this.robotsUserAgent,
allowExternalContentLinks: this.allowExternalContentLinks,
allowSubdomains: this.allowSubdomains,
});
const fancyDenialReasons = new Map<string, string>();
Object.entries(res.denialReasons).forEach(([key, value]) => {
// Generate dynamic context for specific denial reasons
let urlPath: string;
try {
urlPath = new URL(key).pathname;
} catch {
urlPath = key;
}
const excincPath = this.regexOnFullURL ? key : urlPath;
switch (value) {
case "DEPTH_LIMIT":
const depth = getURLDepth(key);
fancyDenialReasons.set(
key,
`This URL exceeds the maximum crawl depth you configured. The URL's depth is ${depth}, but maxDepth is set to ${maxDepth}. To crawl this URL, increase the maxDepth value in your crawl request.`,
);
break;
case "EXCLUDE_PATTERN":
const matchingExclude = this.excludes.find(p => {
try {
return new RegExp(p).test(excincPath);
} catch {
return false;
}
});
fancyDenialReasons.set(
key,
`This URL's path ("${excincPath}") matches the exclude pattern "${matchingExclude ?? "(unknown)"}" you provided in the excludePaths parameter. URLs matching excludePaths are intentionally skipped during crawling. If this URL should be crawled, adjust your excludePaths patterns.`,
);
break;
case "INCLUDE_PATTERN":
fancyDenialReasons.set(
key,
`This URL's path ("${excincPath}") does not match any of the regex patterns you provided in the includePaths parameter: [${this.includes.map(p => `"${p}"`).join(", ")}]. When includePaths is specified, only URLs matching at least one pattern are crawled. If this URL should be crawled, add a matching pattern to includePaths or remove the includePaths restriction.`,
);
break;
case "BACKWARD_CRAWLING":
const initialPath = new URL(this.initialUrl).pathname;
fancyDenialReasons.set(
key,
`This URL's path ("${urlPath}") is outside the initial URL's path hierarchy ("${initialPath}"), and backward crawling is disabled. By default, Firecrawl only crawls URLs that are 'below' or 'within' the starting URL path. To crawl this URL, either set allowBackwardCrawling: true or set crawlEntireDomain: true to crawl the entire domain.`,
);
break;
case "FILE_TYPE":
const extension = key.split("?")[0].split(".").pop()?.toLowerCase();
fancyDenialReasons.set(
key,
`This URL points to a file with extension ".${extension}" that Firecrawl does not crawl. Firecrawl automatically skips non-document file extensions like .png, .jpg, .mp4, .zip, .css, .js, etc. to focus on web pages with textual content.`,
);
break;
default:
// Use the static enum message for other cases
fancyDenialReasons.set(
key,
DenialReason[value as keyof typeof DenialReason] ?? value,
);
}
});
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
for (const link of res.links) {
this.logger.debug(`${link} OK`);
}
for (const [link, reason] of fancyDenialReasons) {
this.logger.debug(`${link} ${reason}`);
}
}
return {
links: res.links,
denialReasons: fancyDenialReasons,
};
} catch (error) {
this.logger.error("Error filtering links in Rust, falling back to JS", {
error,
method: "filterLinks",
});
}
const filteredLinks = sitemapLinks
.filter(link => {
let url: URL;
try {
url = new URL(link.trim(), this.baseUrl);
} catch (error) {
this.logger.debug(`Error processing link: ${link}`, {
link,
error,
method: "filterLinks",
});
return false;
}
const path = url.pathname;
const urlStr = url.toString();
const nonWebProtocols = [
"mailto:",
"tel:",
"telnet:",
"ftp:",
"ftps:",
"ssh:",
"file:",
];
if (nonWebProtocols.some(protocol => urlStr.startsWith(protocol))) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} NON-WEB PROTOCOL FAIL`);
}
denialReasons.set(link, DenialReason.NON_WEB_PROTOCOL);
return false;
}
const depth = getURLDepth(url.toString());
// Check if the link exceeds the maximum depth allowed
if (depth > maxDepth) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} DEPTH FAIL`);
}
denialReasons.set(
link,
`This URL exceeds the maximum crawl depth you configured. The URL's depth is ${depth}, but maxDepth is set to ${maxDepth}. To crawl this URL, increase the maxDepth value in your crawl request.`,
);
return false;
}
const excincPath = this.regexOnFullURL ? link : path;
// Check if the link should be excluded
if (this.excludes.length > 0 && this.excludes[0] !== "") {
const matchingPattern = this.excludes.find(excludePattern =>
new RegExp(excludePattern).test(excincPath),
);
if (matchingPattern) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} EXCLUDE FAIL`);
}
denialReasons.set(
link,
`This URL's path ("${excincPath}") matches the exclude pattern "${matchingPattern}" you provided in the excludePaths parameter. URLs matching excludePaths are intentionally skipped during crawling. If this URL should be crawled, adjust your excludePaths patterns.`,
);
return false;
}
}
// Check if the link matches the include patterns, if any are specified
if (this.includes.length > 0 && this.includes[0] !== "") {
if (
!this.includes.some(includePattern =>
new RegExp(includePattern).test(excincPath),
)
) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} INCLUDE FAIL`);
}
denialReasons.set(
link,
`This URL's path ("${excincPath}") does not match any of the regex patterns you provided in the includePaths parameter: [${this.includes.map(p => `"${p}"`).join(", ")}]. When includePaths is specified, only URLs matching at least one pattern are crawled. If this URL should be crawled, add a matching pattern to includePaths or remove the includePaths restriction.`,
);
return false;
}
}
// Normalize the initial URL and the link to account for www and non-www versions
const normalizedInitialUrl = new URL(this.initialUrl);
let normalizedLink;
try {
normalizedLink = new URL(link);
} catch (_) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} URL PARSE FAIL`);
}
return false;
}
const initialHostname = normalizedInitialUrl.hostname.replace(
/^www\./,
"",
);
const linkHostname = normalizedLink.hostname.replace(/^www\./, "");
// Ensure the protocol and hostname match, and the path starts with the initial URL's path
// commented to able to handling external link on allowExternalContentLinks
// if (linkHostname !== initialHostname) {
// return false;
// }
if (!this.allowBackwardCrawling) {
if (
!normalizedLink.pathname.startsWith(normalizedInitialUrl.pathname)
) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(
`${link} BACKWARDS FAIL ${normalizedLink.pathname} ${normalizedInitialUrl.pathname}`,
);
}
denialReasons.set(
link,
`This URL's path ("${normalizedLink.pathname}") is outside the initial URL's path hierarchy ("${normalizedInitialUrl.pathname}"), and backward crawling is disabled. By default, Firecrawl only crawls URLs that are 'below' or 'within' the starting URL path. To crawl this URL, either set allowBackwardCrawling: true or set crawlEntireDomain: true to crawl the entire domain.`,
);
return false;
}
}
const isAllowed = this.isRobotsAllowed(
link,
this.ignoreRobotsTxt || skipRobots,
);
// Check if the link is disallowed by robots.txt
if (!isAllowed) {
this.logger.debug(`Link disallowed by robots.txt: ${link}`, {
method: "filterLinks",
link,
});
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} ROBOTS FAIL`);
}
denialReasons.set(
link,
`This URL is blocked by the website's robots.txt file, which instructs crawlers not to access this page. Firecrawl respects robots.txt by default. To crawl this URL anyway, set ignoreRobotsTxt: true in your crawl request (note: this may violate the website's crawling policies).`,
);
return false;
}
if (this.isFile(link)) {
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} FILE FAIL`);
}
const extension = link.split("?")[0].split(".").pop()?.toLowerCase();
denialReasons.set(
link,
`This URL points to a file with extension ".${extension}" that Firecrawl does not crawl. Firecrawl automatically skips non-document file extensions like .png, .jpg, .mp4, .zip, .css, .js, etc. to focus on web pages with textual content.`,
);
return false;
}
if (config.FIRECRAWL_DEBUG_FILTER_LINKS) {
this.logger.debug(`${link} OK`);
}
return true;
})
.slice(0, limit);
return { links: filteredLinks, denialReasons };
}
public async getRobotsTxt(
skipTlsVerification = false,
abort?: AbortSignal,
): Promise<string> {
try {
this.logger.debug("Attempting to fetch robots.txt", {
method: "getRobotsTxt",
initialUrl: this.initialUrl,
skipTlsVerification,
});
const { content: robotsTxt, url } = await fetchRobotsTxt(
{
url: this.robotsTxtUrl,
zeroDataRetention: this.zeroDataRetention,
location: this.location,
...(this.robotsUserAgent
? {
headers: {
...this.headers,
"User-Agent": this.robotsUserAgent,
},
skipCache: true,
}
: {}),
},
this.jobId,
this.logger,
abort,
);
this.logger.debug("Successfully fetched robots.txt", {
method: "getRobotsTxt",
initialUrl: this.initialUrl,
robotsTxtLength: robotsTxt.length,
hasContent: robotsTxt.length > 0,
finalUrl: url,
});
return robotsTxt;
} catch (error) {
this.logger.debug("Failed to fetch robots.txt", {
method: "getRobotsTxt",
initialUrl: this.initialUrl,
error: error.message,
});
throw error;
}
}
public importRobotsTxt(txt: string) {
this.robotsTxt = txt;
const checker = createRobotsChecker(this.initialUrl, txt);
this.robots = checker.robots;
this.robotsTxtUrl = checker.robotsTxtUrl;
const delay = this.robotsUserAgent
? this.robots.getCrawlDelay(this.robotsUserAgent)
: this.robots.getCrawlDelay("FireCrawlAgent") ||
this.robots.getCrawlDelay("FirecrawlAgent");
this.robotsCrawlDelay = delay !== undefined ? delay : null;
const sitemaps = this.robots.getSitemaps();
this.logger.debug("Imported robots.txt", {
method: "importRobotsTxt",
robotsTxtUrl: this.robotsTxtUrl,
robotsTxtLength: txt.length,
sitemapsFound: sitemaps.length,
sitemaps: sitemaps,
crawlDelay: this.robotsCrawlDelay,
});
}
public getRobotsCrawlDelay(): number | null {
return this.robotsCrawlDelay;
}
public async tryGetSitemap(
urlsHandler: (urls: string[]) => unknown,
fromMap: boolean = false,
onlySitemap: boolean = false,
timeout: number = 120000,
abort?: AbortSignal,
mock?: string,
maxAge: number = SITEMAP_MAX_AGE,
): Promise<number> {
this.logger.debug(`Fetching sitemap links from ${this.initialUrl}`, {
method: "tryGetSitemap",
});
let leftOfLimit = this.limit;
const normalizeUrl = (url: string) => {
url = url.replace(/^https?:\/\//, "").replace(/^www\./, "");
if (url.endsWith("/")) {
url = url.slice(0, -1);
}
return url;
};
const _urlsHandler = async (urls: string[]) => {
this.logger.debug("urlsHandler invoked");
if (fromMap && onlySitemap) {
return await urlsHandler(urls);
} else {
let filteredLinksResult = await this.filterLinks(
[...new Set(urls)],
leftOfLimit,
this.maxCrawledDepth,
fromMap,
fromMap,
);
let filteredLinks = filteredLinksResult.links;
leftOfLimit -= filteredLinks.length;
const pipeline = redisEvictConnection.pipeline();
const normalizedUrls = filteredLinks.map(url => normalizeUrl(url));
normalizedUrls.forEach(normalizedUrl => {
pipeline.sadd("sitemap:" + this.jobId + ":links", normalizedUrl);
});
const results = await pipeline.exec();
const uniqueURLs = filteredLinks.filter(
(_, index) =>
results &&
results[index] &&
!results[index][0] &&
results[index][1] === 1,
);
await redisEvictConnection.expire(
"sitemap:" + this.jobId + ":links",
3600,
"NX",
);
if (uniqueURLs.length > 0) {
return await urlsHandler(uniqueURLs);
}
}
};
let timeoutHandle: NodeJS.Timeout;
const timeoutPromise = new Promise((_, reject) => {
timeoutHandle = setTimeout(
() => reject(new Error("Sitemap fetch timeout")),
timeout,
);
});
try {
const robotsSitemaps = this.robots.getSitemaps();
this.logger.debug("Attempting to fetch sitemap links", {
method: "tryGetSitemap",
initialUrl: this.initialUrl,
robotsSitemapsCount: robotsSitemaps.length,
robotsSitemaps: robotsSitemaps,
hasRobotsTxt: this.robotsTxt.length > 0,
});
let count = (await Promise.race([
Promise.all([
this.tryFetchSitemapLinks(
this.initialUrl,
_urlsHandler,
abort,
mock,
maxAge,
),
...robotsSitemaps.map(x =>
this.tryFetchSitemapLinks(x, _urlsHandler, abort, mock, maxAge),
),
]).then(results => results.reduce((a, x) => a + x, 0)),
timeoutPromise,
]).finally(() => {
clearTimeout(timeoutHandle);
})) as number;
if (count > 0) {
if (
await redisEvictConnection.sadd(
"sitemap:" + this.jobId + ":links",
normalizeUrl(this.initialUrl),
)
) {
urlsHandler([this.initialUrl]);
}
count++;
}
await redisEvictConnection.expire(
"sitemap:" + this.jobId + ":links",
3600,
"NX",
);
return count;
} catch (error) {
if (error.message === "Sitemap fetch timeout") {
this.logger.warn("Sitemap fetch timed out", {
method: "tryGetSitemap",
timeout,
});
return 0;
}
this.logger.error("Error fetching sitemap", {
method: "tryGetSitemap",
error,
});
return 0;
}
}
public async filterURL(href: string, url: string): Promise<FilterResult> {
return await filterUrl({
href: href,
url: url,
baseUrl: this.baseUrl,
excludes: this.excludes,
ignoreRobotsTxt: this.ignoreRobotsTxt,
robotsTxt: this.robotsTxt,
robotsUserAgent: this.robotsUserAgent,
allowExternalContentLinks: this.allowExternalContentLinks,
allowSubdomains: this.allowSubdomains,
});
}
private async extractLinksFromHTMLRust(html: string, url: string) {
const links = await extractLinks(html);
const filteredLinks: string[] = [];
for (const link of links) {
const filterResult = await this.filterURL(link, url);
if (filterResult.allowed && filterResult.url) {
filteredLinks.push(filterResult.url);
}
}
return filteredLinks;
}
private async extractLinksFromHTMLCheerio(html: string, url: string) {
let links: string[] = [];
const $ = load(html);
for (let i = 0; i < $("a").length; i++) {
const element = $("a")[i];
let href = $(element).attr("href");
if (href) {
if (href.match(/^https?:\/[^\/]/)) {
href = href.replace(/^https?:\//, "$&/");
}
const filterResult = await this.filterURL(href, url);
if (filterResult.allowed && filterResult.url) {
links.push(filterResult.url);
}
}
}
// Extract links from iframes with inline src
for (let i = 0; i < $("iframe").length; i++) {
const element = $("iframe")[i];
const src = $(element).attr("src");
if (src && src.startsWith("data:text/html")) {
const iframeHtml = decodeURIComponent(src.split(",")[1]);
const iframeLinks = await this.extractLinksFromHTMLCheerio(
iframeHtml,
url,
);
links = links.concat(iframeLinks);
}
}
return links;
}
public async extractLinksFromHTML(html: string, url: string) {
try {
return [
...new Set(
(await this.extractLinksFromHTMLRust(html, url))
.map(x => {
try {
return new URL(x, url).href;
} catch (e) {
return null;
}
})
.filter(x => x !== null) as string[],
),
];
} catch (error) {
this.logger.warn(
"Failed to call html-transformer! Falling back to cheerio...",
{
error,
module: "scrapeURL",
method: "extractMetadata",
},
);
}
return await this.extractLinksFromHTMLCheerio(html, url);
}
private isRobotsAllowed(
url: string,
ignoreRobotsTxt: boolean = false,
): boolean {
return ignoreRobotsTxt
? true
: isUrlAllowedByRobots(
url,
this.robots,
this.robotsUserAgent ? [this.robotsUserAgent] : undefined,
);
}
public isFile(url: string): boolean {
const fileExtensions = [
".png",
".jpg",
".jpeg",
".gif",
".css",
".js",
".ico",
".svg",
".tiff",
// ".pdf",
".zip",
".exe",
".dmg",
".mp4",
".mp3",
".wav",
".pptx",
// ".docx",
".xlsx",
// ".xml",
".avi",
".flv",
".woff",
".ttf",
".woff2",
".webp",
".inc",
];
try {
const urlWithoutQuery = url.split("?")[0].toLowerCase();
return fileExtensions.some(ext => urlWithoutQuery.endsWith(ext));
} catch (error) {
this.logger.error(`Error processing URL in isFile`, {
method: "isFile",
error,
});
return false;
}
}
private async tryFetchSitemapLinks(
url: string,
urlsHandler: (urls: string[]) => unknown,
abort?: AbortSignal,
mock?: string,
maxAge?: number,
): Promise<number> {
const sitemapUrl =
url.toLowerCase().endsWith(".xml") ||
url.toLowerCase().endsWith(".xml.gz")
? url
: `${url}${url.endsWith("/") ? "" : "/"}sitemap.xml`;
this.logger.debug("Trying to fetch sitemap links", {
method: "tryFetchSitemapLinks",
originalUrl: url,
sitemapUrl,
maxAge,
isXmlUrl: url.endsWith(".xml"),
isGzUrl: url.endsWith(".xml.gz"),
});
let sitemapCount: number = 0;
// Try to get sitemap from the provided URL first
try {
sitemapCount = await getLinksFromSitemap(
{
sitemapUrl,
urlsHandler,
mode: "fire-engine",
maxAge,
zeroDataRetention: this.zeroDataRetention,
location: this.location,
headers: this.headers,
},
this.logger,
this.jobId,
this.sitemapsHit,
abort,
mock,
);
} catch (error) {
if (error instanceof ScrapeJobTimeoutError) {
throw error;
} else {
this.logger.debug(`Failed to fetch sitemap from ${sitemapUrl}`, {
method: "tryFetchSitemapLinks",
sitemapUrl,
error,
});
}
}
// If this is a subdomain, also try to get sitemap from the main domain
try {
const urlObj = new URL(url);
const hostname = urlObj.hostname;
// Skip subdomain logic for IP addresses (IPv4 or IPv6)
const isIPv4 = /^(\d{1,3}\.){3}\d{1,3}$/.test(hostname);
const isIPv6 = hostname.includes(":");
if (isIPv4 || isIPv6) {
// IP addresses don't have subdomains, skip this logic
} else {
const domainParts = hostname.split(".");
// Check if this is a subdomain (has more than 2 parts and not www)
if (domainParts.length > 2 && domainParts[0] !== "www") {
// Get the main domain by taking the last two parts
const mainDomain = domainParts.slice(-2).join(".");
const mainDomainUrl = `${urlObj.protocol}//${mainDomain}`;
const mainDomainSitemapUrl = `${mainDomainUrl}/sitemap.xml`;
try {
// Get all links from the main domain's sitemap
sitemapCount += await getLinksFromSitemap(
{
sitemapUrl: mainDomainSitemapUrl,
urlsHandler(urls) {
return urlsHandler(
urls.filter(link => {
try {
const linkUrl = new URL(link);
return linkUrl.hostname.endsWith(hostname);
} catch {}
}),
);
},
mode: "fire-engine",
maxAge,
zeroDataRetention: this.zeroDataRetention,
location: this.location,
headers: this.headers,
},
this.logger,
this.jobId,
this.sitemapsHit,
abort,
mock,
);
} catch (error) {
if (error instanceof ScrapeJobTimeoutError) {
throw error;
} else {
this.logger.debug(
`Failed to fetch main domain sitemap from ${mainDomainSitemapUrl}`,
{ method: "tryFetchSitemapLinks", mainDomainSitemapUrl, error },
);
}
}
}
}
} catch (error) {
if (error instanceof ScrapeJobTimeoutError) {
throw error;
} else {
this.logger.debug(`Error processing main domain sitemap`, {
method: "tryFetchSitemapLinks",
url,
error,
});
}
}
// If no sitemap found yet, try the baseUrl as a last resort
if (sitemapCount === 0) {
const baseUrlSitemap = `${this.baseUrl}/sitemap.xml`;
try {
sitemapCount += await getLinksFromSitemap(
{
sitemapUrl: baseUrlSitemap,
urlsHandler,
mode: "fire-engine",
maxAge,
zeroDataRetention: this.zeroDataRetention,
location: this.location,
headers: this.headers,
},
this.logger,
this.jobId,
this.sitemapsHit,
abort,
mock,
);
} catch (error) {
if (error instanceof ScrapeJobTimeoutError) {
throw error;
} else {
this.logger.debug(`Failed to fetch sitemap from ${baseUrlSitemap}`, {
method: "tryFetchSitemapLinks",
sitemapUrl: baseUrlSitemap,
error,
});
if (error instanceof AxiosError && error.response?.status === 404) {
// ignore 404
} else {
sitemapCount += await getLinksFromSitemap(
{
sitemapUrl: baseUrlSitemap,
urlsHandler,
mode: "fire-engine",
maxAge,
zeroDataRetention: this.zeroDataRetention,
location: this.location,
headers: this.headers,
},
this.logger,
this.jobId,
this.sitemapsHit,
abort,
mock,
);
}
}
}
}
if (this.sitemapsHit.size >= SITEMAP_LIMIT) {
this.logger.warn("Sitemap limit hit!", {
crawlId: this.jobId,
url: this.baseUrl,
});
}
this.logger.debug("Finished trying to fetch sitemap links", {
method: "tryFetchSitemapLinks",
originalUrl: url,
sitemapUrl,
linksFound: sitemapCount,
totalSitemapsHit: this.sitemapsHit.size,
});
return sitemapCount;
}
}
|