mirror of
https://github.com/ThePhaseless/Byparr.git
synced 2026-11-15 03:58:20 +00:00
ThePhaseless
406ad428c4
invisible-core 49.46+ looks up the egress IP and checks GitHub for a newer GeoIP database on every browser launch, so a network that blocks those hosts delayed every request by the lookup timeouts. Memoize both lookups (success for the process lifetime, failures retried after a backoff, proxied egress lookups uncached), warm them up in the FastAPI lifespan before the port opens, and gate get_browser() on the same warm-up. Drop the unused --init mode.
38 lines
2.3 KiB
Markdown
38 lines
2.3 KiB
Markdown
# Copilot Instructions
|
|
|
|
## Project overview
|
|
|
|
- FastAPI service that mimics FlareSolverr-style API for bypassing anti-bot pages using invisible_playwright.
|
|
- Entry point: main app in main.py; routes and request flow in src/endpoints.py, challenge handling in src/challenge.py, response bodies in src/content.py, models in src/models.py.
|
|
- Browser lifecycle is owned by get_browser() in src/utils.py, which yields a page and context for each request.
|
|
|
|
## Architecture and data flow
|
|
|
|
- Request flow: POST /v1 -> read_item() -> page.goto() -> wait for load states -> detect the interstitial -> click its checkbox until it clears -> return LinkResponse.
|
|
- Challenge detection uses detect_cloudflare_challenge() from playwright_captcha; the challenge is over when its markup goes, not when a solver says so.
|
|
- Health check hits /v1 internally with <https://google.com> and fails if status is not OK.
|
|
- Logging: LogRequest middleware logs only POST /v1 timing and outcome; other paths pass through.
|
|
|
|
## Key modules and patterns
|
|
|
|
- Models use Pydantic v2 with camelCase aliasing for responses (see src/models.py).
|
|
- LinkResponse.invalid() is the standard error response shape; keep fields consistent with FlareSolverr style.
|
|
- get_camoufox() constructs AsyncCamoufox with addons and optional proxy config from env vars.
|
|
- src/utils.py memoizes invisible-core's egress-IP and GeoIP lookups by replacing the private module attributes invisible_core._geo.discover_egress_ip and invisible_core.download.ensure_geoip_mmdb with RememberedLookup wrappers; proxied egress lookups pass straight through. warm_up() runs them once at start from the FastAPI lifespan, and get_browser() awaits it first so paths without the lifespan (TestClient without `with`) are gated too.
|
|
|
|
## Config and environment
|
|
|
|
- Core env vars in src/consts.py: HOST, PORT, PROXY_SERVER, PROXY_USERNAME, PROXY_PASSWORD, LOG_LEVEL, VERSION.
|
|
- VERSION strips leading "v" for tag-style values.
|
|
|
|
## Developer workflows
|
|
|
|
- Local run: uv sync && uv run main.py
|
|
- Tests: uv sync --group test && uv run pytest --retries 5
|
|
- Docker troubleshooting: docker build --target test .
|
|
|
|
## Tests and external dependencies
|
|
|
|
- tests/main_test.py calls real websites; tests are network-dependent and may be skipped based on upstream status.
|
|
- HTTP client tests use starlette.testclient + httpx; avoid mocking unless needed for local-only changes.
|