fix latest tagging

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

.devcontainer/Dockerfile

@@ -1,5 +1,4 @@
-FROM python:3.12
+FROM ghcr.io/astral-sh/uv:debian
+ENV UV_LINK_MODE=copy
 
-RUN apt update && apt upgrade -y && apt install -y chromium xvfb
-
-RUN curl -sSL https://install.python-poetry.org | python3 -
+RUN apt update && apt upgrade -y && apt install -y chromium chromium-driver xvfb git

.devcontainer/devcontainer.json

@@ -32,6 +32,7 @@
     "8181:8191"
   ],
   "features": {
-    "ghcr.io/devcontainers-extra/features/act:1": {}
+    "ghcr.io/devcontainers-extra/features/act:1": {},
+    "ghcr.io/devcontainers/features/desktop-lite:1": {}
   }
 }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**I've:**
-- [ ] - read Loop Warning on Readme.
-- [ ] - done the troubleshooting from Readme.
-- [ ] - checked if such issue already exists.
-
-**Docker host (please complete the following information):**
- - OS: [e.g. Ubuntu Linux]
- - Platform and model: [Synology, PC, Laptop, RPi 3]
- - Architecture [e.g. ARM64]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,47 @@
+name: Bug report
+description: Create a bug report
+assignees: ThePhaseless
+
+body:
+  - type: checkboxes
+    attributes:
+      label: "I've completed the following steps:"
+      options:
+        - label: Read Loop Warning on Readme
+        - label: Done the troubleshooting from Readme
+        - label: Checked if such issue already exists
+
+  - type: input
+    id: docker-host
+    attributes:
+      label: OS
+      placeholder: e.g. Docker, Ubuntu Linux
+
+  - type: input
+    id: platform-model
+    attributes:
+      label: Platform and model
+      placeholder: e.g. Synology, PC, Laptop, RPi 3
+
+  - type: input
+    id: architecture
+    attributes:
+      label: Architecture
+      placeholder: e.g. ARM64
+
+  - type: input
+    id: website
+    attributes:
+      label: Website
+      placeholder: e.g. https://nowsecure.nl
+
+  - type: textarea
+    attributes:
+      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
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/dependabot.yml

@@ -1,16 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for more information:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-# https://containers.dev/guide/dependabot
-
-version: 2
-updates:
-  - package-ecosystem: "devcontainers"
-    directory: "/"
-    schedule:
-      interval: weekly
-  - package-ecosystem: github-actions
-    directory: ".github/workflows/"
-    schedule:
-      interval: weekly

.github/workflows/docker-publish.yml

@@ -14,6 +14,7 @@ on:
     tags: ["v*.*.*"]
   pull_request:
     branches: ["main"]
+  workflow_dispatch:
 
 env:
   # Use docker.io for Docker Hub if empty
@@ -24,38 +25,28 @@ env:
 jobs:
   test:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Test
+        id: test
+        uses: docker/build-push-action@v6
         with:
-          python-version: "3.12"
-
-      - name: Set up Poetry
-        run: pip install poetry
-
-      - name: Setup a local virtual environment (if no poetry.toml file)
-        run: |
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
-
-      - uses: actions/cache@v4
-        name: Define a cache for the virtual environment based on the dependencies lock file
-        with:
-          path: ./.venv
-          key: venv-${{ hashFiles('poetry.lock') }}
-
-      - name: Install dependencies
-        run: |
-          poetry install
-          sudo apt update
-          sudo apt install -y xvfb scrot python3-tk
-          wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
-          sudo apt install -y ./google-chrome-stable_current_amd64.deb
-          rm ./google-chrome-stable_current_amd64.deb
-
-      - name: Run tests
-        run: poetry run pytest
+          context: .
+          platforms: linux/amd64
+          cache-from: type=gha,scope=x64
+          pull: true
+          cache-to: type=gha,mode=max,scope=x64
+          target: test
 
   build:
     needs: test
@@ -63,43 +54,95 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # This is used to complete the identity challenge
-      # with sigstore/fulcio when running outside of PRs.
       id-token: write
 
+    strategy:
+      matrix:
+        platform: [linux/amd64, linux/arm64]
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      # Install the cosign tool except on PR
-      # https://github.com/sigstore/cosign-installer
-      - name: Install cosign
-        if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da #v3.7.0
-        with:
-          cosign-release: "v2.2.4"
+      - 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
 
-      # Set up BuildKit Docker container builder to be able to build
-      # multi-platform images and export cache
-      # https://github.com/docker/setup-buildx-action
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      # Set up BuildKit Docker container builder
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
+        uses: docker/setup-buildx-action@v3
 
