chore(deps): update python to ==3.14.* (#261)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.devcontainer/devcontainer.json

@@ -9,7 +9,11 @@
   "runArgs": ["--security-opt", "label=disable", "--privileged"],
   "customizations": {
     "vscode": {
-      "extensions": ["charliermarsh.ruff", "ms-python.python"],
+      "extensions": [
+        "charliermarsh.ruff",
+        "ms-python.python",
+        "tamasfe.even-better-toml"
+      ],
       "settings": {
         "python.venvPath": "./venv"
       }

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -9,10 +9,13 @@ body:
       label: "I've completed the following steps:"
       options:
         - label: Read Loop Warning on Readme
+        - label: "Used --init/init: true in docker run/compose.yaml"
         - label: Done the troubleshooting from Readme
         - label: Checked if such issue already exists
         - label: Checked other websites with Cloudflare Turnstile
         - label: I am able to access the webpage from my browser
+        - label: (Docker only) Checked that the problem does also occur on main tag
+
   - type: checkboxes
     attributes:
       label: "If checked other websites with Cloudflare Turnstile:"
@@ -20,11 +23,18 @@ body:
         - label: Other websites do work.
         - label: Other websites do not work.
 
+  - type: checkboxes
+    attributes:
+      label: "The issue is still present in the latest main tag:"
+      options:
+        - label: Yes
+        - label: No
+
   - type: input
     id: docker-host
     attributes:
       label: OS/Docker Host
-      placeholder: e.g. Docker, WSL2, Ubuntu, Windows 
+      placeholder: e.g. Docker, WSL2, Ubuntu, Windows
 
   - type: input
     id: platform-model
@@ -49,7 +59,7 @@ body:
       label: Describe the bug
       description: A clear and concise description of what the bug is.
       placeholder: "Example: The application crashes when trying to load a new file"
-  
+
   - type: textarea
     id: config
     attributes:

.github/workflows/docker-cleanup.yml

@@ -0,0 +1,107 @@
+name: Cleanup PR Docker Images
+
+on:
+  pull_request:
+    types: [closed]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - name: Delete PR Docker images
+        uses: actions/github-script@v8
+        with:
+          script: |
+            const owner = context.repo.owner.toLowerCase();
+            const repo = context.repo.repo.toLowerCase();
+            const prNumber = context.payload.pull_request.number;
+
+            // Get the package
+            const packageName = `${repo}`;
+
+            console.log(`Cleaning up images for PR #${prNumber}`);
+
+            // Check if owner is an org or user
+            let isOrg = false;
+            try {
+              await github.rest.orgs.get({ org: owner });
+              isOrg = true;
+              console.log(`Repository owner is an organization`);
+            } catch (error) {
+              console.log(`Repository owner is a user account`);
+            }
+
+            try {
+              // Get all versions of the package
+              let versions;
+              if (isOrg) {
+                versions = await github.rest.packages.getAllPackageVersionsForPackageOwnedByOrg({
+                  package_type: 'container',
+                  package_name: packageName,
+                  org: owner,
+                  per_page: 100
+                });
+              } else {
+                versions = await github.rest.packages.getAllPackageVersionsForPackageOwnedByUser({
+                  package_type: 'container',
+                  package_name: packageName,
+                  username: owner,
+                  per_page: 100
+                });
+              }
+
+              // Filter versions that match this PR (pr-123, pr-123-amd64, pr-123-arm64)
+              const prVersions = versions.data.filter(version => {
+                const tags = version.metadata?.container?.tags || [];
+                // Match tags like: pr-123, pr-123-amd64, pr-123-arm64
+                return tags.some(tag =>
+                  tag === `pr-${prNumber}` ||
+                  tag === `pr-${prNumber}-amd64` ||
+                  tag === `pr-${prNumber}-arm64`
+                );
+              });
+
+              console.log(`Found ${prVersions.length} image version(s) to delete`);
+
+              // Delete each version
+              for (const version of prVersions) {
+                console.log(`Deleting version ${version.id} with tags: ${version.metadata?.container?.tags?.join(', ')}`);
+                try {
+                  if (isOrg) {
+                    await github.rest.packages.deletePackageVersionForOrg({
+                      package_type: 'container',
+                      package_name: packageName,
+                      org: owner,
+                      package_version_id: version.id
+                    });
+                  } else {
+                    await github.rest.packages.deletePackageVersionForUser({
+                      package_type: 'container',
+                      package_name: packageName,
+                      username: owner,
+                      package_version_id: version.id
+                    });
+                  }
+                  console.log(`✓ Deleted version ${version.id}`);
+                } catch (error) {
+                  console.error(`Failed to delete version ${version.id}:`, error.message);
+                }
+              }
+
+              console.log('Cleanup completed');
+            } catch (error) {
+              if (error.status === 404) {
+                console.log('No package found - nothing to clean up');
+              } else {
+                console.error('Error during cleanup:', error.message);
+                throw error;
+              }
+            }

.github/workflows/docker-publish.yml

@@ -12,8 +12,26 @@ on:
     branches: ["*"]
     # Publish semver tags as releases.
     tags: ["v*.*.*"]
+    paths:
+      - "src/**"
+      - "main.py"
+      - "tests/**"
+      - "Dockerfile"
+      - "pyproject.toml"
+      - "uv.lock"
+      - "compose.yaml"
+      - ".github/workflows/docker-publish.yml"
   pull_request:
     branches: ["main"]
+    paths:
+      - "src/**"
+      - "main.py"
+      - "tests/**"
+      - "Dockerfile"
+      - "pyproject.toml"
+      - "uv.lock"
+      - "compose.yaml"
+      - ".github/workflows/docker-publish.yml"
   workflow_dispatch:
 
 env:
@@ -36,7 +54,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -54,6 +72,8 @@ jobs:
 
   build:
     needs: test
+    # Skip build for Renovate PRs
+    if: github.event.pull_request.user.login != 'renovate[bot]'
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -66,15 +86,20 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Prepare variables
         id: vars
         run: |
           SURFIX=$(echo ${{ matrix.platform }} | cut -d'/' -f2)
           echo "SURFIX=$SURFIX" >> $GITHUB_OUTPUT
-          # Generate a unique local tag for the image
-          echo "LOCAL_TAG=${{ github.sha }}-$SURFIX" >> $GITHUB_OUTPUT
+
+          # Use PR number for PRs, SHA for everything else
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            echo "LOCAL_TAG=pr-${{ github.event.pull_request.number }}-$SURFIX" >> $GITHUB_OUTPUT
+          else
+            echo "LOCAL_TAG=${{ github.sha }}-$SURFIX" >> $GITHUB_OUTPUT
+          fi
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -99,14 +124,14 @@ jobs:
           tags: type=raw,value=${{ steps.vars.outputs.LOCAL_TAG }}
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      # Build and export Docker image for each platform (without pushing)
+      # Build and push Docker image for each platform
       - name: Build Docker image
         id: build
         uses: docker/build-push-action@v6
         with:
           context: .
           pull: true
-          push: ${{ github.event_name != 'pull_request' }}
+          push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: ${{ matrix.platform }}
@@ -119,7 +144,6 @@ jobs:
   merge-and-push:
     needs: build
     runs-on: ubuntu-latest
-    if: github.event_name != 'pull_request'
     permissions:
       contents: read
       packages: write
@@ -127,7 +151,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       # Install the cosign tool
       - name: Install cosign
@@ -178,9 +202,16 @@ jobs:
 
           echo $args
 
-          docker buildx imagetools create $args \
-          ${image}:${{github.sha}}-amd64 \
-          ${image}:${{github.sha}}-arm64
+          # Use PR-based tags for PRs, SHA-based tags for everything else
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            docker buildx imagetools create $args \
+            ${image}:pr-${{ github.event.pull_request.number }}-amd64 \
+            ${image}:pr-${{ github.event.pull_request.number }}-arm64
+          else
+            docker buildx imagetools create $args \
+            ${image}:${{github.sha}}-amd64 \
+            ${image}:${{github.sha}}-arm64
+          fi
 
       # Sign the manifest
       - name: Sign the manifests

AGENTS.md

@@ -0,0 +1,37 @@
+# Copilot Instructions
+
+## Project overview
+
+- FastAPI service that mimics FlareSolverr-style API for bypassing anti-bot pages using Camoufox + Playwright captcha solver.
+- Entry point: main app in main.py; routes and request flow defined in src/endpoints.py and src/models.py.
+- Browser lifecycle is owned by get_camoufox() in src/utils.py, which yields a page, solver, and context for each request.
+
+## Architecture and data flow
+
+- Request flow: POST /v1 -> read_item() -> browser.goto() -> wait for load states -> detect challenge title -> solve captcha -> return LinkResponse.
+- Challenge detection uses CHALLENGE_TITLES from src/consts.py; update this map when adding providers.
+- 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.
+
+## 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
+- Init mode: uv run main.py --init (pre-warms health check via browser setup)
+- Tests: uv sync --group test && uv run pytest --retries 3
+- 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.

Dockerfile

@@ -1,8 +1,14 @@
-FROM debian:stable-slim AS base
-ENV HOME=/root
+# Ubuntu is required by playwright
+FROM ubuntu:latest AS base
 
 ARG GITHUB_BUILD=false \
-    VERSION
+    UV_CACHE_DIR=/var/cache/uv \
+    VERSION \
+    USER=ubuntu \
+    UID=1000
+
+ARG GROUP=${USER} \
+    GID=${UID}
 
 ENV GITHUB_BUILD=${GITHUB_BUILD}\
     VERSION=${VERSION}\
@@ -11,30 +17,39 @@ ENV GITHUB_BUILD=${GITHUB_BUILD}\
     # prevents python creating .pyc files
     PYTHONDONTWRITEBYTECODE=1 \
     UV_LINK_MODE=copy \
-    PATH="${HOME}/.local/bin:$PATH"
+    UV_CACHE_DIR=${UV_CACHE_DIR}
 
-WORKDIR /app
-
-RUN apt update && apt -y upgrade && apt install -y curl
-
-ADD https://astral.sh/uv/install.sh install.sh
-RUN sh install.sh && uv --version
-RUN uvx playwright install-deps firefox && uvx camoufox fetch
+RUN apt update &&\
+    apt -y upgrade &&\
+    apt install -y curl
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 
 FROM base AS devcontainer
-RUN apt install -y git
+RUN apt install -y git &&\
+    uvx playwright install-deps firefox &&\
+    uvx camoufox fetch
 ENTRYPOINT [ "sleep", "infinity" ]
 
-
 FROM base AS app
+WORKDIR /app
+RUN chown ${USER}:${GROUP} /app &&\
+    mkdir -p ${UV_CACHE_DIR} &&\
+    chown ${USER}:${GROUP} ${UV_CACHE_DIR}
+
+USER ${USER}
 COPY pyproject.toml uv.lock ./
-RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync
+RUN uv sync && uv run camoufox fetch
+
+USER root
+RUN uv run playwright install-deps firefox
+USER ${USER}
 
 COPY . .
 
 FROM app AS test
-RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync --group test
-RUN uv run pytest --retries 3 -n auto
+RUN \
+    uv sync --group test &&\
+    uv run pytest --retries 3
 
 FROM app
 EXPOSE 8191

README.md

@@ -1,44 +1,21 @@
 # Byparr
 
-Built with [camoufox](https://camoufox.com/) and [FastAPI](https://fastapi.tiangolo.com), this project aims to mimic [FlareSolverr's](https://github.com/FlareSolverr/FlareSolverr) API and functionality of providing you with http cookies and headers for websites protected with anti-bot protections.
+<p align="center">
+   <img src="icon/logo-byparr.svg" alt="Byparr logo" width="120" />
+</p>
 
 > [!IMPORTANT]
 > This software does not **guarantee** (only greatly increases the chance) that any challenge will be bypassed. While this tool passes the initial browser check, Cloudflare and other captcha providers likely require valid network traffic originating from the user’s public IP address to mark a connection as legitimate. If any website does not pass the challenge, please run troubleshooting steps and check if other websites work before you create an GitHub issue.
 
-> [!IMPORTANT]
-> Support for NAS devices (like Synology) is minimal. Please report issues, but do not expect it to be fixed quickly. The only ARM device I have is a free Ampere Oracle VM, so I can only test ARM support on that. See [#22](https://github.com/ThePhaseless/Byparr/issues/22) and [#3](https://github.com/ThePhaseless/Byparr/issues/3)
-
-> [!NOTE]
-> Thanks to FastAPI implementation, now you can also see the API documentation at `/docs` or `/` (redirect to `/docs`) endpoints.
-
-## Troubleshooting
-
-### Docker
-
-1. Clone repo to the host that has issues with Byparr.
-2. Run `docker build --target test .`
-3. Depending of the build success:
-   1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
-   2. If build fails, try troubleshooting on another host/using other method
-
-### Local
-
-1. Download [uv](https://docs.astral.sh/uv/getting-started/installation/)
-2. Download dependencies using `uv sync --group test`
-3. Run tests with `uv run pytest --retries 3` (You can add `-n auto` for parallelization)
-4. If you see any `F` character in terminal, that means test failed even after retries.
-5. Depending of the test success:
-   1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
-   2. If test fails, try troubleshooting on another host/using other method
-
 ## Options
 
 | Environment Variable | Default   | Description                                                                                                                                                       |
 | -------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `HOST`               | `0.0.0.0` | Host address to bind the server to. Use `0.0.0.0` to bind to all IPv4 interfaces, `::` for all IPv6 interfaces, or `127.0.0.1`/`localhost` for local access only. |
+| `PORT`               | `8191`    | Port to bind the server to.                                                                                                                                       |
 | `PROXY_SERVER`       | None      | Proxy to use in format: `protocol://host:port`.                                                                                                                   |
-| `PROXY_USERNAME`     | None      |                                                                                                                                                                   |
-| `PROXY_PASSWORD`     | None      |                                                                                                                                                                   |
+| `PROXY_USERNAME`     | None      | Username for proxy authentication.                                                                                                                                |
+| `PROXY_PASSWORD`     | None      | Password for proxy authentication.                                                                                                                                |
 
 ## Proxy Recommendation
 
@@ -48,30 +25,61 @@ Recently I've partnered with a _new in town_ proxy service - ProxyBase - to offe
 
 - `v*.*.*`/`latest` - Releases considered stable
 - `main` - Latest release from main branch (untested)
+- `pr-{number}` - Pull request images for testing (automatically cleaned up when PR closes)
 
 ## Usage
 
-### Docker Compose
+> [!IMPORTANT]
+> Support for NAS devices (like Synology) is minimal. Please report issues, but do not expect it to be fixed quickly. The only ARM device I have is a free Ampere Oracle VM, so I can only test ARM support on that. See [#22](https://github.com/ThePhaseless/Byparr/issues/22) and [#3](https://github.com/ThePhaseless/Byparr/issues/3)
 
-See `compose.yaml`
+### Docker Compose setup
 
-### Docker
+1. Review settings in `compose.yaml`.
+2. Start the service:
+
+```bash
+docker compose up -d
+```
+
+### Docker install
+
+1. Pull and run the image:
 
 ```bash
 docker run -p 8191:8191 ghcr.io/thephaseless/byparr:latest
 ```
 
-### Local
+1. Optional: set env vars using `-e` or `--env-file`.
 
-```bash
-uv sync && uv run main.py
-```
+### Local install
 
-## Need help with / TODO
+1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
+2. Run `uv run main.py`
+3. Profit.
 
-- [x] Slimming container (only ~1.11 GB now!)
-- [x] Add more anti-bot challenges
-- [x] Add doc strings
-- [x] Implement versioning
-- [x] Proxy support
-- [x] Add more architectures support
+### API Docs
+
+Once running, open:
+
+- `http://localhost:8191/docs`
+- `http://localhost:8191/` (redirects to `/docs`)
+
+## Troubleshooting
+
+### Docker troubleshooting
+
+1. Clone repo to the host that has issues with Byparr.
+2. Run `docker build --target test .`
+3. Depending of the build success:
+   1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
+   2. If build fails, try troubleshooting on another host/using other method
+
+### Local troubleshooting
+
+1. Download [uv](https://docs.astral.sh/uv/getting-started/installation/)
+2. Download dependencies using `uv sync --group test`
+3. Run tests with `uv run pytest --retries 3` (You can add `-n auto` for parallelization)
+4. If you see any `F` character in terminal, that means test failed even after retries.
+5. Depending of the test success:
+   1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
+   2. If test fails, try troubleshooting on another host/using other method

compose.yaml

@@ -2,6 +2,7 @@ services:
   byparr:
     image: ghcr.io/thephaseless/byparr:latest
     restart: unless-stopped
+    init: true
     build:
       context: .
       dockerfile: Dockerfile

icon/logo-byparr.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 512 512"><path d="M243.9 511.9c-58.1-3.2-110.4-24-155-61.8-7-5.9-21.2-20.1-27.2-27.2-20-23.7-35.2-49.2-45.4-76.5-8.3-22-13-42.6-15.5-67.3-1.1-10.8-1.1-35.7 0-46.5 5.6-54.9 25.6-101.9 61-143.8 5.9-7 20.1-21.2 27.2-27.2 23.7-20 49.2-35.2 76.5-45.4 22-8.3 42.7-13 67.3-15.5 10.8-1.1 35.7-1.1 46.5 0 29.1 3 55.1 9.7 80 20.7 39.2 17.3 72.8 43.6 99.6 78 5.3 6.7 14.8 21 19.4 29.1 15.8 27.6 26.4 58.3 31.1 89.8 2 13.6 2.5 21.5 2.5 37.5s-.5 23.9-2.5 37.5c-7.1 47.8-27.1 91.6-59.2 129.5-5.9 7-20.1 21.2-27.2 27.2-16.4 13.8-34.2 25.8-51.8 34.6-28.8 14.5-59.1 23.1-91.7 26.3-7.4.8-28.9 1.3-35.6 1" style="fill:#fff"/><path d="M246.5 395.1c-1.7-.2-3.9-.3-5-.2-1 .1-3.5 0-5.5-.2-2-.3-6.1-.8-9.3-1.2s-6.7-.9-7.8-1.2c-1.2-.3-7.7-3.2-14.5-6.6s-14.3-7-16.8-8.1c-8.5-3.7-14.5-8.1-18.1-13.4-2.1-3.1-3.7-4.4-8.2-6.7-4-2-6-4.1-10.9-11-2-2.9-5-6.8-6.6-8.7-10.9-12.9-11.1-13.3-12.4-19.5-.5-2.5-1.6-5.4-2.9-7.8-4-7.4-5.4-10.8-6.4-14.9-.5-2.3-1.7-6.6-2.6-9.6-1.5-5.1-1.7-6.1-2.1-15.8-.4-9.4-.4-10.9.5-16.1.5-3.2 1.1-7.4 1.2-9.4.2-2 .6-5.4 1-7.6s.9-6.5 1.2-9.5c1-9.8 2.6-14.1 9.1-23.8 4.2-6.2 5.2-8.5 6-13.5.6-3.9 1.4-5.7 4.1-8.9 1.2-1.5 3.5-5.4 5.1-8.6 3.1-6.4 3.2-6.5 8.2-9.9 1.9-1.3 5.8-4 8.6-6s6.3-4.4 7.6-5.4c1.7-1.2 3.1-2.7 4.3-4.6 4.1-6.6 6.1-8 16.3-11.7 3.1-1.1 7.5-3.1 9.8-4.5 5.3-3.1 9-4.4 15-5 2.8-.3 6.8-1.2 9.8-2.1 4.5-1.4 5.6-1.6 10.4-1.6 5.7 0 6.4-.2 13.2-3.1 4.8-2.1 8.9-2.5 14.8-1.5 2.7.5 7.2 1.1 10.1 1.5 6.2.8 6.1.8 11.2 3.1 3.4 1.5 4.9 1.9 9.3 2.3 7 .7 7.9 1 16.1 5.1 3.9 2 9.5 4.5 12.4 5.7 9.8 3.9 14.3 7.2 22.1 15.7 3.3 3.6 8.6 9.2 11.9 12.5 14.5 14.5 14.9 15 16.5 19.4.8 2.2 2.6 6 3.9 8.3 5.2 9.2 12.2 23.8 13.4 28 .7 2.3 1.9 6.5 2.7 9.3 2.1 6.9 2.4 14.2 1 23.6-1.2 8-1.2 11.9-.3 18 .6 3.6.6 5.5.3 9.4-.7 6.7-1.6 10-4.1 14.1-1.3 2.2-2.4 4.7-2.9 6.6-1.8 7.8-5.6 16.3-10.7 24.3-1.4 2.2-3.4 5.5-4.3 7.4-2.2 4.3-4.2 6.6-8.2 9.6-3.7 2.7-14.5 14-17.7 18.4-2.2 3.1-7.1 7.4-10.6 9.4-1.1.6-4.3 1.8-7.2 2.6s-7.1 2.5-9.5 3.7c-3.6 1.8-5 3-8.6 6.6-2.3 2.4-4.9 4.7-5.7 5.1-1.6.8-5.5 1.5-10.7 2-1.7.2-4.6.8-6.4 1.5-7 2.6-7.3 2.6-16.1 2.7-6.9.1-9.3.3-12.3 1.2-4.9.9-8.8 1.2-12.7.6" style="fill:#cc7a3d"/><path d="M237.7 473.6c-42-3.8-79.9-18.3-113-43.2C56 378.7 24.1 291.7 43.1 207.6c6.6-29.2 19.8-57.8 37.7-81.9 47.7-64.1 126.8-97.1 205.8-85.9 36 5.1 70.5 19.3 99.7 41C455.7 132.5 488 220 468.9 304.4c-11.4 50.4-40.9 95.7-82.6 126.8-29.1 21.7-63.7 35.9-99.7 41-15.1 2.2-34.5 2.7-48.9 1.4m33.7-5.2c29-2.5 54.4-9.5 79-21.8 41.4-20.6 75.5-54.8 96.1-96.1 16.9-34 24.9-74.2 21.8-109.9-3.7-42.4-17.6-79.2-42.3-112-34.4-45.8-84.7-75.5-141.4-83.5-25.2-3.6-49.5-2.5-75.2 3.3-49.6 11.2-93.7 40-124.4 81.2-21.3 28.7-35 62-40.1 97.8-2.8 19.4-2.8 38 0 57.4 8.1 56.7 37.7 107 83.5 141.4 11.1 8.3 21 14.5 33 20.5 34.1 16.9 74.4 24.8 110 21.7" style="fill:#b1b1b1"/><path d="M253.9 367.3c-2.9-.7-4.3-1.4-6-2.9-2.9-2.6-3.9-4.9-3.9-8.9 0-3.9 1-6.3 3.9-8.9 6-5.4 15.8-3.1 19 4.3 1.1 2.6 1 7-.3 9.6-1.2 2.4-3.7 4.9-6 5.8-1.7.8-5.3 1.3-6.7 1m68.4-29.3c-9.2-3.4-11-15.4-3.1-21.1 8.1-5.9 20 1 18.8 11-.5 4-3 7.6-6.7 9.5-2.4 1.2-6.6 1.5-9 .6m-139.8-.2c-3.4-1.1-6.2-3.5-7.9-6.7-1.3-2.4-1.2-7.7.2-10.2 1.2-2.3 3.9-4.8 6.3-5.8 2.6-1.1 7-1 9.6.3 4.2 2.1 6.7 6 6.7 10.7 0 6.5-4.7 11.5-11 11.9-1.5.1-3.3 0-3.9-.2m43.2-22.8c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m54.6 0c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m-27.6-47c-2.2-.7-4-1.9-5.5-3.5-2.5-2.7-3.2-4.5-3.2-8.5 0-3.9.7-5.8 3.2-8.5s4.8-3.6 8.8-3.6 6.3.9 8.8 3.6 3.2 4.5 3.2 8.5c0 2.5-.3 4-.9 5.2-1.2 2.3-3.5 4.7-5.7 5.8-1.9 1.1-6.7 1.6-8.7 1m99.7 0c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m-198.9-.7c-8.9-2.5-11.8-13.8-5.1-20.1 2.6-2.5 4.5-3.2 8.2-3.2 3.9 0 6.3 1 8.9 3.9 2.1 2.3 3 4.7 2.9 8.2 0 7.6-7.5 13.2-14.9 11.2m42.9-.4c-2.3-1.2-5.2-4.1-6.1-6.4-1-2.4-.9-7.1.3-9.5 1.1-2.3 4.1-5.2 6.4-6.2 2.4-1 7.1-.9 9.5.3 2.3 1.1 5.2 4.1 6.2 6.4 1 2.4.9 7.1-.3 9.5-1.1 2.3-4.1 5.2-6.4 6.2-2.5 1.1-7.2.9-9.6-.3m109-.3c-11.1-5.6-7-22.5 5.5-22.4 3.7 0 6.1 1.1 8.6 3.9 2.2 2.4 3.2 4.9 3.2 8s-1 5.6-3.2 8c-2.5 2.8-5 3.9-8.6 3.9-2.3-.1-3.5-.4-5.5-1.4m-79.7-46.3c-8.9-2.5-11.8-13.8-5.1-20.1 2.6-2.5 4.5-3.2 8.2-3.2 3.9 0 6.3 1 8.9 3.9 2.1 2.3 3 4.7 2.9 8.2-.1 7.6-7.6 13.3-14.9 11.2m54.5 0c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.1-8.6 7.8-13.9 6.3m43.2-22.8c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.2-8.6 7.8-13.9 6.3m-140.6-.5c-8.7-2.4-11.6-13-5.4-19.7 2.5-2.6 4.8-3.6 8.6-3.6 3.9 0 6.3 1.1 8.8 3.8 2.2 2.5 3 4.7 3 8 .1 8-7.3 13.6-15 11.5m70.3-28.9c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.1-8.5 7.8-13.9 6.3" style="fill:#884717"/></svg>

main.py

@@ -2,19 +2,19 @@ from __future__ import annotations
 
 import asyncio
 import logging
-import os
 import sys
 
 import uvicorn
 from fastapi import FastAPI
 from fastapi.middleware.gzip import GZipMiddleware
 
-from src.consts import LOG_LEVEL, VERSION
+from src.consts import HOST, LOG_LEVEL, PORT, VERSION
 from src.endpoints import health_check, router
 from src.middlewares import LogRequest
 from src.utils import get_camoufox, logger
 
 logger.info("Using version %s", VERSION)
+logger.info("Log level set to %s", logging.getLevelName(LOG_LEVEL))
 
 app = FastAPI(debug=LOG_LEVEL == logging.DEBUG, log_level=LOG_LEVEL)
 app.add_middleware(GZipMiddleware)
@@ -38,5 +38,4 @@ if __name__ == "__main__":
         loop.run_until_complete(init())
         logger.info("Initialization complete.")
     else:
-        host = os.getenv("HOST", "0.0.0.0")  # noqa: S104
-        uvicorn.run(app, host=host, port=8191)
+        uvicorn.run(app, host=HOST, port=PORT)

pyproject.toml

@@ -2,30 +2,29 @@
 [project]
 authors = [{ name = "ThePhaseless", email = "kukubaorch@gmail.com" }]
 license = { text = "LICENSE" }
-requires-python = "<4.0,>=3.12"
+requires-python = "==3.14.*"
 name = "Byparr"
 version = "0.1.0"
 description = "API for getting cookies for Cloudflare challenges"
 readme = "README.md"
 dependencies = [
     "camoufox[geoip]==0.4.*",
-    "fastapi[standard]==0.116.*",
+    "fastapi[standard]==0.128.*",
     "playwright-captcha==0.1.*",
-    "pydantic==2.11.*",
+    "pydantic==2.*",
 ]
 urls = { repository = "https://github.com/ThePhaseless/Byparr" }
 
 [dependency-groups]
 test = [
     "httpx==0.28.*",
-    "pytest==8.4.*",
-    "pytest-asyncio==1.1.*",
-    "pytest-progress==1.3.*",
+    "pytest==9.0.*",
+    "pytest-asyncio==1.3.*",
     "pytest-retry==1.7.*",
     "pytest-xdist==3.8.*",
     "setuptools>=80.9.0",
 ]
-dev = ["deptry==0.23.*", "ruff==0.12.*"]
+dev = ["deptry==0.24.*", "ruff==0.15.*"]
 
 [tool.deptry.per_rule_ignores]
 DEP002 = ["pyautogui"]

src/consts.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import sys
 from pathlib import Path
 
 from playwright_captcha import CaptchaType
@@ -12,13 +13,15 @@ LOG_LEVEL = logging.getLevelNamesMapping()[os.getenv("LOG_LEVEL", "INFO").upper(
 VERSION = os.getenv("VERSION", "unknown").removeprefix("v")
 
 ADDON_PATH = str(Path(get_addon_path()).absolute())
-MAX_ATTEMPTS = 2**10
-
+MAX_ATTEMPTS = sys.maxsize
 
 PROXY_SERVER = os.getenv("PROXY_SERVER")
 PROXY_USERNAME = os.getenv("PROXY_USERNAME")
 PROXY_PASSWORD = os.getenv("PROXY_PASSWORD")
 
+HOST = os.getenv("HOST", "0.0.0.0")  # noqa: S104
+PORT = int(os.getenv("PORT", "8191"))
+
 CHALLENGE_TITLES_MAP: dict[CaptchaType, list[str]] = {
     # Cloudflare
     CaptchaType.CLOUDFLARE_INTERSTITIAL: ["Just a moment..."],

src/endpoints.py

@@ -6,7 +6,6 @@ from typing import Annotated
 
 from fastapi import APIRouter, Depends, HTTPException
 from fastapi.responses import RedirectResponse
-from httpx import TimeoutException
 from playwright_captcha import CaptchaType
 
 from src.consts import CHALLENGE_TITLES
@@ -16,14 +15,14 @@ from src.models import (
     LinkResponse,
     Solution,
 )
-from src.utils import CamoufoxDepType, get_camoufox, logger
+from src.utils import CamoufoxDepClass, TimeoutTimer, get_camoufox, logger
 
 warnings.filterwarnings("ignore", category=SyntaxWarning)
 
 
 router = APIRouter()
 
-CamoufoxDep = Annotated[CamoufoxDepType, Depends(get_camoufox)]
+CamoufoxDep = Annotated[CamoufoxDepClass, Depends(get_camoufox)]
 
 
 @router.get("/", include_in_schema=False)
@@ -55,32 +54,41 @@ async def read_item(request: LinkRequest, dep: CamoufoxDep) -> LinkResponse:
     """Handle POST requests."""
     start_time = int(time.time() * 1000)
 
-    request.url = request.url.replace('"', "").strip()
-    page_request = await dep.page.goto(request.url)
-    await dep.page.wait_for_load_state(state="domcontentloaded")
-    await dep.page.wait_for_load_state("networkidle")
+    timer = TimeoutTimer(duration=request.max_timeout)
 
-    if await dep.page.title() in CHALLENGE_TITLES:
-        logger.info("Challenge detected, attempting to solve...")
-        # Solve the captcha
-        remaining_timeout = (
-            request.max_timeout - (int(time.time()) * 1000 - start_time) / 1000
+    request.url = request.url.replace('"', "").strip()
+    try:
+        page_request = await dep.page.goto(
+            request.url, timeout=timer.remaining() * 1000
         )
-        logger.debug(
-            "Remaining timeout for solving the challenge: %d ms", remaining_timeout
+        status = page_request.status if page_request else HTTPStatus.OK
+        await dep.page.wait_for_load_state(
+            state="domcontentloaded", timeout=timer.remaining() * 1000
         )
-        try:
+        await dep.page.wait_for_load_state(
+            "networkidle", timeout=timer.remaining() * 1000
+        )
+
+        if await dep.page.title() in CHALLENGE_TITLES:
+            logger.info("Challenge detected, attempting to solve...")
+            # Solve the captcha
             await wait_for(
                 dep.solver.solve_captcha(  # pyright: ignore[reportUnknownMemberType,reportUnknownArgumentType]
                     captcha_container=dep.page,
                     captcha_type=CaptchaType.CLOUDFLARE_INTERSTITIAL,
+                    wait_checkbox_attempts=1,
+                    wait_checkbox_delay=0.5,
                 ),
-                timeout=remaining_timeout,
+                timeout=timer.remaining(),
             )
-        except TimeoutException as e:
-            logger.error("Failed to solve challenge: %s", e)
-            return LinkResponse.invalid(url=request.url)
-        logger.debug("Challenge solved successfully.")
+            status = HTTPStatus.OK
+            logger.debug("Challenge solved successfully.")
+    except TimeoutError as e:
+        logger.error("Timed out while solving the challenge")
+        raise HTTPException(
+            status_code=408,
+            detail="Timed out while solving the challenge",
+        ) from e
 
     cookies = await dep.context.cookies()
 
@@ -89,7 +97,7 @@ async def read_item(request: LinkRequest, dep: CamoufoxDep) -> LinkResponse:
         solution=Solution(
             user_agent=await dep.page.evaluate("navigator.userAgent"),
             url=dep.page.url,
-            status=page_request.status if page_request else HTTPStatus.OK,
+            status=status,
             cookies=cookies,
             headers=page_request.headers if page_request else {},
             response=await dep.page.content(),

src/middlewares.py

@@ -25,6 +25,6 @@ class LogRequest(BaseHTTPMiddleware):
         if response.status_code == HTTPStatus.OK:
             logger.info(f"Done {request_body.url} in {process_time:.2f}s")
         else:
-            logger.info(f"Failed {request_body.url} in {process_time:.2f}s")
+            logger.warning(f"Failed {request_body.url} in {process_time:.2f}s")
 
         return response

src/models.py

@@ -25,7 +25,7 @@ class LinkRequest(BaseModel):
 
 class HealthcheckResponse(BaseModel):
     model_config = {"alias_generator": to_camel, "populate_by_name": True}
-    msg: str = "Byparr is ready!"
+    msg: str = "Byparr is working!"
     version: str = consts.VERSION
     user_agent: str
 

src/utils.py

@@ -1,13 +1,16 @@
 import logging
+import time
 from collections.abc import AsyncGenerator
-from typing import NamedTuple, cast
+from typing import Annotated, NamedTuple, cast
 
 from camoufox import AsyncCamoufox
+from fastapi import Header
 from playwright.async_api import Browser, BrowserContext, Page
 from playwright_captcha import (
     ClickSolver,
     FrameworkType,
 )
+from pydantic import BaseModel, Field
 
 from src.consts import (
     ADDON_PATH,
@@ -18,9 +21,13 @@ from src.consts import (
     PROXY_USERNAME,
 )
 
-solver_logger = logging.getLogger("playwright_captcha.solvers")
+solver_logger = logging.getLogger("playwright_captcha")
 solver_logger.handlers.clear()
-solver_logger.handlers.append(logging.NullHandler())
+if LOG_LEVEL == logging.DEBUG:
+    solver_logger.addHandler(logging.StreamHandler())
+    solver_logger.setLevel(LOG_LEVEL)
+else:
+    solver_logger.handlers.append(logging.NullHandler())
 
 logger = logging.getLogger("uvicorn.error")
 logger.setLevel(LOG_LEVEL)
@@ -28,23 +35,61 @@ if len(logger.handlers) == 0:
     logger.addHandler(logging.StreamHandler())
 
 
-class CamoufoxDepType(NamedTuple):
+class TimeoutTimer(BaseModel):
+    duration: int  # in seconds
+    start_time: float = Field(default_factory=time.perf_counter)
+
+    def remaining(self) -> float:
+        """Get remaining time in seconds."""
+        return max(0, self.duration - (time.perf_counter() - self.start_time))
+
+
+class CamoufoxDepClass(NamedTuple):
     page: Page
     solver: ClickSolver
     context: BrowserContext
 
 
-async def get_camoufox() -> AsyncGenerator[CamoufoxDepType, None]:
+async def get_camoufox(
+    x_proxy_server: Annotated[
+        str | None,
+        Header(
+            alias="X-Proxy-Server",
+            description="Override proxy server for this request in protocol://host:port format.",
+        ),
+    ] = None,
+    x_proxy_username: Annotated[
+        str | None,
+        Header(
+            alias="X-Proxy-Username",
+        ),
+    ] = None,
+    x_proxy_password: Annotated[
+        str | None,
+        Header(
+            alias="X-Proxy-Password",
+        ),
+    ] = None,
+) -> AsyncGenerator[CamoufoxDepClass]:
     """Get Camoufox instance."""
-    proxy_config = (
-        {
+    header_server = x_proxy_server
+    header_username = x_proxy_username
+    header_password = x_proxy_password
+
+    proxy_config = None
+
+    if header_server:
+        proxy_config = {
+            "server": header_server,
+            "username": header_username,
+            "password": header_password,
+        }
+    elif PROXY_SERVER:
+        proxy_config = {
             "server": PROXY_SERVER,
             "username": PROXY_USERNAME,
             "password": PROXY_PASSWORD,
         }
-        if PROXY_SERVER
-        else None
-    )
 
     async with AsyncCamoufox(
         main_world_eval=True,
@@ -68,4 +113,4 @@ async def get_camoufox() -> AsyncGenerator[CamoufoxDepType, None]:
             max_attempts=MAX_ATTEMPTS,
             attempt_delay=1,
         ) as solver:
-            yield CamoufoxDepType(page, solver, context)
+            yield CamoufoxDepClass(page, solver, context)