* Fix: Use correct URL variable for raw HTML extraction (#1116) - Prevents full HTML content from being passed as URL to extraction strategies - Added unit tests to verify raw HTML and regular URL processing Fix: Wrong URL variable used for extraction of raw html * Fix #1181: Preserve whitespace in code blocks during HTML scraping The remove_empty_elements_fast() method was removing whitespace-only span elements inside <pre> and <code> tags, causing import statements like "import torch" to become "importtorch". Now skips elements inside code blocks where whitespace is significant. * Refactor Pydantic model configuration to use ConfigDict for arbitrary types * Fix EmbeddingStrategy: Uncomment response handling for the variations and clean up mock data. ref #1621 * Fix: permission issues with .cache/url_seeder and other runtime cache dirs. ref #1638 * fix: ensure BrowserConfig.to_dict serializes proxy_config * feat: make LLM backoff configurable end-to-end - extend LLMConfig with backoff delay/attempt/factor fields and thread them through LLMExtractionStrategy, LLMContentFilter, table extraction, and Docker API handlers - expose the backoff parameter knobs on perform_completion_with_backoff/aperform_completion_with_backoff and document them in the md_v2 guides * reproduced AttributeError from #1642 * pass timeout parameter to docker client request * added missing deep crawling objects to init * generalized query in ContentRelevanceFilter to be a str or list * import modules from enhanceable deserialization * parameterized tests * Fix: capture current page URL to reflect JavaScript navigation and add test for delayed redirects. ref #1268 * refactor: replace PyPDF2 with pypdf across the codebase. ref #1412 * Add browser_context_id and target_id parameters to BrowserConfig Enable Crawl4AI to connect to pre-created CDP browser contexts, which is essential for cloud browser services that pre-create isolated contexts. Changes: - Add browser_context_id and target_id parameters to BrowserConfig - Update from_kwargs() and to_dict() methods - Modify BrowserManager.start() to use existing context when provided - Add _get_page_by_target_id() helper method - Update get_page() to handle pre-existing targets - Add test for browser_context_id functionality This enables cloud services to: 1. Create isolated CDP contexts before Crawl4AI connects 2. Pass context/target IDs to BrowserConfig 3. Have Crawl4AI reuse existing contexts instead of creating new ones * Add cdp_cleanup_on_close flag to prevent memory leaks in cloud/server scenarios * Fix: add cdp_cleanup_on_close to from_kwargs * Fix: find context by target_id for concurrent CDP connections * Fix: use target_id to find correct page in get_page * Fix: use CDP to find context by browserContextId for concurrent sessions * Revert context matching attempts - Playwright cannot see CDP-created contexts * Add create_isolated_context flag for concurrent CDP crawls When True, forces creation of a new browser context instead of reusing the default context. Essential for concurrent crawls on the same browser to prevent navigation conflicts. * Add context caching to create_isolated_context branch Uses contexts_by_config cache (same as non-CDP mode) to reuse contexts for multiple URLs with same config. Still creates new page per crawl for navigation isolation. Benefits batch/deep crawls. * Add init_scripts support to BrowserConfig for pre-page-load JS injection This adds the ability to inject JavaScript that runs before any page loads, useful for stealth evasions (canvas/audio fingerprinting, userAgentData). - Add init_scripts parameter to BrowserConfig (list of JS strings) - Apply init_scripts in setup_context() via context.add_init_script() - Update from_kwargs() and to_dict() for serialization * Fix CDP connection handling: support WS URLs and proper cleanup Changes to browser_manager.py: 1. _verify_cdp_ready(): Support multiple URL formats - WebSocket URLs (ws://, wss://): Skip HTTP verification, Playwright handles directly - HTTP URLs with query params: Properly parse with urlparse to preserve query string - Fixes issue where naive f"{cdp_url}/json/version" broke WS URLs and query params 2. close(): Proper cleanup when cdp_cleanup_on_close=True - Close all sessions (pages) - Close all contexts - Call browser.close() to disconnect (doesn't terminate browser, just releases connection) - Wait 1 second for CDP connection to fully release - Stop Playwright instance to prevent memory leaks This enables: - Connecting to specific browsers via WS URL - Reusing the same browser with multiple sequential connections - No user wait needed between connections (internal 1s delay handles it) Added tests/browser/test_cdp_cleanup_reuse.py with comprehensive tests. * Update gitignore * Some debugging for caching * Add _generate_screenshot_from_html for raw: and file:// URLs Implements the missing method that was being called but never defined. Now raw: and file:// URLs can generate screenshots by: 1. Loading HTML into a browser page via page.set_content() 2. Taking screenshot using existing take_screenshot() method 3. Cleaning up the page afterward This enables cached HTML to be rendered with screenshots in crawl4ai-cloud. * Add PDF and MHTML support for raw: and file:// URLs - Replace _generate_screenshot_from_html with _generate_media_from_html - New method handles screenshot, PDF, and MHTML in one browser session - Update raw: and file:// URL handlers to use new method - Enables cached HTML to generate all media types * Add crash recovery for deep crawl strategies Add optional resume_state and on_state_change parameters to all deep crawl strategies (BFS, DFS, Best-First) for cloud deployment crash recovery. Features: - resume_state: Pass saved state to resume from checkpoint - on_state_change: Async callback fired after each URL for real-time state persistence to external storage (Redis, DB, etc.) - export_state(): Get last captured state manually - Zero overhead when features are disabled (None defaults) State includes visited URLs, pending queue/stack, depths, and pages_crawled count. All state is JSON-serializable. * Fix: HTTP strategy raw: URL parsing truncates at # character The AsyncHTTPCrawlerStrategy.crawl() method used urlparse() to extract content from raw: URLs. This caused HTML with CSS color codes like #eee to be truncated because # is treated as a URL fragment delimiter. Before: raw:body{background:#eee} -> parsed.path = 'body{background:' After: raw:body{background:#eee} -> raw_content = 'body{background:#eee' Fix: Strip the raw: or raw:// prefix directly instead of using urlparse, matching how the browser strategy handles it. * Add base_url parameter to CrawlerRunConfig for raw HTML processing When processing raw: HTML (e.g., from cache), the URL parameter is meaningless for markdown link resolution. This adds a base_url parameter that can be set explicitly to provide proper URL resolution context. Changes: - Add base_url parameter to CrawlerRunConfig.__init__ - Add base_url to CrawlerRunConfig.from_kwargs - Update aprocess_html to use base_url for markdown generation Usage: config = CrawlerRunConfig(base_url='https://example.com') result = await crawler.arun(url='raw:{html}', config=config) * Add prefetch mode for two-phase deep crawling - Add `prefetch` parameter to CrawlerRunConfig - Add `quick_extract_links()` function for fast link extraction - Add short-circuit in aprocess_html() for prefetch mode - Add 42 tests (unit, integration, regression) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Updates on proxy rotation and proxy configuration * Add proxy support to HTTP crawler strategy * Add browser pipeline support for raw:/file:// URLs - Add process_in_browser parameter to CrawlerRunConfig - Route raw:/file:// URLs through _crawl_web() when browser operations needed - Use page.set_content() instead of goto() for local content - Fix cookie handling for non-HTTP URLs in browser_manager - Auto-detect browser requirements: js_code, wait_for, screenshot, etc. - Maintain fast path for raw:/file:// without browser params Fixes #310 * Add smart TTL cache for sitemap URL seeder - Add cache_ttl_hours and validate_sitemap_lastmod params to SeedingConfig - New JSON cache format with metadata (version, created_at, lastmod, url_count) - Cache validation by TTL expiry and sitemap lastmod comparison - Auto-migration from old .jsonl to new .json format - Fixes bug where incomplete cache was used indefinitely * Update URL seeder docs with smart TTL cache parameters - Add cache_ttl_hours and validate_sitemap_lastmod to parameter table - Document smart TTL cache validation with examples - Add cache-related troubleshooting entries - Update key features summary * Add MEMORY.md to gitignore * Docs: Add multi-sample schema generation section Add documentation explaining how to pass multiple HTML samples to generate_schema() for stable selectors that work across pages with varying DOM structures. Includes: - Problem explanation (fragile nth-child selectors) - Solution with code example - Key points for multi-sample queries - Comparison table of fragile vs stable selectors * Fix critical RCE and LFI vulnerabilities in Docker API deployment Security fixes for vulnerabilities reported by ProjectDiscovery: 1. Remote Code Execution via Hooks (CVE pending) - Remove __import__ from allowed_builtins in hook_manager.py - Prevents arbitrary module imports (os, subprocess, etc.) - Hooks now disabled by default via CRAWL4AI_HOOKS_ENABLED env var 2. Local File Inclusion via file:// URLs (CVE pending) - Add URL scheme validation to /execute_js, /screenshot, /pdf, /html - Block file://, javascript:, data: and other dangerous schemes - Only allow http://, https://, and raw: (where appropriate) 3. Security hardening - Add CRAWL4AI_HOOKS_ENABLED=false as default (opt-in for hooks) - Add security warning comments in config.yml - Add validate_url_scheme() helper for consistent validation Testing: - Add unit tests (test_security_fixes.py) - 16 tests - Add integration tests (run_security_tests.py) for live server Affected endpoints: - POST /crawl (hooks disabled by default) - POST /crawl/stream (hooks disabled by default) - POST /execute_js (URL validation added) - POST /screenshot (URL validation added) - POST /pdf (URL validation added) - POST /html (URL validation added) Breaking changes: - Hooks require CRAWL4AI_HOOKS_ENABLED=true to function - file:// URLs no longer work on API endpoints (use library directly) * Enhance authentication flow by implementing JWT token retrieval and adding authorization headers to API requests * Add release notes for v0.7.9, detailing breaking changes, security fixes, new features, bug fixes, and documentation updates * Add release notes for v0.8.0, detailing breaking changes, security fixes, new features, bug fixes, and documentation updates Documentation for v0.8.0 release: - SECURITY.md: Security policy and vulnerability reporting guidelines - RELEASE_NOTES_v0.8.0.md: Comprehensive release notes - migration/v0.8.0-upgrade-guide.md: Step-by-step migration guide - security/GHSA-DRAFT-RCE-LFI.md: GitHub security advisory drafts - CHANGELOG.md: Updated with v0.8.0 changes Breaking changes documented: - Docker API hooks disabled by default (CRAWL4AI_HOOKS_ENABLED) - file:// URLs blocked on Docker API endpoints Security fixes credited to Neo by ProjectDiscovery * Add examples for deep crawl crash recovery and prefetch mode in documentation * Release v0.8.0: The v0.8.0 Update - Updated version to 0.8.0 - Added comprehensive demo and release notes - Updated all documentation * Update security researcher acknowledgment with a hyperlink for Neo by ProjectDiscovery * Add async agenerate_schema method for schema generation - Extract prompt building to shared _build_schema_prompt() method - Add agenerate_schema() async version using aperform_completion_with_backoff - Refactor generate_schema() to use shared prompt builder - Fixes Gemini/Vertex AI compatibility in async contexts (FastAPI) * Fix: Enable litellm.drop_params for O-series/GPT-5 model compatibility O-series (o1, o3) and GPT-5 models only support temperature=1. Setting litellm.drop_params=True auto-drops unsupported parameters instead of throwing UnsupportedParamsError. Fixes temperature=0.01 error for these models in LLM extraction. --------- Co-authored-by: rbushria <rbushri@gmail.com> Co-authored-by: AHMET YILMAZ <tawfik@kidocode.com> Co-authored-by: Soham Kukreti <kukretisoham@gmail.com> Co-authored-by: Chris Murphy <chris.murphy@klaviyo.com> Co-authored-by: unclecode <unclecode@kidocode.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
280 lines
10 KiB
Python
280 lines
10 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Prefetch Mode and Two-Phase Crawling Example
|
|
|
|
Prefetch mode is a fast path that skips heavy processing and returns
|
|
only HTML + links. This is ideal for:
|
|
|
|
- Site mapping: Quickly discover all URLs
|
|
- Selective crawling: Find URLs first, then process only what you need
|
|
- Link validation: Check which pages exist without full processing
|
|
- Crawl planning: Estimate size before committing resources
|
|
|
|
Key concept:
|
|
- `prefetch=True` in CrawlerRunConfig enables fast link-only extraction
|
|
- Skips: markdown generation, content scraping, media extraction, LLM extraction
|
|
- Returns: HTML and links dictionary
|
|
|
|
Performance benefit: ~5-10x faster than full processing
|
|
"""
|
|
|
|
import asyncio
|
|
import time
|
|
from typing import List, Dict
|
|
|
|
from crawl4ai import AsyncWebCrawler, CrawlerRunConfig
|
|
|
|
|
|
async def example_basic_prefetch():
|
|
"""
|
|
Example 1: Basic prefetch mode.
|
|
|
|
Shows how prefetch returns HTML and links without heavy processing.
|
|
"""
|
|
print("\n" + "=" * 60)
|
|
print("Example 1: Basic Prefetch Mode")
|
|
print("=" * 60)
|
|
|
|
async with AsyncWebCrawler(verbose=False) as crawler:
|
|
# Enable prefetch mode
|
|
config = CrawlerRunConfig(prefetch=True)
|
|
|
|
print("\nFetching with prefetch=True...")
|
|
result = await crawler.arun("https://books.toscrape.com", config=config)
|
|
|
|
print(f"\nResult summary:")
|
|
print(f" Success: {result.success}")
|
|
print(f" HTML length: {len(result.html) if result.html else 0} chars")
|
|
print(f" Internal links: {len(result.links.get('internal', []))}")
|
|
print(f" External links: {len(result.links.get('external', []))}")
|
|
|
|
# These should be None/empty in prefetch mode
|
|
print(f"\n Skipped processing:")
|
|
print(f" Markdown: {result.markdown}")
|
|
print(f" Cleaned HTML: {result.cleaned_html}")
|
|
print(f" Extracted content: {result.extracted_content}")
|
|
|
|
# Show some discovered links
|
|
internal_links = result.links.get("internal", [])
|
|
if internal_links:
|
|
print(f"\n Sample internal links:")
|
|
for link in internal_links[:5]:
|
|
print(f" - {link['href'][:60]}...")
|
|
|
|
|
|
async def example_performance_comparison():
|
|
"""
|
|
Example 2: Compare prefetch vs full processing performance.
|
|
"""
|
|
print("\n" + "=" * 60)
|
|
print("Example 2: Performance Comparison")
|
|
print("=" * 60)
|
|
|
|
url = "https://books.toscrape.com"
|
|
|
|
async with AsyncWebCrawler(verbose=False) as crawler:
|
|
# Warm up - first request is slower due to browser startup
|
|
await crawler.arun(url, config=CrawlerRunConfig())
|
|
|
|
# Prefetch mode timing
|
|
start = time.time()
|
|
prefetch_result = await crawler.arun(url, config=CrawlerRunConfig(prefetch=True))
|
|
prefetch_time = time.time() - start
|
|
|
|
# Full processing timing
|
|
start = time.time()
|
|
full_result = await crawler.arun(url, config=CrawlerRunConfig())
|
|
full_time = time.time() - start
|
|
|
|
print(f"\nTiming comparison:")
|
|
print(f" Prefetch mode: {prefetch_time:.3f}s")
|
|
print(f" Full processing: {full_time:.3f}s")
|
|
print(f" Speedup: {full_time / prefetch_time:.1f}x faster")
|
|
|
|
print(f"\nOutput comparison:")
|
|
print(f" Prefetch - Links found: {len(prefetch_result.links.get('internal', []))}")
|
|
print(f" Full - Links found: {len(full_result.links.get('internal', []))}")
|
|
print(f" Full - Markdown length: {len(full_result.markdown.raw_markdown) if full_result.markdown else 0}")
|
|
|
|
|
|
async def example_two_phase_crawl():
|
|
"""
|
|
Example 3: Two-phase crawling pattern.
|
|
|
|
Phase 1: Fast discovery with prefetch
|
|
Phase 2: Full processing on selected URLs
|
|
"""
|
|
print("\n" + "=" * 60)
|
|
print("Example 3: Two-Phase Crawling")
|
|
print("=" * 60)
|
|
|
|
async with AsyncWebCrawler(verbose=False) as crawler:
|
|
# ═══════════════════════════════════════════════════════════
|
|
# Phase 1: Fast URL discovery
|
|
# ═══════════════════════════════════════════════════════════
|
|
print("\n--- Phase 1: Fast Discovery ---")
|
|
|
|
prefetch_config = CrawlerRunConfig(prefetch=True)
|
|
start = time.time()
|
|
discovery = await crawler.arun("https://books.toscrape.com", config=prefetch_config)
|
|
discovery_time = time.time() - start
|
|
|
|
all_urls = [link["href"] for link in discovery.links.get("internal", [])]
|
|
print(f" Discovered {len(all_urls)} URLs in {discovery_time:.2f}s")
|
|
|
|
# Filter to URLs we care about (e.g., book detail pages)
|
|
# On books.toscrape.com, book pages contain "catalogue/" but not "category/"
|
|
book_urls = [
|
|
url for url in all_urls
|
|
if "catalogue/" in url and "category/" not in url
|
|
][:5] # Limit to 5 for demo
|
|
|
|
print(f" Filtered to {len(book_urls)} book pages")
|
|
|
|
# ═══════════════════════════════════════════════════════════
|
|
# Phase 2: Full processing on selected URLs
|
|
# ═══════════════════════════════════════════════════════════
|
|
print("\n--- Phase 2: Full Processing ---")
|
|
|
|
full_config = CrawlerRunConfig(
|
|
word_count_threshold=10,
|
|
remove_overlay_elements=True,
|
|
)
|
|
|
|
results = []
|
|
start = time.time()
|
|
|
|
for url in book_urls:
|
|
result = await crawler.arun(url, config=full_config)
|
|
if result.success:
|
|
results.append(result)
|
|
title = result.url.split("/")[-2].replace("-", " ").title()[:40]
|
|
md_len = len(result.markdown.raw_markdown) if result.markdown else 0
|
|
print(f" Processed: {title}... ({md_len} chars)")
|
|
|
|
processing_time = time.time() - start
|
|
print(f"\n Processed {len(results)} pages in {processing_time:.2f}s")
|
|
|
|
# ═══════════════════════════════════════════════════════════
|
|
# Summary
|
|
# ═══════════════════════════════════════════════════════════
|
|
print(f"\n--- Summary ---")
|
|
print(f" Discovery phase: {discovery_time:.2f}s ({len(all_urls)} URLs)")
|
|
print(f" Processing phase: {processing_time:.2f}s ({len(results)} pages)")
|
|
print(f" Total time: {discovery_time + processing_time:.2f}s")
|
|
print(f" URLs skipped: {len(all_urls) - len(book_urls)} (not matching filter)")
|
|
|
|
|
|
async def example_prefetch_with_deep_crawl():
|
|
"""
|
|
Example 4: Combine prefetch with deep crawl strategy.
|
|
|
|
Use prefetch mode during deep crawl for maximum speed.
|
|
"""
|
|
print("\n" + "=" * 60)
|
|
print("Example 4: Prefetch with Deep Crawl")
|
|
print("=" * 60)
|
|
|
|
from crawl4ai.deep_crawling import BFSDeepCrawlStrategy
|
|
|
|
async with AsyncWebCrawler(verbose=False) as crawler:
|
|
# Deep crawl with prefetch - maximum discovery speed
|
|
config = CrawlerRunConfig(
|
|
prefetch=True, # Fast mode
|
|
deep_crawl_strategy=BFSDeepCrawlStrategy(
|
|
max_depth=1,
|
|
max_pages=10,
|
|
)
|
|
)
|
|
|
|
print("\nDeep crawling with prefetch mode...")
|
|
start = time.time()
|
|
|
|
result_container = await crawler.arun("https://books.toscrape.com", config=config)
|
|
|
|
# Handle iterator result from deep crawl
|
|
if hasattr(result_container, '__iter__'):
|
|
results = list(result_container)
|
|
else:
|
|
results = [result_container]
|
|
|
|
elapsed = time.time() - start
|
|
|
|
# Collect all discovered links
|
|
all_internal_links = set()
|
|
all_external_links = set()
|
|
|
|
for result in results:
|
|
for link in result.links.get("internal", []):
|
|
all_internal_links.add(link["href"])
|
|
for link in result.links.get("external", []):
|
|
all_external_links.add(link["href"])
|
|
|
|
print(f"\nResults:")
|
|
print(f" Pages crawled: {len(results)}")
|
|
print(f" Total internal links discovered: {len(all_internal_links)}")
|
|
print(f" Total external links discovered: {len(all_external_links)}")
|
|
print(f" Time: {elapsed:.2f}s")
|
|
|
|
|
|
async def example_prefetch_with_raw_html():
|
|
"""
|
|
Example 5: Prefetch with raw HTML input.
|
|
|
|
You can also use prefetch mode with raw: URLs for cached content.
|
|
"""
|
|
print("\n" + "=" * 60)
|
|
print("Example 5: Prefetch with Raw HTML")
|
|
print("=" * 60)
|
|
|
|
sample_html = """
|
|
<html>
|
|
<head><title>Sample Page</title></head>
|
|
<body>
|
|
<h1>Hello World</h1>
|
|
<nav>
|
|
<a href="/page1">Internal Page 1</a>
|
|
<a href="/page2">Internal Page 2</a>
|
|
<a href="https://example.com/external">External Link</a>
|
|
</nav>
|
|
<main>
|
|
<p>This is the main content with <a href="/page3">another link</a>.</p>
|
|
</main>
|
|
</body>
|
|
</html>
|
|
"""
|
|
|
|
async with AsyncWebCrawler(verbose=False) as crawler:
|
|
config = CrawlerRunConfig(
|
|
prefetch=True,
|
|
base_url="https://mysite.com", # For resolving relative links
|
|
)
|
|
|
|
result = await crawler.arun(f"raw:{sample_html}", config=config)
|
|
|
|
print(f"\nExtracted from raw HTML:")
|
|
print(f" Internal links: {len(result.links.get('internal', []))}")
|
|
for link in result.links.get("internal", []):
|
|
print(f" - {link['href']} ({link['text']})")
|
|
|
|
print(f"\n External links: {len(result.links.get('external', []))}")
|
|
for link in result.links.get("external", []):
|
|
print(f" - {link['href']} ({link['text']})")
|
|
|
|
|
|
async def main():
|
|
"""Run all examples."""
|
|
print("=" * 60)
|
|
print("Prefetch Mode and Two-Phase Crawling Examples")
|
|
print("=" * 60)
|
|
|
|
await example_basic_prefetch()
|
|
await example_performance_comparison()
|
|
await example_two_phase_crawl()
|
|
await example_prefetch_with_deep_crawl()
|
|
await example_prefetch_with_raw_html()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|