-      # Login against a Docker registry except on PR
-      # https://github.com/docker/login-action
+      # Log into registry
       - name: Log into registry ${{ env.REGISTRY }}
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       # Extract metadata (tags, labels) for Docker
-      # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        uses: docker/metadata-action@v5
+        with:
+          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)
+      - name: Build Docker image
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          pull: true
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: ${{ matrix.platform }}
+          cache-from: type=gha,scope=${{ matrix.platform }}
+          cache-to: type=gha,mode=max,scope=${{ matrix.platform }}
+          build-args: GITHUB_BUILD=true,VERSION=${{ github.ref_type == 'tag' && github.ref_name || github.sha }}
+
+  merge-and-push:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install the cosign tool
+      - name: Install cosign
+        uses: sigstore/cosign-installer@v3
+
+      # Set up Docker Buildx
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # Log into registry
+      - name: Log into registry ${{ env.REGISTRY }}
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract Docker metadata for tagging
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
         with:
           tags: |
             type=ref,event=branch
@@ -107,35 +150,37 @@ jobs:
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
-            type=raw,enable=${{ github.event_name != 'pull_request' && github.ref_name == 'main' }}, value=latest
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      # Build and push Docker image with Buildx (don't push on PR)
-      # https://github.com/docker/build-push-action
-      - name: Build and push Docker image
-        id: build-and-push
-        uses: docker/build-push-action@4f58ea79222b3b9dc2c8bbdd6debcef730109a75 # v6.9.0
-        with:
-          context: .
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-          build-args: GITHUB_BUILD=true
+      # Create manifest lists and push
+      - name: Create and push manifest lists
+        run: |
+          TAGS="${{ steps.meta.outputs.tags }}"
+          args=""
 
-      # Sign the resulting Docker image digest except on PRs.
-      # This will only write to the public Rekor transparency log when the Docker
-      # repository is public to avoid leaking data.  If you would like to publish
-      # transparency data even for private images, pass --force to cosign below.
-      # https://github.com/sigstore/cosign
-      - name: Sign the published Docker image
-        if: ${{ github.event_name != 'pull_request' }}
+          image=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          image=${image,,}
+
+          # Create tag arguments
+          for tag in $TAGS; do
+              args="$args -t $tag"
+          done
+
+          if [ "${{ github.ref_type }}" == "tag" ]; then
+            args="$args -t ${image}:latest"
+          fi
+
+          echo $args
+
+          docker buildx imagetools create $args \
+          ${image}:${{github.sha}}-amd64 \
+          ${image}:${{github.sha}}-arm64
+
+      # Sign the manifest
+      - name: Sign the manifests
         env:
-          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
           TAGS: ${{ steps.meta.outputs.tags }}
-          DIGEST: ${{ steps.build-and-push.outputs.digest }}
-        # This step uses the identity token to provision an ephemeral certificate
-        # against the sigstore community Fulcio instance.
-        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}
+        run: |
+          for TAG in $TAGS; do
+            cosign sign --yes $TAG
+          done

.gitignore

@@ -165,7 +165,7 @@ cython_debug/
 core
 
 # Screenshots
-*.png
+screenshots/
 
 # Downloaded files
 downloaded_files/

.vscode/launch.json

@@ -1,27 +1,19 @@
 {
+    "configurations": [
+        {
+            "console": "integratedTerminal",
+            "env": {
+                "LOG_LEVEL": "DEBUG"
+            },
+            "justMyCode": false,
+            "name": "Python Debugger: Main",
+            "program": "main.py",
+            "request": "launch",
+            "type": "debugpy"
+        },
+    ],
     // Use IntelliSense to learn about possible attributes.
     // Hover to view descriptions of existing attributes.
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Python Debugger: Main",
-            "type": "debugpy",
-            "justMyCode": false,
-            "env": {
-                "LOG_LEVEL": "DEBUG",
-            },
-            "request": "launch",
-            "program": "main.py",
-            "console": "integratedTerminal"
-        },
-        {
-            "name": "Python Debugger: Current File",
-            "justMyCode": false,
-            "type": "debugpy",
-            "request": "launch",
-            "program": "${file}",
-            "console": "integratedTerminal"
-        }
-    ]
+    "version": "0.2.0"
 }

.vscode/settings.json

@@ -1,20 +1,23 @@
 {
-    "python.testing.pytestArgs": [
-        "tests"
-    ],
-    "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true,
-    "python.analysis.autoImportCompletions": true,
-    "python.analysis.typeCheckingMode": "basic",
-    "python.terminal.activateEnvironment": true,
     "[python]": {
-        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.defaultFormatter": "charliermarsh.ruff"
     },
+    "python.analysis.autoImportCompletions": true,
     "python.analysis.packageIndexDepths": [
         {
-            "name": "",
             "depth": 5,
             "includeAllSymbols": true,
+            "name": ""
         }
     ],
+    "python.analysis.typeCheckingMode": "standard",
+    "python.terminal.activateEnvironment": true,
+    "python.testing.pytestArgs": [
+        "tests",
+        "-n",
+        "auto",
+        "--retries=3",
+    ],
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false
 }

Dockerfile

@@ -1,30 +1,40 @@
-FROM python:3.12-slim
+FROM debian:bullseye-slim AS base
 
-# Inspired by https://github.com/Hudrolax/uc-docker-alpine/
+ARG GITHUB_BUILD=false \
+    VERSION
 
-ARG GITHUB_BUILD=false
-ENV GITHUB_BUILD=${GITHUB_BUILD}
-
-ENV HOME=/root
-ENV \
+ENV HOME=/root \
+    GITHUB_BUILD=${GITHUB_BUILD}\
+    VERSION=${VERSION}\
     DEBIAN_FRONTEND=noninteractive \
     PYTHONUNBUFFERED=1 \
     # prevents python creating .pyc files
     PYTHONDONTWRITEBYTECODE=1 \
-    # do not ask any interactive question
-    POETRY_NO_INTERACTION=1 \
-    POETRY_VIRTUALENVS_IN_PROJECT=true \
     DISPLAY=:0
+ENV PATH="${HOME}/.local/bin:$PATH"
 
 WORKDIR /app
-EXPOSE 8191
-RUN apt update &&\
-    apt install -y xvfb scrot python3-tk curl chromium
 
-RUN curl -sSL https://install.python-poetry.org | python3 -
-ENV PATH="${HOME}/.local/bin:$PATH"
-COPY pyproject.toml poetry.lock ./
-RUN poetry install
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends --no-install-suggests xauth xvfb scrot wget chromium chromium-driver ca-certificates
+
+ADD https://astral.sh/uv/install.sh install.sh
+RUN sh install.sh
+COPY pyproject.toml uv.lock ./
+RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync
+
+# SeleniumBase does not come with an arm64 chromedriver binary
+RUN cd .venv/lib/*/site-packages/seleniumbase/drivers && ln -s /usr/bin/chromedriver uc_driver
 
 COPY . .
-CMD [". .venv/bin/activate && python3 main.py"]
+
+FROM base AS test
+
+RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync --group test
+RUN ./test.sh
+
+FROM base
+
+EXPOSE 8191
+HEALTHCHECK --interval=15m --timeout=30s --start-period=5s --retries=3 CMD [ "curl", "http://localhost:8191/health" ]
+CMD ["./cmd.sh"]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,56 +1,72 @@
 # Byparr
 
-An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) as a drop-in replacement, build with [nodriver](https://github.com/ultrafunkamsterdam/nodriver) and [FastAPI](https://fastapi.tiangolo.com).
-
-> [!WARNING]
-> Due to recent challenge changes, this software does not guarantee that the Cloudflare challenge will be bypassed. Cloudflare likely requires valid network traffic originating from the user’s public IP address to mark a connection as legitimate. While this tool may bypass the initial browser check, it does not ensure that requests will consistently pass Cloudflare's validation. More testing and data are required to understand how Cloudflare identifies connections and requests as valid. Invalid requests will result in Byparr's looping and eventually timeouting.
+An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) as a drop-in replacement, built with [seleniumbase](https://seleniumbase.io/) and [FastAPI](https://fastapi.tiangolo.com).
 
 > [!IMPORTANT]
-> Currenly, due to [bug in nodriver](https://github.com/ultrafunkamsterdam/undetected-chromedriver/issues/1954), if you want to run this project ouside of prebuild container, you have to run `python fix_nodriver.py` after creating venv to patch the library.
+> Due to recent challenge changes, this software does not guarantee that the Cloudflare challenge will be bypassed. Cloudflare likely requires valid network traffic originating from the user’s public IP address to mark a connection as legitimate. While this tool may bypass the initial browser check, it does not ensure that requests will consistently pass Cloudflare's validation. More testing and data are required to understand how Cloudflare identifies connections and requests as valid. Invalid requests will result in Byparr's looping and eventually time-outing.
+
+> [!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.
 
-## Early Development
-
-Long story short, I created it in like 3 days, so if you get any bugs/hangs etc. please report it, so both of us can enjoy unblocked websites!
-
-I focus maily on Cloudflare, which is tested daily, any other anti-bot challenges should pass out of the box, but if any issues, please report these providers with an example website ❤️
-
 ## Troubleshooting
 
-1. Clone repo to the host that has the container has issues on.
-2. Using vscode and `SSH extention`, connect to the host and open repo in it.
-4. Download `devcontainers` extention and reopen repo in container (with `CTRL + SHIFT + P` -> `Reopen in devcontainer`)
-3. Open vscode terminal (`` CTRL + ` ``) and run `./run_vnc.sh` script.
-5. Write down the port from `Forwarded Address` in `Ports` tab in vscode (probably 5900).
-6. Open <https://novnc.com/noVNC/vnc.html> in your pc's browser and using settings on left under websocket, set host to `localhost` nad port to the port you wrote down and disable encryption.
-7. Connect to the VNC server on container.
-8. Check if `chromium` works by running in VNC's terminal command `chromium --no-sandbox`
-9. If chromium works, run (or run debug) tests from VS Code.
-10. Check if everything works by observing VNC in the browser as code is being tested.
-11. If code works, congrats! (/s) You are on your own.
-12. If it does not, try another host or network and try again.
+### 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
+
+| Env            | Default                | Description                                                                                                                     |
+| -------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `USE_XVFB`     | `SeleniumBase default` | Use virtual desktop with Xvfb. (Linux only) (Can cause performance hog [#14](https://github.com/ThePhaseless/Byparr/issues/14)) |
+| `USE_HEADLESS` | `SeleniumBase default` | Use headless  chromium.                                                                                                         |
+| `PROXY`        | None                   | Proxy to use. (format: `username:password@host:port`)                                                                           |
+
+## Tags
+
+- `v*.*.*`/`latest` - Releases considered stable
+- `main` - Latest release from main branch (untested)
 
 ## Usage
 
 ### Docker Compose
 
-```yaml
-services:
-  byparr:
-    image: ghcr.io/thephaseless/byparr
-    environment:
-      - LOG_LEVEL=INFO # optional
-    ports:
-      - "8191:8191" # Optional if used with *arr network
+See `compose.yaml`
+
+### Docker
+
+```bash
+docker run -p 8191:8191 ghcr.io/thephaseless/byparr:latest
+```
+
+### Local
+
+```bash
+uv sync && ./cmd.sh
 ```
 
 ## Need help with / TODO
 
-- [ ] Slimming container (~3GB bruh)
-- [ ] Add more anti-bot challenges
-- [x] Add docstrings
-- [ ] Implement versioning
-- [ ] Proxy support
-- [ ] Add more architectures support
+- [x] Slimming container (only ~650 MB now!)
+- [x] Add more anti-bot challenges
+- [x] Add doc strings
+- [x] Implement versioning
+- [x] Proxy support
+- [x] Add more architectures support

cmd.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+uv run main.py

compose.yaml

@@ -6,5 +6,7 @@ services:
       dockerfile: Dockerfile
     environment:
       - LOG_LEVEL=INFO
+    volumes:
+      - ./screenshots:/app/screenshots # For screenshots when exception occurs
     ports:
       - "8191:8191"

fix_nodriver.py

@@ -1,65 +0,0 @@
-# https://github.com/ultrafunkamsterdam/undetected-chromedriver/issues/1954
-# Fix for nodriver in .venv/lib/python3.11/site-packages/nodriver/core/browser.py
-from __future__ import annotations
-
-import logging
-import os
-from pathlib import Path
-from platform import python_version
-
-env_path = os.getenv("VIRTUAL_ENV")
-if env_path is None:
-    env_path = Path(os.__file__).parent.parent.parent.as_posix()
-python_version = python_version().split(".")[0:2]
-nodriver_path = Path(env_path + f"/lib/python{'.'.join(python_version)}/site-packages/nodriver/cdp/network.py")
-if not nodriver_path.exists():
-    msg = f"{nodriver_path} not found"
-    raise FileNotFoundError(msg)
-
-new_cookie_partition_key = """\
-        if isinstance(json, str):
-            return cls(top_level_site=json, has_cross_site_ancestor=False)
-        elif isinstance(json, dict):
-            return cls(
-                top_level_site=str(json["topLevelSite"]),
-                has_cross_site_ancestor=bool(json["hasCrossSiteAncestor"]),
-            )
-"""
-
-logger = logging.getLogger(__name__)
-handler = logging.StreamHandler()
-logger.addHandler(handler)
-logger.setLevel(logging.INFO)
-logger.info(f"Fixing nodriver in {nodriver_path}")
-# delete CookiePartitionKey declaration
-with nodriver_path.open("r+") as f:
-    lines = f.readlines()
-    found_def = False
-    found_body = False
-    i = -1
-    while i < len(lines):
-        i += 1
-        line = lines[i]
-        strip_line = line.strip("\n")
-        if not found_def and line.startswith("class CookiePartitionKey:"):
-            logger.info(f"Found line {i}: {strip_line}")
-            found_def = True
-            continue
-        if found_def:
-            if line.startswith("    def from_json"):
-                logger.info(f"Found line {i}: {strip_line}")
-                found_body = True
-                continue
-            if found_body:
-                if line.startswith(("\t\t", "        ")):
-                    logger.info(f"Removing line {i}: {strip_line}")
-                    lines.pop(i)
-                    i -= 1
-                    continue
-                else:
-                    lines = lines[:i] + [new_cookie_partition_key] + lines[i:]
-                    break
-
-
-with nodriver_path.open("w") as f:
-    f.writelines(lines)

main.py

@@ -1,83 +1,23 @@
 from __future__ import annotations
 
 import logging
-import time
 
-import uvicorn.config
-from bs4 import BeautifulSoup
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import RedirectResponse
-from sbase import SB, BaseCase
+import uvicorn
+from fastapi import FastAPI
+from fastapi.middleware.gzip import GZipMiddleware
 
-import src
-import src.utils
-import src.utils.consts
-from src.models.requests import LinkRequest, LinkResponse, Solution
+from src.consts import LOG_LEVEL, VERSION
+from src.endpoints import router
+from src.middlewares import LogRequest
 from src.utils import logger
-from src.utils.consts import LOG_LEVEL
+
+logger.info("Using version %s", VERSION)
 
 app = FastAPI(debug=LOG_LEVEL == logging.DEBUG, log_level=LOG_LEVEL)
+app.add_middleware(GZipMiddleware)
+app.add_middleware(LogRequest)
 
-
-@app.get("/")
-def read_root():
-    """Redirect to /docs."""
-    logger.info("Redirecting to /docs")
-    return RedirectResponse(url="/docs", status_code=301)
-
-
-@app.get("/health")
-async def health_check():
-    """Health check endpoint."""
-    logger.info("Health check")
-    # browser: Chrome = await new_browser()
-    # browser.get("https://google.com")
-    # browser.stop()
-    return {"status": "ok"}
-
-
-@app.post("/v1")
-def read_item(request: LinkRequest):
-    """Handle POST requests."""
-    start_time = int(time.time() * 1000)
-    # request.url = "https://nowsecure.nl"
-    logger.info(f"Request: {request}")
-    response: LinkResponse
-
-    # start_time = int(time.time() * 1000)
-    with SB(uc=True, locale_code="en", test=False, xvfb=True, ad_block=True) as sb:
-        sb: BaseCase
-        sb.uc_open_with_reconnect(request.url)
-        sb.uc_gui_click_captcha()
-        logger.info(f"Got webpage: {request.url}")
-        sb.save_screenshot("screenshot.png")
-        logger.info(f"Got webpage: {request.url}")
-
-        source = sb.get_page_source()
-        source_bs = BeautifulSoup(source, "html.parser")
-        title_tag = source_bs.title
-        if title_tag is None:
-            raise HTTPException(status_code=500, detail="Title tag not found")
-
-        if title_tag.string in src.utils.consts.CHALLENGE_TITLES:
-            raise HTTPException(status_code=500, detail="Could not bypass challenge")
-
-        title = title_tag.string
-        logger.info(f"Title: {title}")
-        response = LinkResponse(
-            message="Success",
-            solution=Solution(
-                userAgent=sb.get_user_agent(),
-                url=sb.get_current_url(),
-                status=200,
-                cookies=sb.get_cookies(),
-                headers={},
-                response=source,
-            ),
-            startTimestamp=start_time,
-        )
-
-    return response
+app.include_router(router=router)
 
 
 if __name__ == "__main__":

poetry.toml

@@ -1,3 +0,0 @@
-[virtualenvs]
-in-project = true
-create = true

pyproject.toml

@@ -1,27 +1,34 @@
-[tool.poetry]
-name = "byparr"
+# cspell:disable
+[project]
+authors = [{ name = "ThePhaseless", email = "kukubaorch@gmail.com" }]
+license = { text = "LICENSE" }
+requires-python = "<4.0,>=3.12"
+name = "Byparr"
 version = "0.1.0"
-description = ""
-package-mode = false
-authors = ["Your Name <you@example.com>"]
+description = "API for getting cookies for Cloudflare challenges"
 readme = "README.md"
+dependencies = [
+    "fastapi[standard]==0.115.9",
+    "pyautogui==0.9.54",
+    "pydantic==2.10.6",
+    "seleniumbase==4.35.2",
+    "uvicorn==0.34.0",
+]
+urls = { repository = "https://github.com/ThePhaseless/Byparr" }
 
-[tool.poetry.dependencies]
-python = "^3.12"
-pytest = "^8"
-fastapi = { extras = ["standard"], version = "^0" }
-requests = "^2"
-httpx = "^0.27"
-pytest-asyncio = "^0"
-ruff = "^0.8.0"
-seleniumbase = "^4.32.12"
-pyautogui = "^0.9.54"
-beautifulsoup4 = "^4.12.3"
+[dependency-groups]
+test = [
+    "httpx==0.28.1",
+    "pytest==8.3.4",
+    "pytest-asyncio==0.25.3",
+    "pytest-progress==1.3.0",
+    "pytest-retry==1.7.0",
+    "pytest-xdist==3.6.1",
+]
+dev = ["deptry==0.23.0", "ruff==0.9.8"]
 
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+[tool.deptry.per_rule_ignores]
+DEP002 = ["pyautogui"]
 
 [tool.ruff.lint]
 ignore = [

renovate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended"],
+  "packageRules": [
+    {
+      "automerge": true,
+      "matchUpdateTypes": ["minor", "patch"]
+    }
+  ]
+}

src/consts.py

@@ -0,0 +1,43 @@
+import logging
+import os
+
+
+def get_version_from_env():
+    """
+    Retrieve the version from the environment variable 'VERSION'.
+
+    This function checks the 'VERSION' environment variable for a value
+    that starts with 'v' and returns the version without the prefix.
+
+    Returns:
+        str | None: The version string without the 'v' prefix, or None if
+        the 'VERSION' environment variable is not set or does not start
+        with 'v'.
+
+    """
+    version_env = os.getenv("VERSION")
+    if not version_env:
+        return None
+
+    return version_env.removeprefix("v")
+
+
+LOG_LEVEL = os.getenv("LOG_LEVEL") or "INFO"
+LOG_LEVEL = logging.getLevelNamesMapping()[LOG_LEVEL.upper()]
+
+VERSION = get_version_from_env() or "unknown"
+
+USE_XVFB = os.getenv("USE_XVFB") in ["true", "1"] if os.getenv("USE_XVFB") else None
+
+USE_HEADLESS = (
+    os.getenv("USE_HEADLESS") in ["true", "1"] if os.getenv("USE_HEADLESS") else None
+)
+
+PROXY = os.getenv("PROXY")
+
+CHALLENGE_TITLES = [
+    # Cloudflare
+    "Just a moment...",
+    # DDoS-GUARD
+    "DDoS-Guard",
+]

src/endpoints.py

@@ -0,0 +1,75 @@
+import time
+from http import HTTPStatus
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, HTTPException
+from fastapi.responses import RedirectResponse
+from sbase import BaseCase
+
+from src.consts import CHALLENGE_TITLES
+from src.models import (
+    LinkRequest,
+    LinkResponse,
+    Solution,
+)
+
+from .utils import get_sb, logger, save_screenshot
+
+router = APIRouter()
+
+SeleniumDep = Annotated[BaseCase, Depends(get_sb)]
+
+
+@router.get("/", include_in_schema=False)
+def read_root():
+    """Redirect to /docs."""
+    logger.debug("Redirecting to /docs")
+    return RedirectResponse(url="/docs", status_code=301)
+
+
+@router.get("/health")
+def health_check(sb: SeleniumDep):
+    """Health check endpoint."""
+    health_check_request = read_item(
+        LinkRequest.model_construct(url="https://google.com"),
+        sb,
+    )
+
+    if health_check_request.solution.status != HTTPStatus.OK:
+        raise HTTPException(
+            status_code=500,
+            detail="Health check failed",
+        )
+
+    return {"status": "ok"}
+
+
+@router.post("/v1")
+def read_item(request: LinkRequest, sb: SeleniumDep) -> LinkResponse:
+    """Handle POST requests."""
+    start_time = int(time.time() * 1000)
+    sb.uc_open_with_reconnect(request.url)
+    logger.debug(f"Got webpage: {request.url}")
+    source_bs = sb.get_beautiful_soup()
+    title_tag = source_bs.title
+    if title_tag and title_tag.string in CHALLENGE_TITLES:
+        logger.debug("Challenge detected")
+        sb.uc_gui_click_captcha()
+        logger.info("Clicked captcha")
+
+    if sb.get_title() in CHALLENGE_TITLES:
+        save_screenshot(sb)
+        raise HTTPException(status_code=500, detail="Could not bypass challenge")
+
+    return LinkResponse(
+        message="Success",
+        solution=Solution(
+            userAgent=sb.get_user_agent(),
+            url=sb.get_current_url(),
+            status=200,
+            cookies=sb.get_cookies(),
+            headers={},
+            response=str(sb.get_beautiful_soup()),
+        ),
+        start_timestamp=start_time,
+    )

src/middlewares.py

@@ -0,0 +1,29 @@
+import time
+from http import HTTPStatus
+
+from starlette.middleware.base import BaseHTTPMiddleware
+
+from src.models import LinkRequest
+from src.utils import logger
+
+
+class LogRequest(BaseHTTPMiddleware):
+    async def dispatch(self, request, call_next):
+        """Log requests."""
+        if request.url.path != "/v1":
+            return await call_next(request)
+
+        start_time = time.perf_counter()
+        request_body = LinkRequest.model_validate(await request.json())
+        logger.info(
+            f"From: {request.client.host if request.client else 'unknown'} at {time.strftime('%Y-%m-%d %H:%M:%S')}: {request_body.url}"
+        )
+        response = await call_next(request)
+        process_time = time.perf_counter() - start_time
+
+        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")
+
+        return response

src/models.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+import time
+from http import HTTPStatus
+from typing import Annotated, Any
+
+from fastapi import Body
+from pydantic import BaseModel
+
+from src import consts
+
+
+class LinkRequest(BaseModel):
+    cmd: Annotated[
+        str,
+        Body(
+            default="request.get",
+            description="Type of request, currently only supports GET requests. This string is purely for compatibility with FlareSolverr.",
+        ),
+    ]
+    url: Annotated[str, Body(pattern=r"^https?://", default="https://")]
+    max_timeout: Annotated[int, Body(default=60)]
+
+
+class Solution(BaseModel):
+    url: str
+    status: int
+    cookies: list
+    userAgent: str  # noqa: N815 # Ignore to preserve compatibility
+    headers: dict[str, Any]
+    response: str
+
+    @classmethod
+    def invalid(cls, url: str):
+        """
+        Return an empty Solution with default values.
+
+        Useful for returning an error response.
+        """
+        return cls(
+            url=url,
+            status=HTTPStatus.INTERNAL_SERVER_ERROR,
+            cookies=[],
+            userAgent="",
+            headers={},
+            response="",
+        )
+
+
+class LinkResponse(BaseModel):
+    status: str = "ok"
+    message: str
+    solution: Solution
+    start_timestamp: Annotated[int, Body(alias="startTimestamp")] = int(
+        time.time() * 1000
+    )
+    end_timestamp: Annotated[int, Body(alias="endTimestamp")] = int(time.time() * 1000)
+    version: str = consts.VERSION
+
+    @classmethod
+    def invalid(cls, url: str):
+        """
+        Return an invalid LinkResponse with default error values.
+
+        This method is used to generate a response indicating an invalid request.
+        """
+        return cls(
+            status="error",
+            message="Invalid request",
+            solution=Solution.invalid(url),
+            start_timestamp=int(time.time() * 1000),
+            end_timestamp=int(time.time() * 1000),
+        )

src/models/github.py

@@ -1,95 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-
-class Author(BaseModel):
-    login: str
-    id: int
-    node_id: str
-    avatar_url: str
-    gravatar_id: str
-    url: str
-    html_url: str
-    followers_url: str
-    following_url: str
-    gists_url: str
-    starred_url: str
-    subscriptions_url: str
-    organizations_url: str
-    repos_url: str
-    events_url: str
-    received_events_url: str
-    type: str
-    site_admin: bool
-
-
-class Uploader(BaseModel):
-    login: str
-    id: int
-    node_id: str
-    avatar_url: str
-    gravatar_id: str
-    url: str
-    html_url: str
-    followers_url: str
-    following_url: str
-    gists_url: str
-    starred_url: str
-    subscriptions_url: str
-    organizations_url: str
-    repos_url: str
-    events_url: str
-    received_events_url: str
-    type: str
-    site_admin: bool
-
-
-class Asset(BaseModel):
-    url: str
-    id: int
-    node_id: str
-    name: str
-    label: str | None
-    uploader: Uploader
-    content_type: str
-    state: str
-    size: int
-    download_count: int
-    created_at: str
-    updated_at: str
-    browser_download_url: str
-
-
-class Reactions(BaseModel):
-    url: str
-    total_count: int
-
-    laugh: int
-    hooray: int
-    confused: int
-    heart: int
-    rocket: int
-    eyes: int
-
-
-class GithubResponse(BaseModel):
-    url: str
-    assets_url: str
-    upload_url: str
-    html_url: str
-    id: int
-    author: Author
-    node_id: str
-    tag_name: str
-    target_commitish: str
-    name: str
-    draft: bool
-    prerelease: bool
-    created_at: str
-    published_at: str
-    assets: list[Asset]
-    tarball_url: str
-    zipball_url: str
-    body: str
-    reactions: Reactions

src/models/requests.py

@@ -1,61 +0,0 @@
-from __future__ import annotations
-
-import time
-from http import HTTPStatus
-from typing import Any
-
-from pydantic import BaseModel
-
-
-class LinkRequest(BaseModel):
-    cmd: str
-    url: str
-    maxTimeout: int  # noqa: N815 # Ignore to preserve compatibility
-
-
-class ProtectionTriggeredError(Exception):
-    pass
-
-
-class Solution(BaseModel):
-    url: str
-    status: int
-    cookies: list
-    userAgent: str  # noqa: N815 # Ignore to preserve compatibility
-    headers: dict[str, Any]
-    response: str
-
-    @classmethod
-    def empty(cls):
-        return cls(
-            url="",
-            status=HTTPStatus.INTERNAL_SERVER_ERROR,
-            cookies=[],
-            userAgent="",
-            headers={},
-            response="",
-        )
-
-
-class LinkResponse(BaseModel):
-    status: str = "ok"
-    message: str
-    solution: Solution
-    startTimestamp: int  # noqa: N815 # Ignore to preserve compatibility
-    endTimestamp: int = int(time.time() * 1000)  # noqa: N815 # Ignore to preserve compatibility
-    version: str = "3.3.21"  # TODO: Implement versioning
-
-    @classmethod
-    def invalid(cls):
-        return cls(
-            status="error",
-            message="Invalid request",
-            solution=Solution.empty(),
-            startTimestamp=int(time.time() * 1000),
-            endTimestamp=int(time.time() * 1000),
-            version="3.3.21",
-        )
-
-
-class NoChromeExtensionError(Exception):
-    """No chrome extention found."""

src/utils.py

@@ -0,0 +1,35 @@
+import logging
+from time import gmtime, strftime
+
+from fastapi import Header
+from sbase import SB, BaseCase
+
+from src.consts import LOG_LEVEL, PROXY, USE_HEADLESS
+
+logger = logging.getLogger("uvicorn.error")
+logger.setLevel(LOG_LEVEL)
+if len(logger.handlers) == 0:
+    logger.addHandler(logging.StreamHandler())
+
+
+def get_sb(
+    proxy: str | None = Header(
+        default=None,
+        examples=["username:password@host:port"],
+        description="Override default proxy from env",
+    ),
+):
+    """Get SeleniumBase instance."""
+    with SB(
+        uc=True,
+        headless=USE_HEADLESS,
+        locale_code="en",
+        ad_block=True,
+        proxy=proxy or PROXY,
+    ) as sb:
+        yield sb
+
+
+def save_screenshot(sb: BaseCase):
+    """Save screenshot on HTTPException."""
+    sb.save_screenshot(f"screenshots/{strftime('%Y-%m-%d %H:%M:%S', gmtime())}.png")

src/utils/__init__.py

@@ -1,8 +0,0 @@
-import logging
-
-from src.utils.consts import LOG_LEVEL
-
-logger = logging.getLogger("uvicorn.error")
-logger.setLevel(LOG_LEVEL)
-if len(logger.handlers) == 0:
-    logger.addHandler(logging.StreamHandler())

src/utils/consts.py

@@ -1,12 +0,0 @@
-import logging
-import os
-
-LOG_LEVEL = os.getenv("LOG_LEVEL") or "INFO"
-LOG_LEVEL = logging.getLevelNamesMapping()[LOG_LEVEL.upper()]
-
-CHALLENGE_TITLES = [
-    # Cloudflare
-    "Just a moment...",
-    # DDoS-GUARD
-    "DDoS-Guard",
-]

test.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+uv run pytest --retries 3 -n auto

tests/main_test.py

@@ -5,29 +5,26 @@ import pytest
 from starlette.testclient import TestClient
 
 from main import app
-from src.models.requests import LinkRequest
+from src.models import LinkRequest
 
 client = TestClient(app)
 
 test_websites = [
-    "https://btmet.com/",
     "https://ext.to/",
-]
-
-# Not testable on github actions
-github_restricted = [
     "https://www.ygg.re/",
     "https://extratorrent.st/",
     "https://idope.se/",
     "https://speed.cd/login",
 ]
 
-# if os.getenv("GITHUB_ACTIONS") != "true":
-test_websites.extend(github_restricted)
-
 
 @pytest.mark.parametrize("website", test_websites)
 def test_bypass(website: str):
+    """
+    Tests if the service can bypass cloudflare/DDOS-GUARD on given websites.
+
+    This test is skipped if the website is not reachable or does not have cloudflare/DDOS-GUARD.
+    """
     test_request = httpx.get(
         website,
     )
@@ -39,12 +36,23 @@ def test_bypass(website: str):
 
     response = client.post(
         "/v1",
-        json=LinkRequest(url=website, maxTimeout=30, cmd="request.get").model_dump(),
+        json={
+            **LinkRequest.model_construct(
+                url=website, max_timeout=30, cmd="request.get"
+            ).model_dump(),
+            # "proxy": "203.174.15.83:8080",
+        },
     )
 
     assert response.status_code == HTTPStatus.OK
 
 
 def test_health_check():
+    """
+    Tests the health check endpoint.
+
+    This test ensures that the health check
+    endpoint returns HTTPStatus.OK.
+    """
     response = client.get("/health")
     assert response.status_code == HTTPStatus.OK