Compare commits
107 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f22d698da | ||
|
|
86f03ba787 | ||
|
|
c82826bf68 | ||
|
|
aba20e2078 | ||
|
|
8e37293b7d | ||
|
|
7877e1de42 | ||
|
|
2abaf74b13 | ||
|
|
1757bdabf5 | ||
|
|
547b0d4e37 | ||
|
|
1814d59e09 | ||
|
|
2148b0e2cc | ||
|
|
ccd50e7c8e | ||
|
|
b6ddeea129 | ||
|
|
e298ff6c05 | ||
|
|
5e5a719f27 | ||
|
|
cfaedb7f3b | ||
|
|
ef3b190e0b | ||
|
|
005a4380dd | ||
|
|
325c11c1eb | ||
|
|
ea152a2276 | ||
|
|
2b5a45674a | ||
|
|
f7ea06c70a | ||
|
|
f0ac905fdb | ||
|
|
c86e50245e | ||
|
|
bc6f85bf39 | ||
|
|
1c8cc1c409 | ||
|
|
8a47132f15 | ||
|
|
1e5de874cf | ||
|
|
178c16f458 | ||
|
|
7417fad45f | ||
|
|
08cb58073d | ||
|
|
c4ddd44a1a | ||
|
|
8accafbe59 | ||
|
|
6436c9fb6b | ||
|
|
864b6ea832 | ||
|
|
1052529ca2 | ||
|
|
96b23ed051 | ||
|
|
3d51013935 | ||
|
|
27bee8cdf4 | ||
|
|
132c88b3f0 | ||
|
|
665ec0a34f | ||
|
|
8207d1d2a9 | ||
|
|
9c995fc4dd | ||
|
|
e4373454ba | ||
|
|
445da233c0 | ||
|
|
b708bb8ab2 | ||
|
|
1cad73b9a7 | ||
|
|
2be92516c6 | ||
|
|
950cdb4efe | ||
|
|
7562b62241 | ||
|
|
4946982783 | ||
|
|
992e16ba05 | ||
|
|
b8d2b90370 | ||
|
|
292d5923cf | ||
|
|
5d80ec57b9 | ||
|
|
89236f13b5 | ||
|
|
957d499658 | ||
|
|
c18876471c | ||
|
|
4a12f13b96 | ||
|
|
6e8bca2ac4 | ||
|
|
5fa8455b21 | ||
|
|
944d6529b2 | ||
|
|
42fc408947 | ||
|
|
192b474c60 | ||
|
|
c8d7c4bba5 | ||
|
|
3592b9f95a | ||
|
|
0f8e0fec53 | ||
|
|
444d7e63fd | ||
|
|
ea00130d08 | ||
|
|
e1fc7b7b6f | ||
|
|
75e191f86b | ||
|
|
16cc0a3033 | ||
|
|
efaa3ce59e | ||
|
|
02b600dcbc | ||
|
|
6270ad41cc | ||
|
|
7a20ddb4ea | ||
|
|
e388408978 | ||
|
|
9135332777 | ||
|
|
9fe796f195 | ||
|
|
4d7444ef5b | ||
|
|
fceadd2009 | ||
|
|
116a348670 | ||
|
|
5e4dbc78ed | ||
|
|
8205924917 | ||
|
|
ea16bf98f4 | ||
|
|
86b27e690b | ||
|
|
70c04a2530 | ||
|
|
afd5856d0d | ||
|
|
cfd4666bb2 | ||
|
|
54932b1ac2 | ||
|
|
69fff32420 | ||
|
|
4ccd37aa5d | ||
|
|
4f304fb13a | ||
|
|
e3d38791d3 | ||
|
|
4b3f54d692 | ||
|
|
23b79f6411 | ||
|
|
80461ea7fe | ||
|
|
9df38c95a3 | ||
|
|
0b2462c82a | ||
|
|
bf8ed0d928 | ||
|
|
0f4ad67827 | ||
|
|
3b8d77b496 | ||
|
|
7b78d0b778 | ||
|
|
2e7cd7e8ed | ||
|
|
7e96976257 | ||
|
|
834c58c25a | ||
|
|
88316e7017 |
121 changed files with 14136 additions and 1076 deletions
16
.env.example
Normal file
16
.env.example
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# Copy this file to .env and fill in your values.
|
||||||
|
# Then run: docker compose up -d
|
||||||
|
|
||||||
|
# Your TorrentClaw API key (required).
|
||||||
|
# Get it at: https://torrentclaw.com/settings/api-keys
|
||||||
|
UNARR_API_KEY=tc_your_key_here
|
||||||
|
|
||||||
|
# Absolute path to your media / downloads folder.
|
||||||
|
# This is where finished movies and shows will be saved.
|
||||||
|
DOWNLOAD_DIR=/home/youruser/Media
|
||||||
|
|
||||||
|
# (Optional) Config directory — defaults to ./config next to this file.
|
||||||
|
# CONFIG_DIR=/home/youruser/.config/unarr
|
||||||
|
|
||||||
|
# (Optional) Timezone for logs.
|
||||||
|
# TZ=Europe/Madrid
|
||||||
|
|
@ -12,35 +12,26 @@ permissions:
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
name: Test
|
name: Test
|
||||||
runs-on: ubuntu-latest
|
runs-on: docker
|
||||||
strategy:
|
container:
|
||||||
matrix:
|
image: docker.io/library/golang:1.25
|
||||||
go-version: ["1.25"]
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
|
||||||
uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version: ${{ matrix.go-version }}
|
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: go test -v -race -count=1 ./...
|
run: go test -v -race -count=1 ./...
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/golang:1.25
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
goos: [linux, darwin, windows]
|
goos: [linux, darwin, windows]
|
||||||
goarch: [amd64, arm64]
|
goarch: [amd64, arm64]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
|
||||||
uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version: "1.25"
|
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
env:
|
env:
|
||||||
|
|
@ -50,30 +41,30 @@ jobs:
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
name: Lint
|
name: Lint
|
||||||
runs-on: ubuntu-latest
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/golang:1.25
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Install golangci-lint
|
||||||
uses: actions/setup-go@v6
|
run: |
|
||||||
with:
|
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/v2.11.4/install.sh \
|
||||||
go-version: "1.25"
|
| sh -s -- -b /usr/local/bin v2.11.4
|
||||||
|
|
||||||
- name: Run golangci-lint
|
- name: Run golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v9
|
run: golangci-lint run ./...
|
||||||
with:
|
|
||||||
version: v2.11.4
|
|
||||||
|
|
||||||
coverage:
|
coverage:
|
||||||
name: Coverage
|
name: Coverage
|
||||||
runs-on: ubuntu-latest
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/golang:1.25
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Install python3
|
||||||
uses: actions/setup-go@v6
|
run: apt-get update && apt-get install -y --no-install-recommends python3
|
||||||
with:
|
|
||||||
go-version: "1.25"
|
|
||||||
|
|
||||||
- name: Run tests with coverage (all packages)
|
- name: Run tests with coverage (all packages)
|
||||||
run: |
|
run: |
|
||||||
|
|
@ -102,24 +93,13 @@ jobs:
|
||||||
print('OK: Coverage meets minimum threshold')
|
print('OK: Coverage meets minimum threshold')
|
||||||
"
|
"
|
||||||
|
|
||||||
- name: Upload coverage to Codecov
|
|
||||||
uses: codecov/codecov-action@v6
|
|
||||||
with:
|
|
||||||
files: ./coverage.out
|
|
||||||
fail_ci_if_error: false
|
|
||||||
env:
|
|
||||||
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
|
|
||||||
vet:
|
vet:
|
||||||
name: Vet
|
name: Vet
|
||||||
runs-on: ubuntu-latest
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/golang:1.25
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
|
||||||
uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version: "1.25"
|
|
||||||
|
|
||||||
- name: Run go vet
|
- name: Run go vet
|
||||||
run: go vet ./...
|
run: go vet ./...
|
||||||
61
.forgejo/workflows/docker-rebuild.yml
Normal file
61
.forgejo/workflows/docker-rebuild.yml
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Rebuilds and re-pushes the `latest` image without a version bump so newly
|
||||||
|
# *fixed* Alpine / ffmpeg / Go patches land between tagged releases. Versioned
|
||||||
|
# tags are immutable and never touched here. Runs weekly and on demand.
|
||||||
|
name: Docker rebuild
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
# Mondays 04:17 UTC (off the hour to avoid the scheduler rush)
|
||||||
|
- cron: "17 4 * * 1"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
rebuild:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/docker:27-cli
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Install build deps
|
||||||
|
run: apk add --no-cache curl git bash
|
||||||
|
|
||||||
|
- name: Install buildx
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.docker/cli-plugins
|
||||||
|
curl -sSL https://github.com/docker/buildx/releases/latest/download/buildx-linux-amd64 \
|
||||||
|
-o ~/.docker/cli-plugins/docker-buildx
|
||||||
|
chmod +x ~/.docker/cli-plugins/docker-buildx
|
||||||
|
|
||||||
|
- name: Set up qemu
|
||||||
|
run: docker run --rm --privileged tonistiigi/binfmt --install all
|
||||||
|
|
||||||
|
# Stamp the binary with the most recent release tag (not "dev").
|
||||||
|
- name: Resolve version
|
||||||
|
id: ver
|
||||||
|
run: |
|
||||||
|
v=$(git describe --tags --abbrev=0 2>/dev/null || echo dev)
|
||||||
|
echo "version=$v" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
env:
|
||||||
|
DH_USER: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
DH_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
run: echo "$DH_TOKEN" | docker login -u "$DH_USER" --password-stdin
|
||||||
|
|
||||||
|
- name: Build + push (refresh latest)
|
||||||
|
env:
|
||||||
|
VERSION: ${{ steps.ver.outputs.version }}
|
||||||
|
run: |
|
||||||
|
docker buildx create --name builder --use --driver docker-container
|
||||||
|
# Refresh the floating tag only — never overwrite a versioned release.
|
||||||
|
# Force a fresh base pull so apk upgrade picks up new patches.
|
||||||
|
docker buildx build \
|
||||||
|
--platform linux/amd64,linux/arm64 \
|
||||||
|
--build-arg "VERSION=$VERSION" \
|
||||||
|
--tag "torrentclaw/unarr:latest" \
|
||||||
|
--no-cache \
|
||||||
|
--push \
|
||||||
|
.
|
||||||
118
.forgejo/workflows/release.yml
Normal file
118
.forgejo/workflows/release.yml
Normal file
|
|
@ -0,0 +1,118 @@
|
||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: docker.io/library/golang:1.25
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Install build deps (bash, curl, jq, ffmpeg fetch deps)
|
||||||
|
run: |
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y --no-install-recommends bash curl ca-certificates jq xz-utils unzip
|
||||||
|
|
||||||
|
- name: Install goreleaser
|
||||||
|
run: |
|
||||||
|
curl -sSfL https://github.com/goreleaser/goreleaser/releases/latest/download/goreleaser_Linux_x86_64.tar.gz \
|
||||||
|
| tar -xz -C /usr/local/bin goreleaser
|
||||||
|
|
||||||
|
- name: Run goreleaser
|
||||||
|
env:
|
||||||
|
# Forgejo runner auto-injects GITHUB_TOKEN (a per-job, instance-scoped
|
||||||
|
# token usable against the Forgejo REST API). goreleaser only accepts
|
||||||
|
# one token; with both GITHUB_TOKEN + GITEA_TOKEN set it errors out
|
||||||
|
# ("multiple tokens"). Unset GITHUB_TOKEN before invoking goreleaser so
|
||||||
|
# it picks the Gitea code path + the gitea_urls block in .goreleaser.yml.
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
|
||||||
|
# Empty when RELEASE_SIGNING_PUBKEY variable is unset — goreleaser
|
||||||
|
# accepts it and the resulting binary disables signature checks
|
||||||
|
# (back-compat: pre-signing releases continue to update). Set
|
||||||
|
# RELEASE_SIGNING_PUBKEY (variable) + RELEASE_SIGNING_KEY (secret)
|
||||||
|
# to turn verification on.
|
||||||
|
RELEASE_SIGNING_PUBKEY: ${{ vars.RELEASE_SIGNING_PUBKEY }}
|
||||||
|
run: |
|
||||||
|
unset GITHUB_TOKEN
|
||||||
|
goreleaser release --clean
|
||||||
|
|
||||||
|
- name: Sign checksums.txt with ed25519
|
||||||
|
if: ${{ vars.RELEASE_SIGNING_PUBKEY != '' && secrets.RELEASE_SIGNING_KEY != '' }}
|
||||||
|
env:
|
||||||
|
RELEASE_SIGNING_KEY: ${{ secrets.RELEASE_SIGNING_KEY }}
|
||||||
|
RELEASE_TAG: ${{ github.ref_name }}
|
||||||
|
FORGEJO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# Tailscale IP — domain-agnostic; the runner shares the dokploy-network with
|
||||||
|
# forgejo (hostname `forgejo`), so the in-cluster hostname is fastest, but the
|
||||||
|
# Tailscale IP is the documented fallback.
|
||||||
|
FORGEJO_API: http://forgejo:3000/api/v1
|
||||||
|
REPO: torrentclaw/unarr
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
go run ./scripts/sign-checksums \
|
||||||
|
-key "$RELEASE_SIGNING_KEY" \
|
||||||
|
-in dist/checksums.txt \
|
||||||
|
-out dist/checksums.txt.sig
|
||||||
|
|
||||||
|
# Find the release ID for this tag, then upload the sig as an asset.
|
||||||
|
rel_id=$(curl -sSf "$FORGEJO_API/repos/$REPO/releases/tags/$RELEASE_TAG" \
|
||||||
|
-H "Authorization: token $FORGEJO_TOKEN" | jq -r '.id')
|
||||||
|
curl -sSf -X POST \
|
||||||
|
"$FORGEJO_API/repos/$REPO/releases/$rel_id/assets?name=checksums.txt.sig" \
|
||||||
|
-H "Authorization: token $FORGEJO_TOKEN" \
|
||||||
|
-F "attachment=@dist/checksums.txt.sig"
|
||||||
|
|
||||||
|
docker:
|
||||||
|
needs: release
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
# Docker-in-Docker capable image — buildx + qemu pre-installed.
|
||||||
|
image: docker.io/library/docker:27-cli
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install buildx
|
||||||
|
run: |
|
||||||
|
apk add --no-cache curl
|
||||||
|
mkdir -p ~/.docker/cli-plugins
|
||||||
|
curl -sSL https://github.com/docker/buildx/releases/latest/download/buildx-linux-amd64 \
|
||||||
|
-o ~/.docker/cli-plugins/docker-buildx
|
||||||
|
chmod +x ~/.docker/cli-plugins/docker-buildx
|
||||||
|
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
env:
|
||||||
|
DH_USER: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
DH_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
run: echo "$DH_TOKEN" | docker login -u "$DH_USER" --password-stdin
|
||||||
|
|
||||||
|
- name: Set up qemu
|
||||||
|
run: docker run --rm --privileged tonistiigi/binfmt --install all
|
||||||
|
|
||||||
|
- name: Build + push multi-arch image
|
||||||
|
env:
|
||||||
|
VERSION: ${{ github.ref_name }}
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
VERSION_SEMVER="${VERSION#v}"
|
||||||
|
MAJOR_MINOR="${VERSION_SEMVER%.*}"
|
||||||
|
docker buildx create --name builder --use --driver docker-container
|
||||||
|
docker buildx build \
|
||||||
|
--platform linux/amd64,linux/arm64 \
|
||||||
|
--build-arg "VERSION=$VERSION" \
|
||||||
|
--tag "torrentclaw/unarr:$VERSION_SEMVER" \
|
||||||
|
--tag "torrentclaw/unarr:$MAJOR_MINOR" \
|
||||||
|
--tag "torrentclaw/unarr:latest" \
|
||||||
|
--push \
|
||||||
|
.
|
||||||
52
.github/workflows/docker-rebuild.yml
vendored
52
.github/workflows/docker-rebuild.yml
vendored
|
|
@ -1,52 +0,0 @@
|
||||||
# Rebuilds and re-pushes the `latest` image without a version bump so newly
|
|
||||||
# *fixed* Alpine / ffmpeg / Go patches land between tagged releases. Versioned
|
|
||||||
# tags are immutable and never touched here. Runs weekly and on demand.
|
|
||||||
name: Docker rebuild
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
# Mondays 04:17 UTC (off the hour to avoid the scheduler rush)
|
|
||||||
- cron: "17 4 * * 1"
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
rebuild:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
# Stamp the binary with the most recent release tag (not "dev").
|
|
||||||
- name: Resolve version
|
|
||||||
id: ver
|
|
||||||
run: echo "version=$(git describe --tags --abbrev=0 2>/dev/null || echo dev)" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
- uses: docker/setup-qemu-action@v4
|
|
||||||
- uses: docker/setup-buildx-action@v4
|
|
||||||
|
|
||||||
- uses: docker/login-action@v4
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
|
|
||||||
- uses: docker/build-push-action@v7
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
push: true
|
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
# Refresh the floating tag only — never overwrite a versioned release.
|
|
||||||
tags: torrentclaw/unarr:latest
|
|
||||||
build-args: |
|
|
||||||
VERSION=${{ steps.ver.outputs.version }}
|
|
||||||
# Force a fresh base pull so apk upgrade picks up new patches.
|
|
||||||
no-cache: true
|
|
||||||
|
|
||||||
- name: Scan image for fixable CVEs (gate)
|
|
||||||
uses: docker/scout-action@v1
|
|
||||||
with:
|
|
||||||
command: cves
|
|
||||||
image: torrentclaw/unarr:latest
|
|
||||||
only-severities: critical,high
|
|
||||||
only-fixed: true
|
|
||||||
exit-code: true
|
|
||||||
52
.github/workflows/pages.yml
vendored
52
.github/workflows/pages.yml
vendored
|
|
@ -1,52 +0,0 @@
|
||||||
name: Deploy install scripts to Pages
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
paths:
|
|
||||||
- install.sh
|
|
||||||
- install.ps1
|
|
||||||
- CNAME
|
|
||||||
- .nojekyll
|
|
||||||
- .github/workflows/pages.yml
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pages: write
|
|
||||||
id-token: write
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: pages
|
|
||||||
cancel-in-progress: false
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: github-pages
|
|
||||||
url: ${{ steps.deployment.outputs.page_url }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/configure-pages@v5
|
|
||||||
- name: Stage install scripts
|
|
||||||
run: |
|
|
||||||
mkdir -p _site
|
|
||||||
cp install.sh install.ps1 _site/
|
|
||||||
[ -f CNAME ] && cp CNAME _site/
|
|
||||||
touch _site/.nojekyll
|
|
||||||
# Also index page (humans landing)
|
|
||||||
cat > _site/index.html <<'HTML'
|
|
||||||
<!doctype html>
|
|
||||||
<html><head><meta charset=utf-8><title>unarr installer</title></head>
|
|
||||||
<body><h1>unarr CLI installer</h1>
|
|
||||||
<pre>Linux/macOS: curl -fsSL https://unarr.torrentclaw.com/install.sh | sh
|
|
||||||
Windows: irm https://unarr.torrentclaw.com/install.ps1 | iex</pre>
|
|
||||||
<p>Source: <a href="https://github.com/torrentclaw/unarr">github.com/torrentclaw/unarr</a></p>
|
|
||||||
</body></html>
|
|
||||||
HTML
|
|
||||||
- uses: actions/upload-pages-artifact@v3
|
|
||||||
with:
|
|
||||||
path: _site
|
|
||||||
- id: deployment
|
|
||||||
uses: actions/deploy-pages@v4
|
|
||||||
210
.github/workflows/release.yml
vendored
210
.github/workflows/release.yml
vendored
|
|
@ -1,210 +0,0 @@
|
||||||
name: Release
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "v*"
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version-file: go.mod
|
|
||||||
|
|
||||||
- uses: goreleaser/goreleaser-action@v6
|
|
||||||
with:
|
|
||||||
version: "~> v2"
|
|
||||||
args: release --clean
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
|
|
||||||
# Empty when RELEASE_SIGNING_PUBKEY variable is unset — goreleaser
|
|
||||||
# accepts it and the resulting binary disables signature checks
|
|
||||||
# (back-compat: pre-signing releases continue to update). Set
|
|
||||||
# RELEASE_SIGNING_PUBKEY (variable) + RELEASE_SIGNING_KEY (secret)
|
|
||||||
# to turn verification on.
|
|
||||||
RELEASE_SIGNING_PUBKEY: ${{ vars.RELEASE_SIGNING_PUBKEY }}
|
|
||||||
|
|
||||||
- name: Sign checksums.txt with ed25519
|
|
||||||
# Reference secrets.X directly — step-level env defined in this same
|
|
||||||
# step is unreliable to read from this step's own if: expression.
|
|
||||||
if: ${{ vars.RELEASE_SIGNING_PUBKEY != '' && secrets.RELEASE_SIGNING_KEY != '' }}
|
|
||||||
env:
|
|
||||||
RELEASE_SIGNING_KEY: ${{ secrets.RELEASE_SIGNING_KEY }}
|
|
||||||
RELEASE_TAG: ${{ github.ref_name }}
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
go run ./scripts/sign-checksums \
|
|
||||||
-key "$RELEASE_SIGNING_KEY" \
|
|
||||||
-in dist/checksums.txt \
|
|
||||||
-out dist/checksums.txt.sig
|
|
||||||
gh release upload "$RELEASE_TAG" dist/checksums.txt.sig --clobber
|
|
||||||
|
|
||||||
docker:
|
|
||||||
needs: release
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Docker meta
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v6
|
|
||||||
with:
|
|
||||||
images: torrentclaw/unarr
|
|
||||||
tags: |
|
|
||||||
type=semver,pattern={{version}}
|
|
||||||
type=semver,pattern={{major}}.{{minor}}
|
|
||||||
type=raw,value=latest
|
|
||||||
|
|
||||||
- uses: docker/setup-qemu-action@v4
|
|
||||||
- uses: docker/setup-buildx-action@v4
|
|
||||||
|
|
||||||
- uses: docker/login-action@v4
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
|
|
||||||
- uses: docker/build-push-action@v7
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
push: true
|
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
|
||||||
build-args: |
|
|
||||||
VERSION=${{ github.ref_name }}
|
|
||||||
|
|
||||||
# CVE gate. Fails the release on FIXABLE critical/high only — unfixed
|
|
||||||
# upstream ffmpeg codec CVEs are accepted (see SECURITY.md), so the
|
|
||||||
# codec noise does not block. Runs post-push (image already published);
|
|
||||||
# a failure here flags that a fixable CVE slipped through.
|
|
||||||
- name: Scan image for fixable CVEs (gate)
|
|
||||||
uses: docker/scout-action@v1
|
|
||||||
with:
|
|
||||||
command: cves
|
|
||||||
image: torrentclaw/unarr:latest
|
|
||||||
only-severities: critical,high
|
|
||||||
only-fixed: true
|
|
||||||
exit-code: true
|
|
||||||
|
|
||||||
# Sync the Docker Hub repo description from DOCKERHUB.md. Non-fatal: a
|
|
||||||
# description-API auth hiccup must not undo a successful image push.
|
|
||||||
- name: Update Docker Hub description
|
|
||||||
uses: peter-evans/dockerhub-description@v4
|
|
||||||
continue-on-error: true
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
repository: torrentclaw/unarr
|
|
||||||
readme-filepath: ./DOCKERHUB.md
|
|
||||||
short-description: "unarr — the single binary that replaces your *arr stack"
|
|
||||||
|
|
||||||
|
|
||||||
virustotal:
|
|
||||||
needs: release
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
if: vars.VT_ENABLED == 'true'
|
|
||||||
steps:
|
|
||||||
- name: Get release tag
|
|
||||||
id: tag
|
|
||||||
run: echo "tag=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
- name: Download release assets
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
mkdir -p assets
|
|
||||||
gh release download "${{ steps.tag.outputs.tag }}" \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--dir assets \
|
|
||||||
--pattern '*.tar.gz' \
|
|
||||||
--pattern '*.zip' \
|
|
||||||
--pattern 'checksums.txt'
|
|
||||||
|
|
||||||
- name: Scan assets with VirusTotal
|
|
||||||
env:
|
|
||||||
VT_API_KEY: ${{ secrets.VT_API_KEY }}
|
|
||||||
run: |
|
|
||||||
mkdir -p results
|
|
||||||
for file in assets/*; do
|
|
||||||
filename=$(basename "$file")
|
|
||||||
echo "Uploading $filename to VirusTotal..."
|
|
||||||
|
|
||||||
response=$(curl -s --request POST \
|
|
||||||
--url https://www.virustotal.com/api/v3/files \
|
|
||||||
--header "x-apikey: $VT_API_KEY" \
|
|
||||||
--form "file=@$file")
|
|
||||||
|
|
||||||
analysis_id=$(echo "$response" | jq -r '.data.id // empty')
|
|
||||||
if [ -z "$analysis_id" ]; then
|
|
||||||
echo "::warning::Failed to upload $filename: $response"
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "$filename=$analysis_id" >> results/scans.txt
|
|
||||||
echo " Analysis ID: $analysis_id"
|
|
||||||
|
|
||||||
# Rate limit: VT free tier allows 4 req/min
|
|
||||||
sleep 16
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Wait for analysis completion
|
|
||||||
env:
|
|
||||||
VT_API_KEY: ${{ secrets.VT_API_KEY }}
|
|
||||||
run: |
|
|
||||||
echo "Waiting 60s for VirusTotal analysis to complete..."
|
|
||||||
sleep 60
|
|
||||||
|
|
||||||
vt_report="## 🛡️ VirusTotal Scan Results\n\n"
|
|
||||||
vt_report+="| File | Result | Link |\n"
|
|
||||||
vt_report+="|------|--------|------|\n"
|
|
||||||
|
|
||||||
while IFS='=' read -r filename analysis_id; do
|
|
||||||
result=$(curl -s --request GET \
|
|
||||||
--url "https://www.virustotal.com/api/v3/analyses/$analysis_id" \
|
|
||||||
--header "x-apikey: $VT_API_KEY")
|
|
||||||
|
|
||||||
malicious=$(echo "$result" | jq -r '.data.attributes.stats.malicious // 0')
|
|
||||||
undetected=$(echo "$result" | jq -r '.data.attributes.stats.undetected // 0')
|
|
||||||
sha256=$(echo "$result" | jq -r '.meta.file_info.sha256 // empty')
|
|
||||||
|
|
||||||
if [ "$malicious" = "0" ]; then
|
|
||||||
status="✅ Clean ($undetected engines)"
|
|
||||||
else
|
|
||||||
status="⚠️ $malicious detections"
|
|
||||||
fi
|
|
||||||
|
|
||||||
link="https://www.virustotal.com/gui/file/$sha256"
|
|
||||||
vt_report+="| \`$filename\` | $status | [View]($link) |\n"
|
|
||||||
|
|
||||||
sleep 16
|
|
||||||
done < results/scans.txt
|
|
||||||
|
|
||||||
echo -e "$vt_report" > results/report.md
|
|
||||||
cat results/report.md
|
|
||||||
|
|
||||||
- name: Append scan results to release notes
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
current_body=$(gh release view "${{ steps.tag.outputs.tag }}" \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--json body --jq '.body')
|
|
||||||
|
|
||||||
new_body="${current_body}
|
|
||||||
|
|
||||||
$(cat results/report.md)"
|
|
||||||
|
|
||||||
gh release edit "${{ steps.tag.outputs.tag }}" \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--notes "$new_body"
|
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
|
|
@ -41,4 +41,7 @@ dist-ffbinaries/
|
||||||
# Docker
|
# Docker
|
||||||
tmp/
|
tmp/
|
||||||
config/
|
config/
|
||||||
dist-ffbinaries/
|
dist-ffbinaries/
|
||||||
|
|
||||||
|
# Claude Code: keep entirely local, do not track
|
||||||
|
.claude/
|
||||||
|
|
@ -26,10 +26,10 @@ builds:
|
||||||
- -s -w
|
- -s -w
|
||||||
- -X github.com/torrentclaw/unarr/internal/cmd.Version={{.Version}}
|
- -X github.com/torrentclaw/unarr/internal/cmd.Version={{.Version}}
|
||||||
- -X github.com/torrentclaw/unarr/internal/sentry.dsn={{ .Env.SENTRY_DSN }}
|
- -X github.com/torrentclaw/unarr/internal/sentry.dsn={{ .Env.SENTRY_DSN }}
|
||||||
# Release-signing public key — verified by the self-updater against
|
# The release-signing PUBLIC key is compiled in as the canonical default
|
||||||
# checksums.txt.sig. Empty when not configured; in that case
|
# in internal/upgrade/signature.go (it's public — committing it removes
|
||||||
# signature verification is skipped and a warning is logged.
|
# the "empty env var → unsigned binary" footgun). No ldflag override:
|
||||||
- -X github.com/torrentclaw/unarr/internal/upgrade.releasePubKeyBase64={{ .Env.RELEASE_SIGNING_PUBKEY }}
|
# every build bakes the same key and verifies checksums.txt.sig.
|
||||||
|
|
||||||
archives:
|
archives:
|
||||||
- formats: [tar.gz]
|
- formats: [tar.gz]
|
||||||
|
|
@ -51,6 +51,28 @@ archives:
|
||||||
checksum:
|
checksum:
|
||||||
name_template: "checksums.txt"
|
name_template: "checksums.txt"
|
||||||
|
|
||||||
|
# Sign checksums.txt with the release ed25519 private key → checksums.txt.sig,
|
||||||
|
# verified by the self-updater against the compiled-in public key. Releases are
|
||||||
|
# signed UNCONDITIONALLY: sign-checksums requires -key, so an unset/empty
|
||||||
|
# RELEASE_SIGNING_KEY makes this step (and the whole `goreleaser release`) fail
|
||||||
|
# rather than silently shipping an unsigned release. ship.sh sources the key
|
||||||
|
# from ~/.config/unarr-release/signing.key (or the RELEASE_SIGNING_KEY env).
|
||||||
|
signs:
|
||||||
|
- id: checksums
|
||||||
|
cmd: go
|
||||||
|
args:
|
||||||
|
- run
|
||||||
|
- ./scripts/sign-checksums
|
||||||
|
- -key
|
||||||
|
- "{{ .Env.RELEASE_SIGNING_KEY }}"
|
||||||
|
- -in
|
||||||
|
- "${artifact}"
|
||||||
|
- -out
|
||||||
|
- "${signature}"
|
||||||
|
signature: "${artifact}.sig"
|
||||||
|
artifacts: checksum
|
||||||
|
output: true
|
||||||
|
|
||||||
changelog:
|
changelog:
|
||||||
sort: asc
|
sort: asc
|
||||||
filters:
|
filters:
|
||||||
|
|
@ -59,6 +81,22 @@ changelog:
|
||||||
- "^test:"
|
- "^test:"
|
||||||
- "^chore:"
|
- "^chore:"
|
||||||
|
|
||||||
|
# Self-hosted Forgejo at git.torrentclaw.com. goreleaser detects GITEA_TOKEN +
|
||||||
|
# these URLs and publishes the release there instead of GitHub. Reachable via
|
||||||
|
# `forgejo` hostname inside the dokploy-network (the runner shares it); for
|
||||||
|
# local goreleaser runs outside the network, override via env GITEA_API_URL.
|
||||||
|
#
|
||||||
|
# In goreleaser v2 `gitea_urls` is a top-level key (was nested under `release`
|
||||||
|
# in v1).
|
||||||
|
gitea_urls:
|
||||||
|
api: http://forgejo:3000/api/v1
|
||||||
|
download: https://git.torrentclaw.com
|
||||||
|
skip_tls_verify: false
|
||||||
|
|
||||||
|
release:
|
||||||
|
draft: false
|
||||||
|
prerelease: auto
|
||||||
|
|
||||||
# Homebrew tap — requires PAT with repo scope (not GITHUB_TOKEN)
|
# Homebrew tap — requires PAT with repo scope (not GITHUB_TOKEN)
|
||||||
# Enable when torrentclaw/homebrew-tap PAT is configured as HOMEBREW_TAP_TOKEN
|
# Enable when torrentclaw/homebrew-tap PAT is configured as HOMEBREW_TAP_TOKEN
|
||||||
# brews:
|
# brews:
|
||||||
|
|
|
||||||
316
CHANGELOG.md
316
CHANGELOG.md
|
|
@ -5,49 +5,263 @@ All notable changes to this project will be documented in this file.
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [0.9.4] - 2026-05-26
|
## [1.0.2-beta] - 2026-06-03
|
||||||
|
|
||||||
### Removed
|
|
||||||
|
|
||||||
- **streaming**: retire the custom WebRTC DataChannel pipeline. The daemon no
|
|
||||||
longer ships pion/webrtc, the WSS signaling client, or the wire framing
|
|
||||||
package — every in-browser session now uses HLS over HTTP from the daemon
|
|
||||||
(Tailscale / LAN / UPnP). Browser P2P (WebTorrent) bytes never re-enabled.
|
|
||||||
- **config**: `[downloads.webrtc]` block removed from the TOML schema; existing
|
|
||||||
config files with the section parse cleanly because go-toml ignores unknown
|
|
||||||
sections.
|
|
||||||
- **seed_file**: `mode=seed_file` task handler + `engine.SeedFile` helper
|
|
||||||
dropped — the last in-browser caller was retired with the WebRTC player.
|
|
||||||
- **wstracker-probe**: standalone probe binary removed.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- **agent wire**: `SyncResponse.WebRTCSessions` (JSON: `webrtcSessions`) renamed
|
|
||||||
to `StreamSessions` (JSON: `streamSessions`). The Go type `agent.WebRTCSession`
|
|
||||||
is now `agent.StreamSession`. Wire-incompatible with web < 2026-05-26.
|
|
||||||
- **torrent**: `buildMagnet` no longer accepts an `extraTrackers` variadic —
|
|
||||||
the default tracker list is the only set used.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- **hls**: clamp the ffmpeg `-b:v` to the bitrate cap derived from the EFFECTIVE
|
|
||||||
output height instead of the requested quality. Previously asking for "2160p"
|
|
||||||
on a 1080p source overshot the H.264 level we resolved from the effective
|
|
||||||
height (4.0, max 20 Mbps) and made libx264 abort with
|
|
||||||
`VBV bitrate > level limit`.
|
|
||||||
|
|
||||||
## [0.9.2] - 2026-05-21
|
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- **vpn**: `unarr vpn` command (`status`, `enable`, `disable`) to manage the managed
|
- **stream**: serve a `mode=stream` task from a debrid HTTPS link when the torrent is cached (debrid passthrough for external players / VLC), falling back to P2P stream-while-download when it isn't
|
||||||
WireGuard split-tunnel, with `vpn status --check` to verify provisioning.
|
|
||||||
- **vpn**: report split-tunnel state (active, exit server) to the web on register
|
|
||||||
+ every sync, so the dashboard shows which agent holds the single WireGuard slot.
|
|
||||||
- **vpn**: send the agent id when fetching the VPN config so the web can arbitrate
|
|
||||||
the single WireGuard slot — the first agent claims it; the rest are told to run
|
|
||||||
OpenVPN on their own host (1 agent on WireGuard + up to 9 on OpenVPN).
|
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **stream**: widen the debrid HEAD size-probe timeout to 15s to match the TLS handshake budget — a slow CDN no longer trips the old 10s and falls back to a guessed size
|
||||||
|
|
||||||
|
## [1.0.1-beta] - 2026-06-03
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **agent**: report isDocker so the web shows a docker pull command
|
||||||
|
- **release**: sign release checksums (ed25519), enforce + bake pubkey
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **stream**: retry thumbnail extraction with output-seek on seek-index failure
|
||||||
|
- **stream**: clamp out-of-range audio-track index to 0:a:0
|
||||||
|
## [1.0.0-beta] - 2026-06-03
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **agent**: event-driven uplink — sync on every state transition
|
||||||
|
- **agent**: hybrid SSE downlink with long-poll fallback
|
||||||
|
- **agent**: give the public API client mirror failover
|
||||||
|
- **agent**: auto-resume interrupted downloads after a daemon restart
|
||||||
|
- **docker**: glibc base with nvenc ffmpeg + par2/7z extractors
|
||||||
|
- **downloads**: pre-flight free-disk guard before each download (hueco medio)
|
||||||
|
- **library**: content fingerprint + path-resilient sync + stream self-heal
|
||||||
|
- **library**: detect corrupt/incomplete files during scan
|
||||||
|
- **seeding**: wire seed ratio/time lifecycle into the torrent daemon
|
||||||
|
- **stream**: enable GPU libplacebo in prod image + gate to real GPU
|
||||||
|
- **stream**: benchmark software encode ceiling at startup
|
||||||
|
- **stream**: GPU HDR tonemap via libplacebo
|
||||||
|
- **stream**: /speedtest endpoint for agent-path bandwidth probing
|
||||||
|
- **stream**: cache scan-time thumbnail frames to the .unarr sidecar
|
||||||
|
- **stream**: cache extracted subtitles to a hidden .unarr sidecar
|
||||||
|
- **stream**: serve embedded text subtitles as on-demand WebVTT
|
||||||
|
- **stream**: optional per-agent HTTPS listener with hot-reloadable cert
|
||||||
|
- **stream**: burn bitmap (PGS/DVB) subtitles into the video via overlay
|
||||||
|
- **stream**: bitrate-sized readahead for play-while-download
|
||||||
|
- **stream**: on-demand frame thumbnails via /thumbnail (hueco medio)
|
||||||
|
- **stream**: refresh expired debrid links mid-stream (hueco #2/2c)
|
||||||
|
- **stream**: transcode debrid sources to HLS from a URL (hueco #2/2b)
|
||||||
|
- **stream**: serve /stream from a debrid HTTPS link (hueco #2/2a)
|
||||||
|
- **stream**: device-aware remux (HEVC/AV1 + non-aac audio) + TTFF timers
|
||||||
|
- **stream**: progressive fMP4 remux source for /stream (hueco #3 / 3b-i)
|
||||||
|
- **stream**: direct-play passthrough for browser-native files
|
||||||
|
- **stream**: authenticate /stream and /hls with signed tokens
|
||||||
|
- **transcode**: tonemap HDR sources to SDR (zscale-gated)
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
- **docker**: add docker-compose.yml for one-command setup
|
||||||
|
- **roadmap**: close the realtime hueco + mark Tailscale-Funnel note stale
|
||||||
|
- **roadmap**: mark unarr localized-route 404 fixed
|
||||||
|
- **roadmap**: mark hueco #2 closed (2a+2b+2c)
|
||||||
|
- **roadmap**: mark hueco #2/2b (HLS-from-URL) closed
|
||||||
|
- **roadmap**: hueco #3 fully closed — 3d resolved as 3d-lite auto-downshift
|
||||||
|
- **roadmap**: hueco #3 3c closed (capability negotiation) + TTFF diagnosis
|
||||||
|
- **roadmap**: hueco #3 phase 3b closed (progressive fMP4 remux) + smoke
|
||||||
|
- **roadmap**: 3b approach = progressive fMP4 remux via /stream
|
||||||
|
- **roadmap**: hueco #3 3a smoke e2e passed + brand-isolation fix noted
|
||||||
|
- **roadmap**: add hueco #4 (pre-transcode on download) design
|
||||||
|
- **roadmap**: hueco #3 phase 3a closed (direct-play)
|
||||||
|
- **roadmap**: design hueco #3 (device-profile + direct-play + ABR)
|
||||||
|
- **roadmap**: design hueco #2 (debrid in the streaming path)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **agent**: surface par2/install/NFS failures instead of degrading silently
|
||||||
|
- **stream**: don't cache transient libplacebo probe timeouts
|
||||||
|
- **stream**: functional libplacebo probe + benchmark hardening
|
||||||
|
- **stream**: clean HLS segments — no B-frames, no scene-cut, CFR
|
||||||
|
- **stream**: report stream failures via StreamError + retry transient stat
|
||||||
|
- **stream**: honor client network-caching in the M3U playlist
|
||||||
|
- **stream**: /critico review fixes for the sidecar cache
|
||||||
|
- **stream**: derive H.264 level from frame macroblocks, not height
|
||||||
|
- **stream**: derive H.264 level from frame macroblocks, not height
|
||||||
|
- **stream**: allow unarr.app origins for /stream + /hls CORS
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 1.0.0-beta
|
||||||
|
- **release**: 1.0.0-beta
|
||||||
|
- bump version to 0.10.0 (direct-play floor; local build only, no publish)
|
||||||
|
|
||||||
|
### Performance
|
||||||
|
|
||||||
|
- **stream**: run the subtitle/thumbnail prewarm at idle I/O priority
|
||||||
|
- **stream**: extract all text subtitles of a file in one ffmpeg pass
|
||||||
|
## [0.9.19] - 2026-05-30
|
||||||
|
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **docker**: three streaming/reliability bugs found in live docker test
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.19
|
||||||
|
## [0.9.18] - 2026-05-29
|
||||||
|
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **stream**: make completed torrent files readable (mmap creates 0000)
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.18
|
||||||
|
## [0.9.17] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **scripts**: prune Forgejo releases >90 days in ship.sh
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **hls**: drop nvenc -tune ll — kills hls segmentation, bump 0.9.17
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.17
|
||||||
|
## [0.9.15] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **sentry**: enhance error handling by skipping user input errors in CaptureError
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **ci**: point Forgejo URLs at torrentclaw org (post-transfer)
|
||||||
|
- **sentry**: decouple agent import via string-match, rename predicate
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
- **positioning**: reframe unarr around download/stream/transcode, drop misleading search-first wording
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **ci**: unset GITHUB_TOKEN so goreleaser uses GITEA_TOKEN
|
||||||
|
- **sentry**: skip "daemon not running" stop/reload errors
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.15
|
||||||
|
- **scripts**: harden release.sh against double-release and inline version bumps
|
||||||
|
- untrack .claude/ (private local config)
|
||||||
|
## [0.9.14] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **vaapi**: hybrid CPU-scale + hwupload encode path (QW2, 0.9.14)
|
||||||
|
|
||||||
|
### CI/CD
|
||||||
|
|
||||||
|
- port workflows from .github/ to .forgejo/ (Forgejo Actions)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **daemon**: defensive IsClosed check in watchSessionReady poll loop
|
||||||
|
- **daemon**: use parent ctx for MarkSessionReady so cancel propagates
|
||||||
|
- **release**: move gitea_urls to top-level (goreleaser v2 schema)
|
||||||
|
## [0.9.13] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **agent**: session-ready webhook for SSE-driven player handshake (0.9.13)
|
||||||
|
- **agent**: send full transcoder diagnostic in register payload (0.9.12)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **daemon**: defer probeCancel so a panic mid-diagnostic still releases ctx
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: add ship.sh end-to-end pipeline as GH Actions backup
|
||||||
|
- **skills**: add /publish slash command + allow .claude/ in git
|
||||||
|
## [0.9.11] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **hls**: pre-segmentación delantada — 2 s segments + async session start (0.9.10)
|
||||||
|
- **hls**: faster first-start — probe cache + tighter encoder presets (0.9.9)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **hls**: critico-driven hardening of fase 3.2
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **cors**: allow play from .to / staging / onion mirrors
|
||||||
|
- **library**: classify resolution by width + height, not height alone
|
||||||
|
- **transcode**: make preset libx264-only + restore quality opt-in
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.11
|
||||||
|
## [0.9.8] - 2026-05-27
|
||||||
|
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **upgrade**: break auto-apply restart loop (0.9.8)
|
||||||
|
## [0.9.7] - 2026-05-26
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **hls**: persistent fMP4 segment cache + integrity + stats (0.9.7)
|
||||||
|
## [0.9.6] - 2026-05-26
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **daemon**: auto-apply upgrades when server signals (0.9.6)
|
||||||
|
## [0.9.5] - 2026-05-26
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **funnel**: cloudflare quick tunnel embedded subprocess (0.9.5)
|
||||||
|
## [0.9.4] - 2026-05-26
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **stream**: retire WebRTC, HLS-only, bump 0.9.4 (**BREAKING**)
|
||||||
|
## [0.9.3] - 2026-05-26
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **usenet**: warn at startup when par2 or extractor is missing
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **engine**: truncate errorMessage before reporting status
|
||||||
|
- **hls**: clamp ffmpeg bitrate to the level we derive from outputHeight
|
||||||
|
## [0.9.2] - 2026-05-22
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **vpn**: unarr vpn command + report/arbitrate the WireGuard slot
|
||||||
## [0.9.1] - 2026-05-21
|
## [0.9.1] - 2026-05-21
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -58,6 +272,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- **security**: bump golang.org/x deps and add container CVE scan gate
|
- **security**: bump golang.org/x deps and add container CVE scan gate
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- **release**: 0.9.1
|
||||||
## [0.9.0] - 2026-05-21
|
## [0.9.0] - 2026-05-21
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -67,6 +285,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
- **vpn**: local config_file for self-hosted/personal VPN testing
|
- **vpn**: local config_file for self-hosted/personal VPN testing
|
||||||
- **vpn**: split-tunnel torrent traffic through managed WireGuard
|
- **vpn**: split-tunnel torrent traffic through managed WireGuard
|
||||||
|
|
||||||
|
### CI/CD
|
||||||
|
|
||||||
|
- deploy install scripts to GitHub Pages
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- **docker**: refresh Docker Hub README + sync description in CI
|
- **docker**: refresh Docker Hub README + sync description in CI
|
||||||
|
|
@ -80,6 +302,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
|
|
||||||
### Other
|
### Other
|
||||||
|
|
||||||
|
- **pages**: add .nojekyll to disable Jekyll processing
|
||||||
|
- **pages**: set custom domain unarr.torrentclaw.com
|
||||||
- **release**: 0.9.0
|
- **release**: 0.9.0
|
||||||
## [0.8.1] - 2026-05-08
|
## [0.8.1] - 2026-05-08
|
||||||
|
|
||||||
|
|
@ -453,6 +677,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
- add -s -w -trimpath to Makefile, add build-small target with UPX
|
- add -s -w -trimpath to Makefile, add build-small target with UPX
|
||||||
|
[1.0.1-beta]: https://github.com/torrentclaw/unarr/compare/v1.0.0-beta...v1.0.1-beta
|
||||||
|
[1.0.0-beta]: https://github.com/torrentclaw/unarr/compare/v0.9.19...v1.0.0-beta
|
||||||
|
[0.9.19]: https://github.com/torrentclaw/unarr/compare/v0.9.18...v0.9.19
|
||||||
|
[0.9.18]: https://github.com/torrentclaw/unarr/compare/v0.9.17...v0.9.18
|
||||||
|
[0.9.17]: https://github.com/torrentclaw/unarr/compare/v0.9.15...v0.9.17
|
||||||
|
[0.9.15]: https://github.com/torrentclaw/unarr/compare/v0.9.14...v0.9.15
|
||||||
|
[0.9.14]: https://github.com/torrentclaw/unarr/compare/v0.9.13...v0.9.14
|
||||||
|
[0.9.13]: https://github.com/torrentclaw/unarr/compare/v0.9.11...v0.9.13
|
||||||
|
[0.9.11]: https://github.com/torrentclaw/unarr/compare/v0.9.8...v0.9.11
|
||||||
|
[0.9.8]: https://github.com/torrentclaw/unarr/compare/v0.9.7...v0.9.8
|
||||||
|
[0.9.7]: https://github.com/torrentclaw/unarr/compare/v0.9.6...v0.9.7
|
||||||
|
[0.9.6]: https://github.com/torrentclaw/unarr/compare/v0.9.5...v0.9.6
|
||||||
|
[0.9.5]: https://github.com/torrentclaw/unarr/compare/v0.9.4...v0.9.5
|
||||||
|
[0.9.4]: https://github.com/torrentclaw/unarr/compare/v0.9.3...v0.9.4
|
||||||
|
[0.9.3]: https://github.com/torrentclaw/unarr/compare/v0.9.2...v0.9.3
|
||||||
|
[0.9.2]: https://github.com/torrentclaw/unarr/compare/v0.9.1...v0.9.2
|
||||||
[0.9.1]: https://github.com/torrentclaw/unarr/compare/v0.9.0...v0.9.1
|
[0.9.1]: https://github.com/torrentclaw/unarr/compare/v0.9.0...v0.9.1
|
||||||
[0.9.0]: https://github.com/torrentclaw/unarr/compare/v0.8.1...v0.9.0
|
[0.9.0]: https://github.com/torrentclaw/unarr/compare/v0.8.1...v0.9.0
|
||||||
[0.8.1]: https://github.com/torrentclaw/unarr/compare/v0.8.0...v0.8.1
|
[0.8.1]: https://github.com/torrentclaw/unarr/compare/v0.8.0...v0.8.1
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,9 @@
|
||||||
# unarr
|
# unarr
|
||||||
|
|
||||||
**The single binary that replaces your whole *arr stack.** Search 30+ torrent
|
**The single binary that replaces your whole *arr stack.** Built-in torrent,
|
||||||
sources, inspect real quality before you download, grab subtitles, and manage
|
debrid, and usenet engines. Stream, transcode, and organize your library from
|
||||||
your media library — all from one terminal tool or a headless daemon.
|
one terminal — or run it as a headless daemon with a web dashboard, WireGuard
|
||||||
|
split-tunnel, and Cloudflare Funnel remote access.
|
||||||
|
|
||||||
**[Website & docs](https://torrentclaw.com/unarr)** · **[Install guide](https://torrentclaw.com/cli)** · **[Get an API key](https://torrentclaw.com)**
|
**[Website & docs](https://torrentclaw.com/unarr)** · **[Install guide](https://torrentclaw.com/cli)** · **[Get an API key](https://torrentclaw.com)**
|
||||||
|
|
||||||
|
|
|
||||||
90
Dockerfile
90
Dockerfile
|
|
@ -1,5 +1,8 @@
|
||||||
# ---- Build stage ----
|
# ---- Build stage ----
|
||||||
FROM golang:1.25-alpine AS builder
|
# Pin the builder to the host's native arch and cross-compile (CGO is off, so
|
||||||
|
# Go cross-compiles trivially). During multi-arch buildx this keeps `go build`
|
||||||
|
# at native speed instead of compiling under QEMU emulation for the foreign arch.
|
||||||
|
FROM --platform=$BUILDPLATFORM golang:1.25-alpine AS builder
|
||||||
|
|
||||||
RUN apk add --no-cache git ca-certificates
|
RUN apk add --no-cache git ca-certificates
|
||||||
|
|
||||||
|
|
@ -13,21 +16,69 @@ RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
ARG VERSION=dev
|
ARG VERSION=dev
|
||||||
RUN CGO_ENABLED=0 go build -ldflags="-s -w -X github.com/torrentclaw/unarr/internal/cmd.Version=${VERSION}" -trimpath -o /unarr ./cmd/unarr/
|
ARG TARGETOS
|
||||||
|
ARG TARGETARCH
|
||||||
|
RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -ldflags="-s -w -X github.com/torrentclaw/unarr/internal/cmd.Version=${VERSION}" -trimpath -o /unarr ./cmd/unarr/
|
||||||
|
|
||||||
# ---- Runtime stage ----
|
# ---- Runtime stage ----
|
||||||
FROM alpine:3.22
|
# glibc base (not Alpine/musl). NVIDIA's userspace — nvidia-smi and the
|
||||||
|
# libnvidia-encode / libcuda libs that `--gpus all` injects, plus the static
|
||||||
|
# BtbN ffmpeg that links nvenc — are all glibc ELF. On musl they fail with
|
||||||
|
# "no such file or directory" (missing glibc loader), so HW transcode is
|
||||||
|
# impossible on Alpine. bookworm-slim is the smallest base that runs the full
|
||||||
|
# NVIDIA stack while still falling back to software libx264 when no GPU is
|
||||||
|
# passed in.
|
||||||
|
FROM debian:bookworm-slim
|
||||||
|
|
||||||
# Use Alpine's native musl ffmpeg + ffprobe instead of the johnvansickle /
|
# par2 → repair corrupted Usenet segments (without it a single bad segment
|
||||||
# BtbN static glibc builds — those need a glibc shim on Alpine and the
|
# silently corrupts the output).
|
||||||
# vector-math symbols the GPL builds reference are not satisfiable by
|
# 7z → archive extractor for RAR/7z-packed downloads (p7zip-full also reads
|
||||||
# gcompat. Alpine ships ffmpeg ~7.x which is fine for the WebRTC
|
# RAR5, so unrar — unavailable as a free Debian package — isn't needed).
|
||||||
# transcoding pipeline (libx264 + libfdk-aac alternatives included).
|
# tzdata/ca-certificates → TLS + correct local time for schedules/logs.
|
||||||
RUN apk upgrade --no-cache && \
|
# libvulkan1 → the Vulkan loader (libvulkan.so.1). ffmpeg's libplacebo filter
|
||||||
apk add --no-cache ca-certificates tzdata ffmpeg
|
# (GPU HDR→SDR tonemap) loads Vulkan dynamically through it; without the
|
||||||
|
# loader the filter can't reach a GPU even when the NVIDIA driver mounts
|
||||||
|
# its ICD. ~150 KB. The agent only USES libplacebo after a functional
|
||||||
|
# probe (FFmpegSupportsLibplacebo) succeeds AND a real HW encoder is
|
||||||
|
# present, so this is inert on hosts without a working Vulkan GPU.
|
||||||
|
RUN apt-get update && \
|
||||||
|
apt-get install -y --no-install-recommends \
|
||||||
|
ca-certificates tzdata wget xz-utils par2 p7zip-full libvulkan1 && \
|
||||||
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# TARGETARCH is set automatically by Docker buildx during cross-builds.
|
||||||
|
ARG TARGETARCH=amd64
|
||||||
|
|
||||||
|
# Static GPL ffmpeg + ffprobe with nvenc compiled in (BtbN builds). nvenc is
|
||||||
|
# linked but the actual libnvidia-encode.so is dlopen'd at runtime from the
|
||||||
|
# host driver that `--gpus all` exposes — so the same binary does HW transcode
|
||||||
|
# when a GPU is present and falls back to libx264 when it isn't. Placed in
|
||||||
|
# /usr/local/bin so ResolveFFmpeg picks them up off PATH ahead of any distro
|
||||||
|
# ffmpeg. arm64 has no nvenc but the build still serves software transcode.
|
||||||
|
RUN case "$TARGETARCH" in \
|
||||||
|
amd64) FF_ARCH=linux64 ;; \
|
||||||
|
arm64) FF_ARCH=linuxarm64 ;; \
|
||||||
|
*) echo "unsupported TARGETARCH=$TARGETARCH" >&2; exit 1 ;; \
|
||||||
|
esac && \
|
||||||
|
wget -4 --tries=3 --timeout=30 -qO /tmp/ffmpeg.tar.xz "https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-${FF_ARCH}-gpl.tar.xz" && \
|
||||||
|
mkdir -p /tmp/ff && tar -xJf /tmp/ffmpeg.tar.xz -C /tmp/ff --strip-components=1 && \
|
||||||
|
cp /tmp/ff/bin/ffmpeg /tmp/ff/bin/ffprobe /usr/local/bin/ && \
|
||||||
|
chmod +x /usr/local/bin/ffmpeg /usr/local/bin/ffprobe && \
|
||||||
|
rm -rf /tmp/ffmpeg.tar.xz /tmp/ff
|
||||||
|
|
||||||
|
# Bundle cloudflared so `unarr funnel on` (default: on, see config defaults)
|
||||||
|
# Just Works on a headless container with no first-run network round-trip.
|
||||||
|
RUN case "$TARGETARCH" in \
|
||||||
|
amd64) CF_ARCH=amd64 ;; \
|
||||||
|
arm64) CF_ARCH=arm64 ;; \
|
||||||
|
arm) CF_ARCH=armhf ;; \
|
||||||
|
*) echo "unsupported TARGETARCH=$TARGETARCH" >&2; exit 1 ;; \
|
||||||
|
esac && \
|
||||||
|
wget -4 --tries=3 --timeout=30 -qO /usr/local/bin/cloudflared "https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-$CF_ARCH" && \
|
||||||
|
chmod +x /usr/local/bin/cloudflared
|
||||||
|
|
||||||
# Non-root user (UID 1000 matches typical host user for volume permissions)
|
# Non-root user (UID 1000 matches typical host user for volume permissions)
|
||||||
RUN addgroup -g 1000 unarr && adduser -u 1000 -G unarr -D -h /home/unarr unarr
|
RUN groupadd -g 1000 unarr && useradd -u 1000 -g 1000 -m -d /home/unarr unarr
|
||||||
|
|
||||||
# Default directories
|
# Default directories
|
||||||
RUN mkdir -p /config /downloads /data && \
|
RUN mkdir -p /config /downloads /data && \
|
||||||
|
|
@ -42,6 +93,23 @@ ENV UNARR_CONFIG_DIR=/config
|
||||||
ENV UNARR_DOWNLOAD_DIR=/downloads
|
ENV UNARR_DOWNLOAD_DIR=/downloads
|
||||||
ENV XDG_DATA_HOME=/data
|
ENV XDG_DATA_HOME=/data
|
||||||
|
|
||||||
|
# Mark this as a container install so the agent reports isDocker=true to the web
|
||||||
|
# (which then shows a `docker pull` command instead of the in-app update button —
|
||||||
|
# the binary self-update refuses to run in Docker). Covers podman/containerd too,
|
||||||
|
# which don't create /.dockerenv. See internal/agent/RunningInDocker.
|
||||||
|
ENV UNARR_DOCKER=1
|
||||||
|
|
||||||
|
# NVIDIA passthrough defaults. `--gpus all` alone only grants the "utility" +
|
||||||
|
# "compute" capabilities; nvenc needs "video", and "graphics" makes the runtime
|
||||||
|
# mount the NVIDIA Vulkan ICD (nvidia_icd.json — the load-bearing piece — plus
|
||||||
|
# GLX/EGL libs) so ffmpeg's libplacebo filter (GPU HDR tonemap, paired with
|
||||||
|
# libvulkan1 above) can create a Vulkan device. "compute" alone does NOT mount
|
||||||
|
# the ICD. Baking these here means a plain `docker run --gpus all` (or the compose
|
||||||
|
# device reservation) lights up HW transcode + GPU tonemap with zero extra flags.
|
||||||
|
# Harmless when no GPU is attached.
|
||||||
|
ENV NVIDIA_VISIBLE_DEVICES=all
|
||||||
|
ENV NVIDIA_DRIVER_CAPABILITIES=video,compute,utility,graphics
|
||||||
|
|
||||||
VOLUME ["/config", "/downloads", "/data"]
|
VOLUME ["/config", "/downloads", "/data"]
|
||||||
|
|
||||||
ENTRYPOINT ["unarr"]
|
ENTRYPOINT ["unarr"]
|
||||||
|
|
|
||||||
661
Docs/plans/unarr-agent-roadmap.md
Normal file
661
Docs/plans/unarr-agent-roadmap.md
Normal file
|
|
@ -0,0 +1,661 @@
|
||||||
|
# unarr CLI agent — roadmap del diferenciador
|
||||||
|
|
||||||
|
> Estado de partida: **v0.9.19 beta** (~26k LOC fuente / ~18k test).
|
||||||
|
> Objetivo estratégico: el agente CLI es el **soporte real y diferenciador** de
|
||||||
|
> unarr — un *servidor de streaming personal* que la web sola no puede ser.
|
||||||
|
> Compite en **profundidad**, no en anchura (no apps nativas por dispositivo:
|
||||||
|
> el agente sirve a un único web-player responsive vía navegador).
|
||||||
|
|
||||||
|
## La visión en 6 puntos
|
||||||
|
|
||||||
|
1. **Hospeda localmente** toda la biblioteca.
|
||||||
|
2. **Debrid** para reproducir cualquier cosa cache-fast.
|
||||||
|
3. **Play-anything sin callejones** (local | debrid | descarga-y-reproduce, con
|
||||||
|
fallback mid-stream).
|
||||||
|
4. **Transcodifica según el dispositivo** (direct-play cuando ya es compatible).
|
||||||
|
5. **Sirve a un web-player universal** en cualquier dispositivo vía navegador.
|
||||||
|
6. **Acceso remoto seguro** al agente.
|
||||||
|
|
||||||
|
## Mapa de partida (qué TIENE el agente hoy)
|
||||||
|
|
||||||
|
Sólido salvo nota:
|
||||||
|
|
||||||
|
- **Descarga torrent** (anacrolix): mmap, DHT warm-start, 30 trackers, pause/cancel,
|
||||||
|
selección vídeo+subs `[engine/torrent.go]`. **Stream-while-download** con reader
|
||||||
|
responsive + `PrioritizeTail` `[engine/stream.go]`.
|
||||||
|
- **Usenet** completo: NNTP pool, yEnc, ensamblado `WriteAt`, resume por segmento,
|
||||||
|
par2 repair, unrar/7z `[usenet/*]`.
|
||||||
|
- **Debrid downloader**: GET con Range/resume `[engine/debrid.go]` — pero solo
|
||||||
|
DESCARGA (no streaming). Resolución server-side.
|
||||||
|
- **HLS transcode** fMP4 + seek real + supervisor `[engine/hls.go]`, **caché HLS LRU**
|
||||||
|
`[engine/hls_cache.go]`, **HW accel** NVENC/QSV/VAAPI/VideoToolbox `[engine/hwaccel.go]`.
|
||||||
|
- **Servidor HTTP** persistente: range/seek, rate-limit 2×bitrate, CORS `[engine/stream_server.go]`.
|
||||||
|
- **Library scan + ffprobe** (codec/HDR/tracks), parse título/temporada `[library/, mediainfo/]`.
|
||||||
|
- **Red**: CloudFlare Quick Tunnel `[funnel/]`, WireGuard userspace split-tunnel `[vpn/]`,
|
||||||
|
NAT-PMP + UPnP `[engine/upnp.go]`. Web hace de broker de URLs (LAN/Tailscale/Public/Funnel).
|
||||||
|
- **Agente**: daemon cobra, sync HTTP long-poll + `/wake`, auto-upgrade opt-in,
|
||||||
|
config.toml exhaustivo.
|
||||||
|
|
||||||
|
## Huecos (de más crítico a más bajo)
|
||||||
|
|
||||||
|
### Hueco #1 — Auth de stream ✅ CERRADO (2026-05-31) / ver estado abajo
|
||||||
|
`/stream` y `/hls` se sirven **sin autenticación** (solo CORS+rate-limit). Con
|
||||||
|
funnel/UPnP el stream queda público en internet. Plan previo
|
||||||
|
`Docs/plans/security-stream-token.md` (deferido, sin código).
|
||||||
|
|
||||||
|
### Hueco #2 — Debrid en el path de streaming ✅ CERRADO (2a+2b+2c, 2026-05-31)
|
||||||
|
Hoy debrid es **solo descarga**, resuelto server-side; el streaming es 100%
|
||||||
|
torrent. La promesa "play instantáneo cache-fast" no ocurre. Falta: source debrid
|
||||||
|
en el path de streaming + cache-availability + **fallback torrent↔debrid mid-stream**.
|
||||||
|
Diseño por fases (2a direct-play / 2b HLS-desde-URL / 2c fallback) en el estado abajo.
|
||||||
|
|
||||||
|
### Hueco #3 — Device-profile + direct-play + ABR ✅ CERRADO (2026-05-31) / ver estado abajo
|
||||||
|
El path HLS re-encodaba todo (incluso mp4 h264/aac ya compatible). `DecideAction`
|
||||||
|
muerto. Sin negociación por capacidades. Sin adaptación de calidad.
|
||||||
|
Diseño por fases (3a direct-play / 3b remux fMP4 / 3c capability-negotiation / 3d ABR)
|
||||||
|
en el estado abajo. **3a + 3b + 3c CERRADAS** (smoke e2e, incl. HEVC en iPhone Safari
|
||||||
|
real). **3d resuelto como 3d-lite (auto-downshift)** — ABR multi-rendition real
|
||||||
|
descartada (N× CPU inviable single-viewer; no aplica a paths copy). Hueco COMPLETO.
|
||||||
|
|
||||||
|
### Hueco #4 — Pre-transcode (transcode-on-download) 🔵 DISEÑADO (ver estado abajo)
|
||||||
|
Al completar una descarga/import, transcodificar/remuxar en background para que el
|
||||||
|
PRIMER play sea instantáneo (direct o cache-HIT), sin transcode en vivo.
|
||||||
|
Optimización, nunca bloqueante: si no terminó a tiempo → fallback a transcode en
|
||||||
|
vivo (HLS actual). Reaprovecha `hls_cache.go` (cache-HIT ya sirve instantáneo) +
|
||||||
|
el pipeline de `prewarm` (ya hace encode de la siguiente ep) — generaliza prewarm a
|
||||||
|
"todo download, configurable" y puebla también el artefacto direct-play. Configurable
|
||||||
|
desde la web. Diseño + set de opciones en el estado abajo.
|
||||||
|
|
||||||
|
### Huecos medios ⬜
|
||||||
|
- ~~Sin gestión de espacio en disco (`Statfs`)~~ ✅ **Pre-flight de espacio (2026-05-31)** — `CheckDiskSpace` antes de cada descarga (torrent/usenet/debrid) con reserva configurable `downloads.min_free_disk_mb` (default 2048); manager NO hace fallback en disco lleno; aviso web 507 `INSUFFICIENT_DISK` al despachar (torrentclaw). Monitoreo mid-download diferido. Ver estado abajo.
|
||||||
|
- ~~Resume de torrent NO persiste reinicio del daemon~~ ✅ **Auto-resume tras reinicio (2026-05-31)** — `agent.ActiveTaskStore` persiste los `agent.Task` de descargas en vuelo (`active-tasks.json`); el daemon los re-somete al arrancar → los downloaders reanudan los bytes (torrent vía completion DB de anacrolix, debrid vía Range, usenet vía tracker). Dedup en `manager.Submit` (restore + re-despacho web no duplican). `shuttingDown` preserva el entry en apagado limpio (solo terminal genuino lo borra). Ver estado abajo.
|
||||||
|
- ~~Sin seeding/ratio lifecycle (flags existen, nadie los aplica)~~ ✅ **Seeding/ratio lifecycle (2026-06-01)** — `seed_enabled`/`seed_ratio`/`seed_time` en `[downloads]` (opt-in, off por defecto) cableados al daemon; al completar una descarga con seeding activo el torrent sigue subiendo en background y un monitor lo dropea al alcanzar ratio (subido/tamaño) O tiempo (lo primero que toque); sin target = siembra hasta apagado. `cleanup()` ahora siempre dropea (arregla fuga en rutas de error con seeding on). Verificado con swarm loopback real. Ver estado abajo.
|
||||||
|
- ~~Reproducir-mientras-baja: readahead estático 5MB~~ ✅ **Readahead dinámico (2026-05-31)** — `dynamicReadahead(bitrate)` = ~30s de vídeo (clamp 8–96 MiB; default 24 MiB sin bitrate) en vez de 5 MiB fijos (~1.9s a 20 Mbps → se atascaba). anacrolix ya prioriza piezas en esa ventana por delante del playhead + en seek; solo faltaba dimensionarla. Bitrate probado async (sin coste TTFF). Ver estado abajo.
|
||||||
|
- ~~HDR→SDR sin tonemap~~ ✅ **Tonemap HDR→SDR (2026-05-31)** — cadena `zscale+tonemap=hable` en el transcode HLS cuando la fuente es HDR y el ffmpeg trae zscale (detectado en runtime, `FFmpegSupportsZscale`; sin zscale → comportamiento actual, no rompe). Verificado en 4K HDR10 real: de lavado/desaturado a colores vívidos. Ver estado abajo.
|
||||||
|
- ~~Sin thumbnails~~ ✅ **Fotogramas bajo demanda (2026-05-31)** — `GET /thumbnail` (ffmpeg 1 frame, `-ss` antes de `-i`, MJPEG) + panel "Características del fichero" (ruta + mediainfo completa + tira de ~5 frames). Ver estado abajo.
|
||||||
|
- ~~Sin trickplay (preview en la barra)~~ ✅ **Trickplay bajo demanda (2026-06-01)** — pista WebVTT `thumbnails` con 1 cue/10s; cada cue es una URL `/thumbnail?pos=…#xywh=0,0,W,H` (frame completo), así media-chrome solo descarga el frame que se sobrevuela. Toggle on/off por navegador (`localStorage`, default ON) + doc (web `docs/architecture/trickplay.md`). Alcance "on-demand" decidido con el usuario. Sin pregenerar sprite/BIF (sigue siendo opción futura con cacheo en disco). Ver estado abajo.
|
||||||
|
- ~~Subtítulos bitmap (PGS/DVB) sin burn-in~~ ✅ **Burn-in PGS/DVB bajo demanda (2026-06-01)** — el usuario elige una pista bitmap en el reproductor → la sesión fuerza HLS y el agente re-codifica con `[0:v:0]<vchain>[base];[0:s:N][base]scale2ref[sub][base2];[base2][sub]overlay[vout]` (overlay tras el tonemap = brillo SDR correcto; scale2ref = encaje a cualquier resolución del PGS). En la cache key. Selector web alimentado de file-details (funciona también en direct-play). Caveat: PGS + seek pierde el subtítulo. Verificado en Sonic BDremux (ES quemado). Ver estado abajo.
|
||||||
|
- ~~Audio siempre downmix estéreo AAC (sin passthrough 5.1)~~ ✅ **Verificado/descartado (2026-06-01)** — el 5.1 in-browser NO es viable (el navegador decodifica+mezcla al dispositivo, no hace bitstream-passthrough; AC3/EAC3/DTS ni se decodifican en Chrome/FF). El downmix solo ocurre en el path HLS. El handoff a player nativo (VLC/mpv/IINA/MPC/Infuse + .m3u/.strm) ya usa `/stream` **crudo** (`http.ServeContent` + `NewFileReader`, sin transcode) → el 5.1/Atmos/DTS original llega intacto al reproductor nativo. Sin trabajo necesario.
|
||||||
|
- Mediaserver solo DETECTA Plex/Jellyfin/Emby — no biblioteca navegable propia. **(diferido al final por decisión del operador)**
|
||||||
|
- TLS solo vía funnel; LAN/Tailscale/UPnP = HTTP plano (mixed-content desde web HTTPS). ⏸️ **Cimiento construido + DIFERIDO (2026-06-01)** — listener HTTPS por-agente con cert hot-reload (commit `27bee8c`, inerte sin cert). Decisión: MVP CF-only (single-SAN por agente, DNS-01 vía CF API, sin DNS propio); fase broker+DNS diferida. Doc: web `docs/plans/agent-tls-direct.md`.
|
||||||
|
- Funnel = SPOF CloudFlare (rota ~6h), sin relay propio.
|
||||||
|
- ~~"Tailscale Funnel" mal nombrado~~ ✅ **Ya correcto (2026-06-01)** — no existe el literal en ningún sitio del código; el comando, el help y los docs nombran consistentemente "CloudFlare Quick Tunnel". La nota era stale; nada que renombrar.
|
||||||
|
- ~~Dos clientes HTTP divergentes (go-client vs agent client)~~ ✅ (resuelto — ver sección Cerrada).
|
||||||
|
- ~~Long-poll en vez de WS/SSE~~ ✅ **Realtime: SSE downlink + uplink event-driven + push al navegador (2026-06-01, CLI 0.14.0)** — las 3 patas de la comunicación agente↔web↔navegador:
|
||||||
|
1. **Downlink (server→agente):** `GET /api/internal/agent/events` (SSE) empuja `event: command` (controles tipados desde DB, no-consuming) + `event: sync` (nudge), heartbeat 15s, colgado del Redis pub/sub `agent:wake` (multi-replica). El CLI lo consume SSE-first con **fallback a long-poll liveness-probed** (SSE es buffering-intolerante; long-poll es buffering-tolerante → red de seguridad para proxies/ISP que bufferean). Config `[daemon] downlink=auto|sse|poll`. Cliente SSE resucitado del `signal_client.go` histórico.
|
||||||
|
2. **Uplink (agente→server):** cada transición de estado del `Task` dispara `onChange→TriggerSync` (coalescido), en vez de esperar al tick adaptativo 3s/10s. Cubre descargas y streams.
|
||||||
|
3. **Browser-leg (server→navegador):** `/agent/sync` publica en un signal-bus Redis genérico (`createSignalBus`); `progress-stream` se suscribe y empuja snapshot al instante (backstop 10s, antes busy-poll 3s) + dedupe de frames idénticos en el cliente. `markWatching` despierta al agente en el flanco para reporte 3s inmediato al abrir la página.
|
||||||
|
|
||||||
|
Verificado e2e (control instantáneo + fallback + push). De paso: arreglado el allow-list de marca unarr que 404eaba `/api/internal/downloads|library|profile|…`. Commits web `11b70fae`/`1e77b948`/`bdb0ab92`/`cf3e4423`, cli `1052529`/`864b6ea`.
|
||||||
|
|
||||||
|
### Deuda puntual
|
||||||
|
VAAPI workarounds por host · sesión única (1 viewer).
|
||||||
|
|
||||||
|
**Cerrada (2026-06-01):**
|
||||||
|
- ~~`makeReadable` parchea mmap 0000 (frágil NFS)~~ ✅ tras el chmod ahora **verifica** que el fichero abre; si no (NFS root_squash / mapeo uid SMB) emite un WARNING claro y accionable + cuenta de fallos en el walk, en vez de dejar un "permission denied" críptico aguas abajo.
|
||||||
|
- ~~par2/unrar degradan en silencio si falta binario~~ ✅ `Par2Verify`/`Par2Repair` devuelven `ErrPar2NotInstalled` (antes `nil`=verificado); el pipeline lo surfacea (`Result.VerifyNote` + WARNING) → la descarga se entrega marcada UNVERIFIED, no como verificada. (El lado extract ya fallaba claro.)
|
||||||
|
- ~~cloudflared sin verificación de firma~~ ✅ el auto-download ahora fija la versión (`pinnedCloudflaredVersion`) y **verifica SHA-256** contra hashes horneados (no `latest`); un release upstream malicioso/roto ya no se trae en silencio.
|
||||||
|
- ~~WireGuard endpoint sin pin~~ ✅ **descartado**: el reseller de VPN (VPNResellers) usa configuración WireGuard directa sin pin de endpoint; no aplica.
|
||||||
|
- ~~Dos clientes HTTP divergentes (go-client vs agent)~~ ✅ el go-client (API público: search/popular/etc.) ahora recibe **mirror-failover** vía un `MirrorRoundTripper` que reusa el mismo `MirrorPool` + política `IsTransient` del agent client (inyectado con `tc.WithHTTPClient`) → ambos sobreviven una caída del dominio primario igual; antes el público se quedaba clavado en el primario.
|
||||||
|
|
||||||
|
## Mejoras detectadas durante el trabajo (backlog)
|
||||||
|
|
||||||
|
> Se rellena a medida que se trabaja cada hueco. Cada entrada: qué, por qué, prioridad.
|
||||||
|
|
||||||
|
- **Clock-skew en verificación de token** (baja): `verifyStreamToken` no tolera skew; con TTL 6h y NTP es irrelevante, pero el HLS lo mintea el web y lo verifica el agente (relojes distintos). Considerar ~60s de gracia si aparecen 404 espurios.
|
||||||
|
- **Secreto de stream en claro en DB** (baja): `agent_registration.stream_secret` es una clave HMAC viva (por arranque) en la DB central; quien lea la DB puede mintear tokens HLS de cualquier agente. Inherente al diseño (el web debe mintear HLS). Mitigado por regeneración por arranque. Excluir esta columna de cualquier JSON admin/usuario.
|
||||||
|
- **Refrescar/limpiar streamUrl al re-registrar** (baja): tras reinicio del daemon el secreto cambia; URLs `?t=` ya guardadas en `download_task.streamUrl` quedan stale hasta re-stream. Es auto-curativo, pero el web podría limpiar streamUrl en el re-register del agente.
|
||||||
|
- **gofmt preexistente** en `internal/agent/types.go` (StreamSession) y `hls.go`/`torrent.go`/`stream_source.go` (no introducido por este trabajo) — chore aparte.
|
||||||
|
- **Data race preexistente manager↔reporter (baja)**: bajo `-race`, `Task.ToStatusUpdate()` (leído por `ProgressReporter.flushBatch`) corre sin lock contra la escritura de campos del task en `processTask` (`manager.go:371`). No introducido por el resume; expuesto al correr la suite con `-race` (la suite normal corre sin `-race`). Fix: proteger los campos de estado/progreso del `Task` con su `mu` en ToStatusUpdate + processTask. Chore aparte. Múltiples `task.ID[:8]` en `progress.go`/`torrent.go` paniquean con ids <8 chars (irreal: el web manda UUIDs) — limpiar a `ShortID` de paso.
|
||||||
|
- **Funnel = SPOF CloudFlare** (ya en huecos medios): el funnel sigue siendo trycloudflare; relay propio pendiente.
|
||||||
|
- ~~**Rutas localizadas unarr 404 (media)**~~ ✅ **ARREGLADO (2026-05-31)**: bajo `NEXT_PUBLIC_BRAND=unarr` el allowlist `UNARR_PAGE_PREFIXES` (paths EN) no reconocía los localizados de next-intl (`/es/biblioteca`, `/es/descargas`, `/es/perfil`) → 404. Fix (web): `enFirstSegmentByLocalized` (mapa localizado→EN derivado de `routing.pathnames`) + `toCanonicalPath()` en `branding/routes.ts` traduce el 1er segmento antes del match. Assertion anti-colisión en el build del mapa (fail-fast si una ruta futura reusa un segmento → no puede colar una ruta denegada). Verificado: 175 entradas, cero crossover; denegadas siguen denegadas.
|
||||||
|
- ~~**Thumbnails — sprites/trickplay (media)**~~ ✅ **Trickplay CERRADO bajo demanda (2026-06-01)**: la preview de barra usa cues `/thumbnail` en vivo (un frame por cue al sobrevolar), no un sprite pregenerado. El sprite/BIF de toda la timeline con cacheo en disco del agente sigue siendo una optimización futura (no necesaria para la UX actual). Ver estado abajo.
|
||||||
|
- **nvenc "Invalid Level" en fuentes anamórficas (alta — destapado en el smoke de trickplay)** ✅ **ARREGLADO (2026-06-01)**: el nivel H.264 del transcode HLS se derivaba solo de la altura → una fuente 2.39:1 escalada a 1080 (~2586×1080 = 11016 MBs) revienta el `MaxFS` de L4.1 (8192); ffmpeg fallaba (`InitializeEncoder failed: invalid param (8): Invalid Level` en nvenc, `frame MB size > level limit` en libx264) y la sesión no producía ningún segmento. Casi todos los rips 4K son anamórficos → reproducción HLS rota en silencio. Fix (`hwaccel.go`): `H264LevelForFrame(width,height)` deriva el nivel del recuento de macrobloques real (máx. entre el nivel por-altura y el por-MB); `hls.go` calcula el ancho de salida y lo usa. Ver estado abajo.
|
||||||
|
|
||||||
|
### Hueco medio — Readahead dinámico (ver-mientras-baja) ✅ CERRADO (2026-05-31)
|
||||||
|
El lector de torrent usaba un readahead **estático de 5 MiB** (~1.9s de un stream 4K de 20 Mbps) → al reproducir un torrent a medio bajar, la reproducción adelantaba a la descarga y se atascaba.
|
||||||
|
- `dynamicReadahead(bitrateBps)` (`readahead.go`): ~30s de vídeo, clamp [8, 96] MiB; default 24 MiB cuando el bitrate es desconocido (ya ~5× el viejo 5 MiB). anacrolix (`SetResponsive`+`SetReadahead`) ya prioriza las piezas de esa ventana por delante del read position y re-prioriza en seek — el feedback playhead→prioridad estaba; solo faltaba dimensionar la ventana.
|
||||||
|
- `torrentFileProvider` lleva `bitrateBps atomic.Int64`, sondeado **async** (`probeMediaInfo` en goroutine vía DataDir+DisplayPath) — sin coste de TTFF; hasta resolverse usa el default, y los readers posteriores (cada range/seek crea uno) cogen el valor preciso. StreamEngine (CLI) → default 24 MiB.
|
||||||
|
- **Smoke**: ffprobe en 4K real (20.7 Mbps) → readahead **73 MiB** (~28s) vs 5 MiB. Tests del func puro + -race limpio en el probe async. /critico: código sólido, fix aplicado (probe síncrono→async para eliminar 3s de TTFF si falta la cabecera).
|
||||||
|
|
||||||
|
### Hueco medio — Trickplay (preview en la barra) ✅ CERRADO (2026-06-01)
|
||||||
|
Preview de fotograma al pasar el ratón por la barra de búsqueda, **bajo demanda** (sin pregenerar sprite). Alcance decidido con el usuario: on-demand + UX no invasiva + activable/desactivable + documentado.
|
||||||
|
- **Web** (rama `feat/unarr-brand`): `buildTrickplayVtt()` (`src/lib/stream/trickplay.ts`) emite una pista WebVTT `thumbnails` con 1 cue/10s; cada cue apunta a `GET /thumbnail?pos=<seg>&w=320#xywh=0,0,W,H` (frame completo, alto par derivado del aspecto). media-chrome solo descarga el frame sobrevolado y lo cachea. Wiring en `HlsStreamPlayer` (fetch a `file-details` → blob VTT → `<track>`), botón on/off + var CSS de fondo en `MediaChromePlayer`, toggle por navegador en `localStorage` (`useTrickplay`, default ON). Doc: `docs/architecture/trickplay.md`. Tests: `trickplay.test.ts` (6, formato cue + alto par + token vacío + inputs insuficientes).
|
||||||
|
- **Smoke real** (iPhone-equiv en Chrome, F1 4K DV+HDR10): vídeo reproduce → hover en la barra renderiza un frame real en la posición (1:17:36) ≠ el frame en curso; etiqueta de tiempo inmediata; toggle off → `<track>` desaparece (sin preview) y persiste `localStorage="0"`; toggle on → vuelven los 932 cues. CORS del `<img crossorigin>` OK (allowlist del agente).
|
||||||
|
- **No invasivo**: nada carga hasta el hover; 1er frame ~0.8–2.1s en 4K-desde-NAS, re-hover instantáneo (caché navegador); la etiqueta de tiempo aparece ya aunque el frame se esté generando.
|
||||||
|
|
||||||
|
### Hueco medio — Burn-in de subtítulos bitmap (PGS/DVB) ✅ CERRADO (2026-06-01)
|
||||||
|
Los subs de imagen (PGS/DVB/VOBSUB) no se pueden servir como WebVTT; se incrustan en el vídeo durante el transcode. Alcance (decidido con el usuario): bajo demanda + nudge cuando el fichero SOLO tiene bitmap (sin auto-activar).
|
||||||
|
- **Agente** (rama `unarr-burnin` ex `feat/unarr-agent`): `HLSSessionConfig.BurnSubtitleIndex *int` (nil=sin burn; puntero para que el 0 no se confunda con "quema pista 0"); en la cache key (`KeyFor`/`KeyForID`). `buildHLSFFmpegArgsAt`: si el índice apunta a una pista bitmap válida, `-map [vout]` + `-filter_complex [0:v:0]<vchain>[base];[0:s:N][base]scale2ref[sub][base2];[base2][sub]overlay[vout]`. Overlay TRAS el tonemap (subs SDR no se aplastan); scale2ref encaja el lienzo PGS al frame. Índice inválido/texto/fuera de rango → fallback a encode limpio (log). `IsTextSubtitle` ahora incluye `"text"` (paridad con el clasificador web). Tests `TestBuildHLSFFmpegArgsBurnSubtitle` (filter_complex/overlay/[vout] vs -vf según bitmap/texto/rango) + cache-key.
|
||||||
|
- **Web** (rama `unarr-burnin` ex `feat/unarr-brand`): columna `streaming_session.burn_subtitle_index` (migración 0139, NOT NULL default -1) en identidad de sesión + dedup; `session/route` fuerza `playMethod=hls` cuando hay burn; `agent.ts` lo pasa al daemon. Selector en `MediaChromePlayer` alimentado de **file-details** (`subtitleTracks`, mediainfo estática) → aparece también en direct-play; posición del array = `-map 0:s:N`. `isBitmapSubtitleCodec` (`src/lib/stream/subtitles.ts`) espeja `IsTextSubtitle`. Notice: "incrustando" al quemar / nudge si solo-bitmap. Doc: `docs/architecture/subtitle-burn-in.md`.
|
||||||
|
- **Smoke real** (Sonic 2020 BDremux 1080p, 7 PGS + 1 subrip): selector lista los 7 PGS (EN/ES/NL · imagen), excluye el subrip; elegir ES (`0:s:2`) fuerza HLS, el agente transcodifica con overlay sin error y el frame muestra **"Sé lo que estáis pensando."** quemado (posición + brillo correctos). /critico 2 revisores: arreglado `"text"` (paridad), reset de burn al cambiar de ítem, `bitmapSubtitles` a flatMap.
|
||||||
|
- **Caveat**: PGS + seek pierde el subtítulo (el `-ss` antes de `-i` tira el estado del decoder PGS). Reproducción lineal desde el inicio = OK. Mitigación futura: decodificar PGS desde el epoch cercano.
|
||||||
|
- **Aislamiento**: este trabajo se hizo en worktrees dedicados (`/tmp/tc-unarr-{web,cli}`, rama `unarr-burnin`) tras una colisión de ramas en los checkouts primarios compartidos. Merge a `feat/unarr-{brand,agent}` pendiente de decisión del operador.
|
||||||
|
|
||||||
|
### Bug agente — nvenc "Invalid Level" en fuentes anamórficas ✅ ARREGLADO (2026-06-01)
|
||||||
|
Destapado durante el smoke de trickplay: el HLS de un 4K anamórfico (3840×1604, 2.39:1) no producía **ningún** segmento.
|
||||||
|
- **Causa**: el nivel H.264 se derivaba solo de la altura de salida (`H264LevelForHeight`). Escalado a 1080 de alto, un 2.39:1 queda ~2586×1080 = 11016 macrobloques, que supera el `MaxFS` del nivel 4.1 (8192). ffmpeg fallaba al abrir el encoder (`InitializeEncoder failed: invalid param (8): Invalid Level` en h264_nvenc; el equivalente `frame MB size > level limit` en libx264) → 0 paquetes → la sesión se quedaba en "preparando sesión" hasta el timeout de mark-ready. Casi todo rip 4K es 2.39:1, así que la reproducción HLS estaba rota para la mayoría de pelis 4K (en silencio).
|
||||||
|
- **Fix** (`hwaccel.go` + `hls.go`): `H264LevelForFrame(width, height)` deriva el nivel del recuento de macrobloques real (`levelForMacroblocks`, tabla MaxFS de la spec) y devuelve el máximo entre ese y el nivel por-altura (que conserva el margen de fps/MBPS). `hls.go` calcula el ancho de salida (`probe.Width * outputHeight / probe.Height`, par) y llama a `H264LevelForFrame`. 16:9 no cambia (mismo resultado que antes); anamórfico sube a 5.0 cuando hace falta. `transcoder.go` no se toca (su `SourceHeight` nunca se rellena → ya cae al default seguro 5.1).
|
||||||
|
- **Reproducido + verificado**: con `/usr/bin/ffmpeg` 6.1.1 + nvenc, `testsrc=2586x1080 @ -level:v 4.1` reproduce el error exacto; `@ 5.0` codifica OK. Tras el fix, sesión HLS del F1 4K arranca sin "Invalid Level"/auto-restart/timeout y el `<video>` carga (`readyState 4`, `duration 9313s`). Tests `H264LevelForFrame` (16:9 sin regresión + anamórfico → 5.0).
|
||||||
|
|
||||||
|
### Hueco medio — Seeding/ratio lifecycle ✅ CERRADO (2026-06-01)
|
||||||
|
Los flags `SeedRatio`/`SeedTime` (`TorrentConfig`) estaban DECLARADOS pero nadie los consumía, y `SeedEnabled` estaba hardcodeado a `false` en ambos constructores → el daemon nunca sembraba y, si se forzaba, sembraba para siempre.
|
||||||
|
- **Config** (`config.go`): `[downloads]` += `seed_enabled` (bool), `seed_ratio` (float), `seed_time` (string duración tipo `"24h"`). Opt-in, off por defecto (zero-values = apagado, sin entradas en `applyDefaults`). Tests `TestLoadSeeding{DefaultsOff,Explicit}`.
|
||||||
|
- **Wiring** (`daemon.go`): parsea `seed_time` (`time.ParseDuration`) y cablea los 3 campos a `TorrentConfig`; log de arranque que distingue ratio / tiempo / ambos / indefinido. El `unarr download` one-shot (foreground) sigue `SeedEnabled:false` a propósito (leech + exit; comentado).
|
||||||
|
- **Ciclo** (`torrent.go`): `seedTargetReached(ratio, time, uploaded, size, elapsed)` puro (ratio = subido/tamaño-seleccionado, estable entre resumes; el primero de ratio>0 o tiempo>0 que se cumple gana; ambos 0 = nunca para). `seedAndDrop` corre detached en un `seedCtx` propio del downloader (cancelado en `Shutdown`) — NO el ctx de la task, que se cancela en cuanto `Download` retorna y el manager libera el slot. Tick configurable (`seedCheckInterval`, default 30s; tests lo bajan). Sale sin dropear si el handle ya se quitó de `d.active` (cancel/pause del usuario) → ni lee stats de un torrent cerrado ni dropea dos veces.
|
||||||
|
- **Bug latente arreglado de paso**: `cleanup()` tenía `if !SeedEnabled { Drop }` — en rutas de ERROR (metadata timeout, disco, poll) con seeding activo borraba de `d.active` pero NO dropeaba → fuga. Ahora `cleanup()` siempre dropea (solo lo llama el error-path y el éxito-sin-seeding); el éxito-con-seeding hace el handoff a `seedAndDrop`.
|
||||||
|
- **Smoke real** (`seed_lifecycle_smoke_test.go`, tag `smoke`): swarm loopback de dos clientes anacrolix (un seeder sirviendo 4 MiB + nuestro `TorrentDownloader` leecheándolo vía `AddClientPeer`). Tras completar (4194304 bytes reales transferidos), `seedAndDrop` con `SeedTime=1s` dispara el target de tiempo (`seed time 1s reached, uploaded 0 B — dropping`) y quita el torrent de `d.active`. Verifica el path real Stats/Drop/ticker, no mocks. Tests puros `TestSeedTargetReached` (9 casos: ratio/tiempo/ninguno/ambos/guarda-tamaño-0) + `TestTorrentDownloader_SeedRatioTime`.
|
||||||
|
|
||||||
|
### Hueco medio — HDR→SDR tonemap en transcode ✅ CERRADO (2026-05-31)
|
||||||
|
HDR (HDR10/HLG/DV) transcodificado a SDR salía lavado/desaturado (sin tonemap). Ahora `buildHLSFFmpegArgsAt` inserta `zscale=t=linear:npl=100,format=gbrpf32le,zscale=p=bt709,tonemap=tonemap=hable:desat=0,zscale=t=bt709:m=bt709:r=tv` tras el scale y antes de `format=`, cuando `probe.HDR != "" && Transcode.TonemapHDR`.
|
||||||
|
- **Gate por capacidad**: `FFmpegSupportsZscale(ffmpegPath)` (cacheado, `ffmpeg -filters`) → solo activa si el build trae zscale/zimg. Sin zscale → no se inserta (la fuente sigue reproduciéndose, desaturada — no rompe). `transcoder.go:270` ya advertía que builds sin zimg no pueden tonemapear; el static ffbinaries puede faltarle, pero `/usr/bin/ffmpeg` (distro) y el docker sí lo traen.
|
||||||
|
- **Filtro CPU válido para todos los encoders**: el decode hwaccel deja los frames en memoria de sistema (no se setea `-hwaccel_output_format`), así que el zscale CPU corre antes del `format=`/`hwupload` (VAAPI) igual que el scale existente.
|
||||||
|
- **Smoke real**: extraído un frame de un 4K HDR10 (Frankenstein DV+HDR10) con y sin la cadena → ambas válidas (sin error), la tonemapeada con rojo vívido + negros profundos vs la lavada. /critico 1 revisor: cadena correcta, sin bugs bloqueantes; fix aplicado (soltar mutex antes del exec en la detección), HLG/DV-only documentados como aproximación (mejor que el baseline).
|
||||||
|
|
||||||
|
### Hueco medio — Auto-resume de descargas tras reinicio ✅ CERRADO (2026-05-31)
|
||||||
|
Antes: tras reiniciar el daemon, una descarga en vuelo quedaba abandonada (cola in-memory perdida, el web no re-despacha una tarea "downloading" atascada) hasta reintento manual. Los BYTES ya persistían (mmap + completion DB BoltDB de anacrolix, keyed por info_hash; debrid Range; usenet tracker) — faltaba que el daemon se re-sometiera solo.
|
||||||
|
- **`agent.ActiveTaskStore`** (`active-tasks.json`, atómico tmp+rename): persiste el payload `agent.Task` re-submittable de descargas en vuelo. Add al arrancar la descarga, Remove en terminal genuino.
|
||||||
|
- **Manager**: interfaz `taskPersister` (inyectable/testeable) + `SetTaskStore`. `Submit` ahora DEDUPLICA (mismo id del restore + re-despacho web no lanzan 2 goroutines) y persiste descargas (no stream/seed/upgrade-ReplacePath). `recordFinished` borra del store SALVO `shuttingDown` (atomic) → un apagado limpio preserva el entry; terminal genuino (completado/fallo/cancel-usuario) lo borra. ForceStart se limpia en el re-submit (respeta MaxConcurrent).
|
||||||
|
- **Daemon**: construye el store, `SetTaskStore`, y al arrancar re-somete `Load()` antes del sync loop.
|
||||||
|
- **/critico**: 1 revisor → **bug CRÍTICO (conf 98)**: el daemon hacía `cancel()` (ctx padre) ANTES de `manager.Shutdown()` → contextos de tarea cancelados antes de marcar `shuttingDown` → recordFinished con shuttingDown=false → borraba el entry → NO resume (guard era código muerto). FIX: `Manager.Shutdown` cancela los contextos él mismo ANTES de `wg.Wait` (con shuttingDown ya puesto) + el daemon llama `Shutdown` antes de `cancel()`. + ForceStart-strip + excluir upgrade. Tests: store round-trip, dedup, persist/remove-terminal, keep-on-shutdown, stream-no-persiste.
|
||||||
|
- **Smoke**: cubierto por unit tests (incl. shutdown-keeps). El e2e real (descarga → kill daemon → restart → resume) no se ejecutó para no reiniciar el agente dev en uso por el usuario.
|
||||||
|
|
||||||
|
### Hueco medio — Gestión de espacio en disco (pre-flight) ✅ CERRADO (2026-05-31)
|
||||||
|
Una descarga ya no llena el disco a 0 a mitad (corrompía el fichero parcial).
|
||||||
|
- **CLI**: `internal/engine/diskspace.go` — `CheckDiskSpace(dir, need, reserve)` usa `agent.DiskInfo` (Statfs/GetDiskFreeSpaceEx, ya abstraído) y devuelve `*InsufficientDiskError` si `free-need < reserve`; best-effort (need≤0 o stat falla → nil, ENOSPC sigue de backstop). Cableado antes de escribir en los 3 downloaders (torrent: DataDir+totalBytes; debrid: outputDir+restantes; usenet: outputDir+totalBytes solo en fresh). Reserva por `SetMinFreeBytes` desde `downloads.min_free_disk_mb` (default 2048 MiB). `manager` falla sin fallback en disco lleno (otra fuente llena el mismo disco). Fix latente: `formatBytes` paniqueaba ≥1PB (array hasta TB) → +PB/EB+clamp.
|
||||||
|
- **WEB**: `/api/internal/download` rechaza 507 `INSUFFICIENT_DISK` antes de crear la tarea si `diskFreeBytes - sizeBytes < 2 GiB` (reserva = default agente). Solo single-file torrent + agente online (telemetría de disco ya fluía). Saltado: stream, usenet, episodios (sizeBytes=pack completo → falso reject), agente offline. `DownloadButton` muestra estado `diskfull` (i18n 7 locales, namespace torrent). Bajo unarr el endpoint está fuera del allowlist → unarr solo streamea; el pre-flight del agente cubre sus descargas.
|
||||||
|
- **Tests/smoke**: Go `diskspace_test` (Statfs real vía TempDir: enough/insufficient/reserve/unknown/bad-dir). Web reject no e2e-smokeable en el dev box (es unarr → endpoint 404); verificado por build+typecheck+lógica. /critico 2 revisores → 2 bugs reales (guard sin `health.online`; falso reject en season packs) + 4 clarity.
|
||||||
|
|
||||||
|
### Hueco medio — Características del fichero + thumbnails bajo demanda ✅ CERRADO (2026-05-31)
|
||||||
|
Panel "ver características del fichero" (ruta + mediainfo completa: codec/HDR/bit-depth/tracks audio+subs/tamaño/duración — ya en DB vía ffprobe, solo faltaba surface) + tira de fotogramas extraídos en vivo por el agente.
|
||||||
|
- **CLI**: `GET /thumbnail?p=&pos=&w=&t=` en el stream server (ffmpeg `-ss <pos>` antes de `-i`, `-frames:v 1`, MJPEG a stdout). Token scope `thumb:<sha256(path)>` (mismo HMAC que `/stream`/`/hls`; web mintea, agente verifica; vector cross-lang Go↔TS pinneado). Clamp a fichero regular, 404-sin-oracle, timeout 20s. `ffmpegPath` cableado en `daemon.go`. Floor `0.13.0`.
|
||||||
|
- **WEB**: endpoints bajo `/api/internal/stream/` (permitido en unarr; `/api/internal/library` NO) — `file-details` (mediainfo + URLs de frames vía funnel HTTPS) + `owned-files` (lista mínima por contentId, solo items con ffprobe). Lógica pura testeada en `src/lib/stream/thumbnails.ts`. Modal compartido `FileDetailsModal`/`useFileDetails` con skeleton + carga progresiva ("Generando X/N…") + fallback por frame. Gating `supportsThumbnails`/`THUMBNAIL_MIN_VERSION`.
|
||||||
|
- **Alcance en ambas marcas**: torrentclaw → acción en los 3 builders de menú de biblioteca (`fileInfoMenuItem` compartido). unarr → `UnarrFileDetailsButton` en `/title/<id>` (la biblioteca unarr son estanterías, no `LibraryPage`). Modal reutiliza labels neutrales (namespace `library`, no `torrent`) → marca limpia.
|
||||||
|
- **Tests/smoke**: Go (token vector, args, 400/404/503, stub-ffmpeg success) + web (resolveThumbnails, parity, version gate, i18n 7 locales). Smoke real contra biblioteca local 4K (Frankenstein, HEVC DV+HDR10): ffmpeg extrae JPEG válido, modal unarr muestra mediainfo + 5 frames vía funnel. /critico 4 revisores → 5 fixes (clipboard promise, dedup posiciones short-clip, tipos compartidos, guard videoInfo, helper menú).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ESTADO POR HUECO
|
||||||
|
|
||||||
|
### Hueco #1 — Auth de stream
|
||||||
|
**Estado:** 🟡 en progreso (iniciado 2026-05-31).
|
||||||
|
|
||||||
|
**Enfoque elegido** (mejora sobre el plan previo, menor blast radius — sin migración DB):
|
||||||
|
token **HMAC stateless minteado por el propio agente**. El agente ya construye las
|
||||||
|
stream URLs que reporta a la web (`daemon.go` → `streamSrv.URLsJSON()`), así que
|
||||||
|
puede firmar el token, embeberlo en la URL, y verificarlo en cada request — la web
|
||||||
|
es passthrough (cambio web ~nulo).
|
||||||
|
|
||||||
|
- Secreto: 32 bytes random en memoria del daemon (rota al reiniciar).
|
||||||
|
- Token: `<expUnix>.<hexHMAC(secret, scope:exp)>`, TTL 6h.
|
||||||
|
- `/stream` + VLC: token en query `?t=`; scope `"stream"`.
|
||||||
|
- `/hls`: token en **path** `/hls/<sessionID>/<token>/<resource>`; scope `"hls:<sessionID>"`.
|
||||||
|
Los URIs hijos de los playlists son **relativos** → el token se propaga solo a
|
||||||
|
segmentos/subs sin reescribir playlists.
|
||||||
|
- **Loopback exento** (mpv/vlc local + health-probe siguen funcionando; el token solo
|
||||||
|
gatea acceso remoto LAN/Tailscale/Public/funnel).
|
||||||
|
- Config `require_stream_token` (default **true**, seguro por defecto).
|
||||||
|
|
||||||
|
**Hecho (CERRADO 2026-05-31):**
|
||||||
|
|
||||||
|
CLI (`torrentclaw-cli`):
|
||||||
|
- `internal/engine/stream_token.go` (nuevo): `mintStreamToken`/`verifyStreamToken` (HMAC-SHA256, constant-time), `newStreamSecret` (32 bytes; **fail-hard** si crypto/rand falla, sin fallback débil).
|
||||||
|
- `internal/engine/stream_server.go`: secreto + `requireToken` en StreamServer; `/stream` y `/hls` verifican el token; `URLsJSON`/`hlsBaseURLs`/`URL()` tokenizan; `StreamSecretHex()`; **sin exención de loopback**; `/playlist.m3u` ya no auto-mintea (cerrado el oracle).
|
||||||
|
- `internal/config/config.go`: `require_stream_token` (default true).
|
||||||
|
- `internal/agent/{types,daemon}.go` + `internal/cmd/daemon.go`: el agente reporta el secreto en register **solo si enforcing**.
|
||||||
|
- Tests: `stream_token_test.go` (mint/verify/expiry/tamper/scope/secret, handler /stream + /hls, **vector de paridad cross-lenguaje**).
|
||||||
|
|
||||||
|
WEB (`torrentclaw-web`):
|
||||||
|
- `src/lib/stream-token.ts` (nuevo): minter HMAC en TS (paridad byte a byte con Go, guard de clave 64-hex).
|
||||||
|
- `src/app/api/internal/stream/session/route.ts`: `buildHlsUrls` inyecta el token de path usando el secreto del agente.
|
||||||
|
- `src/lib/db/schema.ts` + migración `0134_grey_chat.sql`: columna `agent_registration.stream_secret` (ADD COLUMN nullable, segura).
|
||||||
|
- `src/app/api/internal/agent/register/route.ts` + `src/lib/services/agent.ts`: valida (64-hex) + persiste + expone en `getAgentHealth`.
|
||||||
|
- Tests: `tests/unit/stream-token.test.ts` (paridad + guard).
|
||||||
|
|
||||||
|
**Revisión adversarial** (workflow 4 dimensiones) → 1 crítico + 3 high corregidos antes de cerrar:
|
||||||
|
- **CRÍTICO**: la exención de loopback dejaba el **funnel CloudFlare** sin protección (cloudflared proxya tráfico público vía `localhost` → todo el funnel llegaba como loopback). **Fix: eliminada la exención.** Toda URL entregada ya va tokenizada, así que ningún cliente legítimo se rompe; el funnel ahora lleva el token en la URL y verifica.
|
||||||
|
- **HIGH** `/playlist.m3u` era oracle de tokens (fallback self-minting) → **fix: 404 sin streamUrl**.
|
||||||
|
- **HIGH** gate de version-skew mal señalizado (el agente reportaba el secreto aunque enforcement=off) → **fix: reportar solo si enforcing**.
|
||||||
|
- **HIGH** new-agent+old-web rompe HLS remoto → **mitigación por orden de deploy (ver abajo)**, sin tolerar tokenless (no reabrir el agujero).
|
||||||
|
|
||||||
|
**Verificación:** CLI `go build/vet/test ./...` ✓; WEB typecheck+lint+2325 unit ✓; paridad cross-lenguaje verificada en ambos sentidos.
|
||||||
|
|
||||||
|
> ⚠️ **ORDEN DE DEPLOY (obligatorio):** desplegar **primero el WEB** (columna `stream_secret` + minteo HLS), **luego** publicar el binario del agente. Un agente nuevo (enforce por defecto) contra un web viejo (sin minteo HLS) rompería el HLS remoto. El web es retrocompatible (agente viejo sin secreto → URLs sin token). Smoke real de extremo a extremo (daemon + funnel + navegador) **pendiente de hacer con un agente desplegado** — los tests cubren mint/verify/handlers y la paridad, no el round-trip cloudflared en vivo.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Hueco #2 — Debrid en el path de streaming
|
||||||
|
**Estado:** ✅ CERRADO (2a+2b+2c, 2026-05-31).
|
||||||
|
|
||||||
|
**CERRADO 2c (2026-05-31):** fallback mid-stream, alcance = **refresh de URL
|
||||||
|
debrid** (decisión del usuario; el swap cross-source torrent↔debrid se difiere —
|
||||||
|
caso raro, gran complejidad). La preferencia cache-fast (preferir debrid
|
||||||
|
cacheado sobre torrent en streaming) ya la daban 2a/2b por orden de resolución.
|
||||||
|
Los links debrid caducan; una peli larga sobrevive al link → al detectar expiry
|
||||||
|
(401/403/404/410 en direct-play, o salida de red de ffmpeg en HLS) el agente
|
||||||
|
re-resuelve (mismo info_hash → link fresco) y reanuda sin reiniciar.
|
||||||
|
- WEB: endpoint `POST /api/internal/agent/stream-url` (withAgentAuth) →
|
||||||
|
re-resuelve + actualiza fila + devuelve URL. Guard: sesión debrid viva
|
||||||
|
(`direct_url IS NOT NULL`). 409 sin sesión, 410 si re-resolución falla.
|
||||||
|
- CLI: `agentClient.RefreshStreamURL`; `debridFileProvider` URL mutable bajo
|
||||||
|
mutex + reader refresca en expiry (bounded 1+1) + **coalescing singleflight**
|
||||||
|
(N readers del `<video>` → 1 re-resolución); HLS refresca `s.liveURL` (guarded,
|
||||||
|
cfg inmutable → race-free con el seek-restart del handler HTTP) antes del
|
||||||
|
auto-restart de ffmpeg.
|
||||||
|
- Validado: reader refresh + coalescing unit-tested (incl. -race); endpoint
|
||||||
|
e2e contra AllDebrid real (URL fresca + fila). El swap torrent↔debrid queda
|
||||||
|
como mejora futura si aparece demanda.
|
||||||
|
|
||||||
|
**CERRADO 2b (2026-05-31):** HLS-desde-URL para contenido debrid no-nativo
|
||||||
|
(mkv/HEVC/…). ffmpeg lee la URL debrid directa (`-i <url>` + flags de red
|
||||||
|
`-reconnect*`/`-rw_timeout`) y transcodifica a HLS; el seek reinicia ffmpeg con
|
||||||
|
`-ss` antes de `-i` (input-seek vía Range). Cache de segmentos por `CacheID`
|
||||||
|
(info_hash) → replay hace cache-HIT pese a que la URL cambia cada resolución.
|
||||||
|
Validado e2e contra AllDebrid real: mkv HEVC x265 → h264_nvenc desde la URL →
|
||||||
|
Chrome reproduce 1080p vía hls.js, subtítulos extraídos del mkv remoto. Bump
|
||||||
|
CLI 0.11.0→0.12.0 (gate `DEBRID_HLS_MIN_VERSION`). Ficheros: CLI
|
||||||
|
`engine/hls.go` (SourceURL/CacheID/sourceRef + flags red), `cmd/daemon.go`
|
||||||
|
(branch 2b + helper `startHLSPlayback`), `engine/hls_cache.go` (`KeyForID`),
|
||||||
|
`library/mediainfo/ffprobe.go` (no enmascarar errores de URL). WEB
|
||||||
|
`stream/debrid-stream-source.ts` (playMethod direct|hls por contenedor),
|
||||||
|
`services/agent-version-compare.ts` (`supportsDebridHls`).
|
||||||
|
Limitación: solo audio default (raw debrid sin UI de pistas); subs bitmap (PGS)
|
||||||
|
no soportados (igual que HLS local). Si AllDebrid no marca "ready" al primer
|
||||||
|
addMagnet → fallback torrent (sin callejón).
|
||||||
|
|
||||||
|
**CERRADO 2a (2026-05-31):** debrid como fuente de `/stream` (direct-play),
|
||||||
|
validado e2e contra AllDebrid real (cuenta hello@torrentclaw.com): play de un
|
||||||
|
infoHash cacheado mp4 → web resuelve la DirectURL → agente sirve `/stream` por
|
||||||
|
GETs ranged → Chrome reproduce el mp4 1080p real (incluido seek a offset alto
|
||||||
|
para el moov de un fichero sin faststart). CLI bump 0.10.0→0.11.0 (binario local,
|
||||||
|
sin publicar). Fichero clave: `internal/engine/stream_source_debrid.go`.
|
||||||
|
- CLI: `StreamSession.DirectURL`; `debridFileProvider` (`io.ReadSeekCloser` sobre
|
||||||
|
HTTP Range, Seek sin red + GET lazy + reopen-on-seek + HEAD para tamaño +
|
||||||
|
nombre derivado de URL para Content-Type correcto); branch en
|
||||||
|
`daemon.OnStreamSession` (DirectURL presente → provider en goroutine →
|
||||||
|
SetFile → MarkSessionReady), antes de validar filePath y sin ffmpeg.
|
||||||
|
- WEB: columna `streaming_session.direct_url` (mig 0137) + índice
|
||||||
|
`idx_debrid_cache_info_hash` (mig 0138, getHashCacheTier filtra por info_hash);
|
||||||
|
helper `resolveDebridStreamSource` (honesty gate: sin fichero local + infoHash
|
||||||
|
+ agente ≥0.11.0 + `getHashCacheTier`==="verified" + container mp4/m4v +
|
||||||
|
audioIndex -1 + !forceTranscode → resuelve DirectURL, playMethod="direct",
|
||||||
|
quality "original"); gate de versión `DEBRID_STREAM_MIN_VERSION`/
|
||||||
|
`supportsDebridStream`; `getPendingStreamSessions` emite `directUrl` + fallback
|
||||||
|
fileName/fileSize vía join a `torrent` (cubre el caso HEAD-falla del provider).
|
||||||
|
- Player: sin cambios — reusa el path direct-play del hueco #3 (playMethod=direct
|
||||||
|
+ streamUrls).
|
||||||
|
- Limitación 2a (honesta): solo contenido debrid mp4/m4v browser-native; mkv/HEVC
|
||||||
|
debrid → fallback a torrent hasta 2b (HLS-desde-URL). Si AllDebrid no marca el
|
||||||
|
torrent "ready" al primer addMagnet → fallback a torrent (sin callejón).
|
||||||
|
|
||||||
|
**Diseño original (2b/2c siguen vigentes):**
|
||||||
|
|
||||||
|
**Problema (confirmado en el análisis):** hoy `debrid` es **solo descarga**
|
||||||
|
(`engine/debrid.go` baja la `DirectURL` HTTPS resuelta server-side). El
|
||||||
|
streaming es **100% torrent**: `daemon.OnStreamSession` arma el provider desde
|
||||||
|
`sess.FilePath`/`sess.InfoHash`/`sess.TaskID` y `StreamSession` **no lleva
|
||||||
|
DirectURL**. La promesa "play instantáneo cache-fast por debrid" no ocurre.
|
||||||
|
|
||||||
|
**Arquitectura de providers (lo que ya hay):** `FileProvider{ NewFileReader(ctx)
|
||||||
|
io.ReadSeekCloser; FileName(); FileSize() }`. Implementaciones: `torrentFileProvider`,
|
||||||
|
`diskFileProvider`, `StreamEngine`. El /stream sirve un `FileProvider` via
|
||||||
|
`http.ServeContent` (range/seek). El HLS arranca una `HLSSession` desde una ruta
|
||||||
|
de fichero (ffmpeg `-i <path>`).
|
||||||
|
|
||||||
|
**Diseño por fases (de menos a más riesgo):**
|
||||||
|
|
||||||
|
- **Fase 2a — debrid como fuente de /stream (direct-play).** *Slice completo y
|
||||||
|
acotado.*
|
||||||
|
1. Añadir `DirectURL string` a `StreamSession` (web→agente) y a su validación.
|
||||||
|
2. Nuevo `debridFileProvider` (`FileProvider`): `NewFileReader` devuelve un
|
||||||
|
`io.ReadSeekCloser` que hace **GET con Range** contra la `DirectURL` (debrid
|
||||||
|
ya soporta Range, ver `debrid.go`); `FileSize` via HEAD o `sess.FileSize`;
|
||||||
|
`Seek` traducido a `Range:`. Reutilizar la lógica de `debrid.go` (416,
|
||||||
|
Content-Range, reintentos).
|
||||||
|
3. En `OnStreamSession`: si `sess.DirectURL` presente → `debridFileProvider`
|
||||||
|
→ `SetFile`. (Direct-play; el navegador hace range sobre el provider.)
|
||||||
|
4. Web: al crear la sesión de stream, si el contenido está **cacheado en
|
||||||
|
debrid**, resolver la `DirectURL` server-side (como en descargas) e incluirla
|
||||||
|
en el `StreamSession`. Señal de cache: `debridCacheStatus` fresh (ya existe).
|
||||||
|
5. Tests: `debridFileProvider` con un httptest server que sirve Range; round-trip
|
||||||
|
/stream con provider debrid.
|
||||||
|
|
||||||
|
- **Fase 2b — HLS desde URL (transcode de fuentes debrid no-compatibles).**
|
||||||
|
ffmpeg lee HTTP directo (`-i https://…`), así que `HLSSession` puede aceptar
|
||||||
|
una URL como source en vez de una ruta. Mayor cambio en el pipeline HLS
|
||||||
|
(timeouts, reintentos de red, headers). Permite transcodear contenido debrid.
|
||||||
|
|
||||||
|
- **Fase 2c — selección cache-fast + fallback mid-stream ("sin callejones").**
|
||||||
|
- Conciencia de cache en el agente o señal del web para **preferir debrid
|
||||||
|
cacheado sobre torrent** cuando aplique (hoy `resolve.go:22` pone torrent
|
||||||
|
primero).
|
||||||
|
- **Fallback mid-stream**: si la fuente activa muere (peers a 0 / 5xx debrid),
|
||||||
|
cambiar a la otra sin cortar la reproducción. Complejo (estado de sesión,
|
||||||
|
re-seek). Es lo que de verdad cierra "play-anything sin callejones".
|
||||||
|
|
||||||
|
**Ficheros a tocar:** CLI `internal/engine/{stream_server.go (provider), debrid.go,
|
||||||
|
hls.go (2b)}`, `internal/agent/types.go` (+DirectURL), `internal/cmd/daemon.go`
|
||||||
|
(wiring). WEB `src/app/api/internal/stream/session/route.ts` (resolver DirectURL +
|
||||||
|
cache), `src/lib/services/agent.ts`.
|
||||||
|
|
||||||
|
**Partes difíciles / riesgos:** ranged reader robusto sobre HTTP (reconexión,
|
||||||
|
timeouts), HLS-desde-URL (red dentro de ffmpeg), y el fallback mid-stream (estado).
|
||||||
|
Empezar por 2a (valor inmediato, riesgo bajo), 2b y 2c como iteraciones.
|
||||||
|
|
||||||
|
**Mejora detectada:** `resolve.go:22` ordena `torrent > debrid > usenet`; para el
|
||||||
|
diferenciador cache-fast convendría que, **cuando hay cache debrid confirmada**,
|
||||||
|
el orden de STREAMING (no el de descarga) prefiera debrid.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Hueco #3 — Device-profile + direct-play + ABR
|
||||||
|
**Estado:** 🔵 EN CURSO (2026-05-31). Análisis cerrado; fase 3a en implementación.
|
||||||
|
|
||||||
|
**Problema (confirmado en el análisis):**
|
||||||
|
- El path browser usa **HLS y SIEMPRE re-encoda**: `buildHLSFFmpegArgsAt`
|
||||||
|
(`engine/hls.go`) pone `-c:v libx264|nvenc|…` + cadena de filtros completa
|
||||||
|
(scale/format/setparams) + AAC, sin rama de copia. Un mp4 h264/aac 8-bit SDR
|
||||||
|
que el navegador reproduciría tal cual se transcodifica entero. Coste de CPU
|
||||||
|
puro desperdicio.
|
||||||
|
- `DecideAction` + `diskFileSource`/`transcodeSource` (`engine/probe.go`,
|
||||||
|
`engine/stream_source.go`) **son código muerto**: cero callers en producción,
|
||||||
|
solo tests. Distinguen `passthrough/remux/remux-audio/transcode-video` y detectan
|
||||||
|
10-bit/HDR — la lógica de decisión ya existe, no está cableada.
|
||||||
|
|
||||||
|
**Lo que ya hay y se reaprovecha:**
|
||||||
|
- El agente ya expone **dos paths** en el StreamServer (puerto 11818):
|
||||||
|
- `/stream` → sirve el fichero crudo con `http.ServeContent` (HTTP Range
|
||||||
|
completo, sin ffmpeg, ya tokenizado). **Direct-play ya es posible aquí.**
|
||||||
|
- `/hls/<id>/…` → transcode HLS.
|
||||||
|
- El web **construye las URLs** (HLS hoy) desde la info de red del agente
|
||||||
|
(`streamPort`, `tailscaleIp`, `lanIp`, `funnelUrl`, `streamSecret`) y **puede
|
||||||
|
mintear tokens** (`mintStreamToken`, scope `stream` es constante). O sea: el web
|
||||||
|
puede construir la URL `/stream?t=…` de direct-play él mismo.
|
||||||
|
- `libraryItem` ya guarda del scan: `videoCodec`, `audioCodec`, `bitDepth`, `hdr`,
|
||||||
|
`resolution`. Con el contenedor (extensión de `fileName`), el web tiene todo
|
||||||
|
para decidir direct-play SIN re-probar.
|
||||||
|
|
||||||
|
**Diseño por fases (de menos a más riesgo):**
|
||||||
|
|
||||||
|
- **Fase 3a — direct-play passthrough para items de biblioteca.** *El web decide.*
|
||||||
|
*Slice acotado, ambos sentidos de version-skew seguros vía gate de versión.*
|
||||||
|
1. WEB `decidePlayMethod({videoCodec,audioCodec,bitDepth,hdr,container})` →
|
||||||
|
`"direct" | "hls"` (espeja la rama passthrough de Go `DecideAction`: solo
|
||||||
|
`mp4/m4v` + `h264` + `aac` + 8-bit + SDR → direct; todo lo demás → hls).
|
||||||
|
2. WEB gate: `supportsDirectPlay(agentVersion)` (constante de versión mínima).
|
||||||
|
Direct-play solo si el agente la soporta; si no → hls (sin regresión).
|
||||||
|
3. WEB sesión: en la rama `libraryItemPublicId`, seleccionar los campos codec;
|
||||||
|
calcular `playMethod` (gated); persistirlo en `streamingSession.play_method`
|
||||||
|
(migración aditiva, `db:generate`); devolver `playMethod` + `streamUrls`
|
||||||
|
(`/stream?t=` minteadas por el web, lan/ts/funnel) en la respuesta.
|
||||||
|
4. WEB sync: `getPendingStreamSessions` emite `playMethod` al agente.
|
||||||
|
5. CLI: `StreamSession.PlayMethod string`; en `OnStreamSession`, si
|
||||||
|
`PlayMethod=="direct"` → `streamSrv.SetFile(NewDiskFileProvider(path))` +
|
||||||
|
`MarkSessionReady` (sin ffmpeg). Else → `StartHLSSession` (actual).
|
||||||
|
6. WEB player (`HlsStreamPlayer.tsx`): si `data.playMethod==="direct"` → usar
|
||||||
|
`data.streamUrls` + attach nativo `<video src>` (mp4 = reproducible en todo
|
||||||
|
navegador, sin hls.js). Else → flujo HLS actual.
|
||||||
|
- **Limitación honesta:** solo cubre items de biblioteca (escaneados, con
|
||||||
|
metadata codec). Raw `infoHash`/`taskId` → hls (sin probe). Cubrir esos
|
||||||
|
casos = fase 3a-bis (el agente decide tras probar, reportando playMethod por
|
||||||
|
`MarkSessionReady` — requiere extender el payload + SSE + diferir el attach
|
||||||
|
del player al evento ready). Diferido por mayor superficie.
|
||||||
|
|
||||||
|
- **Fase 3b — remux fMP4 progresivo vía /stream (ENFOQUE ELEGIDO 2026-05-31).**
|
||||||
|
Caso `mkv` (u otro contenedor no-mp4) con h264 + aac + 8-bit + SDR: codecs ya
|
||||||
|
browser-native, solo el contenedor estorba. `-c copy` evita el re-encode de vídeo.
|
||||||
|
Descartado HLS-copy (duraciones de segmento variables vs manifiesto pre-render →
|
||||||
|
rompe seek; arreglarlo = probe de keyframes lento o reescribir el núcleo HLS).
|
||||||
|
**Enfoque:** ffmpeg `-c copy -movflags +frag_keyframe+empty_moov+default_base_moof
|
||||||
|
-f mp4` mkv→fMP4 a fichero temporal **creciente**; servir ese fMP4 por **/stream**
|
||||||
|
(mismo path direct-play 3a, attach nativo, sin hls.js, sin manifiesto).
|
||||||
|
**Núcleo real (la parte no-trivial):** servir un fichero que **crece** mientras
|
||||||
|
ffmpeg escribe. El `/stream` actual usa `http.ServeContent` (asume fichero completo
|
||||||
|
y seekable). Hay que:
|
||||||
|
- Resucitar/adaptar el `transcodeSource` muerto (`engine/stream_source.go`):
|
||||||
|
ffmpeg→tmp creciente, `ReadAt` con bloqueo hasta que los bytes existan
|
||||||
|
(`readBlockTimeout`), `EstimatedSize` = bitrate×duración para que la barra del
|
||||||
|
player tenga timeline.
|
||||||
|
- Un **responder de Range manual** en /stream para fuentes no-finales (en vez de
|
||||||
|
`http.ServeContent`): leer `Range`, `ReadAt` la fuente, escribir 206 +
|
||||||
|
`Content-Range` con el tamaño estimado. El path mp4-completo (3a) sigue usando
|
||||||
|
ServeContent (rápido).
|
||||||
|
- Caveat: seek-adelante a zona no-remuxada bloquea hasta que el copy la alcanza
|
||||||
|
(copy es I/O-bound, rápido). Seek-atrás (bytes ya en disco) inmediato.
|
||||||
|
**Plan de incrementos seguros:**
|
||||||
|
- **3b-i (agente, dormido):** `remuxSource` + responder Range para fuentes
|
||||||
|
crecientes, gateado tras `PlayMethod=="remux"` (que el web aún no envía) →
|
||||||
|
commiteable sin romper nada, con tests.
|
||||||
|
- **3b-ii (web+player):** `decidePlayMethod` devuelve `"remux"` para
|
||||||
|
contenedor-no-mp4 + h264/aac/8-bit/SDR; player trata `playMethod != "hls"` igual
|
||||||
|
que direct (streamUrls + attach nativo). Activa 3b. Mismo gate de versión.
|
||||||
|
**Ficheros:** CLI `engine/stream_source.go` (remuxSource), `engine/stream_server.go`
|
||||||
|
(range responder + provider creciente), `cmd/daemon.go` (branch `remux`),
|
||||||
|
`engine/transcoder.go` (args `-c copy` fMP4). WEB `lib/stream/play-method.ts`
|
||||||
|
(+"remux"), `stream/session/route.ts`, `HlsStreamPlayer.tsx` (`!= "hls"`).
|
||||||
|
|
||||||
|
**CERRADO 2026-05-31:**
|
||||||
|
- CLI 3b-i (`feat/unarr-agent` 4a12f13): `GrowingSource` + `NewRemuxSource`
|
||||||
|
(reusa `transcodeSource`+`ActionRemux`, estimate = tamaño origen para copy);
|
||||||
|
`StreamServer.SetGrowingFile` + `serveGrowing` (responder Range manual: 206
|
||||||
|
con total estimado en `Content-Range`, body chunked mientras no-final, exact
|
||||||
|
`Content-Length` al finalizar, bloqueo vía `ReadAt`); branch `remux` en
|
||||||
|
`OnStreamSession`. Tests `parseByteRange`+`serveGrowing` (full/offset/bounded/
|
||||||
|
estimate/HEAD/416). build+vet+test verdes.
|
||||||
|
- WEB 3b-ii (`feat/unarr-brand` 10b7d602): `decidePlayMethod`→`"remux"` para
|
||||||
|
codecs compatibles en contenedor no-nativo; ruta gatea remux como direct
|
||||||
|
(versión, metadata, sin downscale, audioIndex -1); player trata `!= "hls"`
|
||||||
|
como attach nativo. lint+typecheck+2334 unit OK.
|
||||||
|
- **Smoke e2e (browser, mkv h264/aac 1080p):** `playMethod: remux`, `hlsUrls:
|
||||||
|
null`; agente `[stream …] remux (copy) → fMP4`; `/stream` HEAD 200 + GET Range
|
||||||
|
206 con fMP4 válido (`ftyp iso6 mp41`+`moov`); browser reproduce 1080p nativo,
|
||||||
|
duration leída del fMP4, **seek a 2min OK**, **0 reqs `/hls`**. ✓
|
||||||
|
- **Bug cazado por el smoke:** la respuesta `created` de la ruta quedó en
|
||||||
|
`playMethod === "direct" ? null` (en vez de `!== "hls"`) → devolvía `hlsUrls`
|
||||||
|
para remux. Corregido (el player usaba streamUrls igual, pero inconsistente).
|
||||||
|
- **Limitación:** seek-adelante a zona aún-no-remuxada bloquea hasta que el copy
|
||||||
|
(rápido) la alcanza; seek-atrás inmediato. Audio no-default / subs-bitmap →
|
||||||
|
siguen yendo por HLS (gate `audioIndex == -1`).
|
||||||
|
|
||||||
|
- **Fase 3c — capability negotiation (device-profile).** El web envía
|
||||||
|
`{maxHeight, codecs:[h264,hevc,av1], containers}` (de UA + `canPlayType`).
|
||||||
|
`decidePlayMethod` se hace device-aware: p.ej. Safari/AppleTV que reproduce HEVC
|
||||||
|
nativo → passthrough HEVC en vez de transcode HEVC→h264. Reemplaza el heurístico
|
||||||
|
UA-burdo de `resolveAutoQuality`. Web+CLI.
|
||||||
|
|
||||||
|
- **Fase 3d — ABR.** ABR multi-rendition real **DESCARTADA**: N pipelines ffmpeg
|
||||||
|
simultáneos = N× CPU para 1 espectador (mata NAS/Pi), y no aplica a los paths
|
||||||
|
copy (direct/remux = 1 bitrate). Resuelto como **3d-lite (auto-downshift)**:
|
||||||
|
el player ya tenía sondeo de ancho de banda + recomendación + selector manual;
|
||||||
|
3d-lite automatiza la bajada — buffering sostenido 10s → siguiente calidad menor
|
||||||
|
(nueva sesión a bitrate menor), progresivo hasta 480p. Reusa
|
||||||
|
`recommendLowerQuality`/`setQuality`. `setQuality(.., {persist:false})` para no
|
||||||
|
pisar la preferencia del usuario por un stall transitorio. **CERRADO (web 8bf8e416)**;
|
||||||
|
smoke en Chrome (Slow-3G + seek → consola `auto-downshift 720p → 480p`, nueva
|
||||||
|
sesión reproduce). Hallazgo: este Chrome reproduce HLS **nativo** (como Safari);
|
||||||
|
hls.js es fallback.
|
||||||
|
|
||||||
|
**Ficheros a tocar (3a):** CLI `internal/agent/types.go` (+PlayMethod),
|
||||||
|
`internal/cmd/daemon.go` (branch SetFile vs HLS). WEB
|
||||||
|
`src/lib/services/agent-version-compare.ts` (gate), `src/lib/stream/play-method.ts`
|
||||||
|
(nuevo), `src/lib/stream-token.ts` (scope stream), `src/lib/db/schema.ts` +
|
||||||
|
migración (`streamingSession.play_method`), `src/app/api/internal/stream/session/route.ts`
|
||||||
|
(decisión + URLs), `src/lib/services/agent.ts` (`getPendingStreamSessions` emite
|
||||||
|
playMethod), `src/components/stream/HlsStreamPlayer.tsx` (attach nativo).
|
||||||
|
|
||||||
|
**Seguridad de version-skew (3a):**
|
||||||
|
- Web nuevo + agente viejo: gate `supportsDirectPlay` ve versión vieja → hls. ✓
|
||||||
|
- Web viejo + agente nuevo: web nunca manda `direct` → agente hls. ✓
|
||||||
|
- Campo `PlayMethod` desconocido en agente viejo = ignorado por el unmarshal. ✓
|
||||||
|
|
||||||
|
**Empezar por 3a** (valor inmediato — el caso primario de unarr es la biblioteca
|
||||||
|
local escaneada; mp4-h264-aac es común en web-dl/YIFY). 3b/3c/3d como iteraciones.
|
||||||
|
|
||||||
|
**Hecho (Fase 3a CERRADA 2026-05-31):**
|
||||||
|
- CLI (`feat/unarr-agent` c8d7c4b): `StreamSession.PlayMethod`; `OnStreamSession`
|
||||||
|
ramifica `direct` → `SetFile(NewDiskFileProvider)` + `MarkSessionReady` (sin
|
||||||
|
ffmpeg, antes del check de ffmpeg para funcionar con transcode off). `go build`
|
||||||
|
+ `vet` + tests verdes.
|
||||||
|
- WEB (`feat/unarr-brand` 636fbe59): `decidePlayMethod()` (espeja la rama
|
||||||
|
passthrough de Go, conservador) + test unitario; gate `supportsDirectPlay`
|
||||||
|
(`DIRECT_PLAY_MIN_VERSION = 0.10.0`); decisión en la ruta de sesión (solo
|
||||||
|
library item + sin downscale + `audioIndex == -1`); `buildStreamUrls` mintea
|
||||||
|
token scope `stream` (paridad Go); `streaming_session.play_method` (migración
|
||||||
|
0135) emitido al agente vía `getPendingStreamSessions`; player ramifica a
|
||||||
|
`<video src>` nativo. lint + typecheck:all + 2333 unit + build (brand unarr) OK.
|
||||||
|
- Revisión adversarial (correctness + security/parity, 2 agentes): **0 hallazgos
|
||||||
|
bloqueantes**. Token parity y version-skew (ambos sentidos) confirmados.
|
||||||
|
|
||||||
|
**Correcciones de la revisión propia (3a):** direct-play exige `audioIndex == -1`
|
||||||
|
(servir el fichero entero no respeta una pista de audio no-default elegida por el
|
||||||
|
usuario → esos casos van a HLS con `-map 0:a:N`).
|
||||||
|
|
||||||
|
**Smoke e2e (3a) — PASADO 2026-05-31** (agente dev 0.10.0 build local + item de
|
||||||
|
biblioteca mp4-h264-aac `/mnt/nas/peliculas/.../Tangled.Ever.After...mp4` + browser):
|
||||||
|
- POST `/api/internal/stream/session` → `playMethod: direct`, `streamUrls` con
|
||||||
|
`/stream?t=` (token web scope `stream`), `hlsUrls: null`. ✓
|
||||||
|
- Agente: `[stream …] direct-play: Tangled…mp4` (SetFile, sin ffmpeg). ✓
|
||||||
|
- `/stream`: HEAD 200 `video/mp4` `Content-Length 128321419`; GET Range 0-1023 →
|
||||||
|
206 + bytes mp4 reales (`ftyp isom…avc1`). **Token web verificado por Go → paridad
|
||||||
|
cross-lenguaje confirmada en vivo** (sin token → 404). ✓
|
||||||
|
- CORS desde origen browser (`localhost:3030`): ACAO correcto, preflight 204. ✓
|
||||||
|
- Browser: `<video>.currentSrc` = `/stream?t=…` (NO `/hls`), `readyState 4`,
|
||||||
|
reproduciéndose, 1920×1080 nativo, **13 reqs `/stream`, 0 `/hls`**, attach
|
||||||
|
**nativo** (`[hls] (native) loadedmetadata`, sin hls.js). Telemetría
|
||||||
|
metric/progress OK. ✓
|
||||||
|
|
||||||
|
**Bug pre-existente encontrado + arreglado durante el smoke** (web 764f5b01): el
|
||||||
|
allow-list de la marca unarr (`src/lib/branding/routes.ts`) NO incluía
|
||||||
|
`/api/internal/agent` ni `/api/internal/stream` → en unarr el agente daba 404 al
|
||||||
|
registrar y el player 404 al crear sesión. **El streaming + agente de unarr estaban
|
||||||
|
rotos de raíz.** Añadidos al allow-list (superficie del agente/media propio del
|
||||||
|
usuario, cero superficie torrent).
|
||||||
|
|
||||||
|
**Nota de release:** versión bumpeada a **0.10.0** (`version.go`, CLI 944d652) — solo
|
||||||
|
binario local para el smoke, **sin publicar nada**. `DIRECT_PLAY_MIN_VERSION = 0.10.0`
|
||||||
|
(web 52d958f0). Al publicar la release real del CLI, debe ser >= 0.10.0.
|
||||||
|
|
||||||
|
**Backlog detectado en 3a (baja prioridad):**
|
||||||
|
- `streaming_session.transport` queda `"hls"` también para sesiones direct
|
||||||
|
(el enum `TRANSPORT_VALUES` solo tiene `"hls"`); telemetría imprecisa, no bug.
|
||||||
|
Añadir `"direct"` al vocabulario cuando se toque la métrica.
|
||||||
|
- Modelo single-viewer: dos plays direct simultáneos → el último `SetFile` gana;
|
||||||
|
el tab viejo reproduciría contenido nuevo en silencio (HLS al menos 404ea).
|
||||||
|
- Direct-play no aplica `audioIndex` ni extrae subs a WebVTT (usa pistas
|
||||||
|
embebidas vía `<video>` nativo); subs bitmap no se ven. Aceptable en 3a.
|
||||||
|
- Listener `loadedmetadata {once:true}` del attach nativo no se limpia
|
||||||
|
explícitamente en cleanup (idempotente, impacto nulo).
|
||||||
|
|
||||||
|
**Fase 3c CERRADA 2026-05-31** (capability-negotiation, alcance ampliado):
|
||||||
|
- CLI (`feat/unarr-agent` 957d499): `NewRemuxSource` copia el vídeo para cualquier
|
||||||
|
codec decodificable: h264, o HEVC/AV1 si el dispositivo lo declara. HEVC se muxea
|
||||||
|
con `-tag:v hvc1` (Apple lo exige). Audio no-aac (ac3/eac3/dts) se transcodifica a
|
||||||
|
aac copiando el vídeo (`ActionRemuxAudio`) → cubre el muy común **h264+ac3 mkv**.
|
||||||
|
- WEB (`feat/unarr-brand` b0681d99): player sondea `canPlayType` (`detectDeviceCaps`)
|
||||||
|
y envía `{hevc,av1}` en el POST; `decidePlayMethod(p, caps)` device-aware:
|
||||||
|
HEVC/AV1 → `remux` solo si el dispositivo decodifica; audio no-aac ya no fuerza
|
||||||
|
`hls`. Tests caps actualizados (10).
|
||||||
|
- **Smoke e2e:** caps gate (sin caps→`hls`, con caps→`remux`); h264+ac3 remux
|
||||||
|
reproduce en Chrome (audio transcodeado, vídeo copiado); retag verificado por
|
||||||
|
ffprobe (`codec_name=hevc`, `codec_tag_string=hvc1`); **HEVC reproduce en iPhone
|
||||||
|
Safari real (Tailscale) — confirmado por el usuario.** ✓
|
||||||
|
- **Caveat:** playback HEVC en Apple no se puede smokear en este host (Chrome-Linux
|
||||||
|
no decodifica HEVC; Mac-mini Safari por SSH bloqueado por TCC: Automation +
|
||||||
|
Screen Recording necesitan click GUI). Verificado vía iPhone del usuario.
|
||||||
|
|
||||||
|
**Diagnóstico time-to-first-frame (2026-05-31)** (instrumentación en 957d499:
|
||||||
|
timers `probe`/`spawn`, `first fMP4 bytes after`, `serveGrowing blocked`):
|
||||||
|
- Agente NO es el cuello: probe 16–98ms, spawn 1–194ms, primer byte fMP4 ~201ms,
|
||||||
|
**0 bloqueos** en `serveGrowing` (LAN ni remoto). Remux `-c copy` completo de un
|
||||||
|
fichero de ~780MB en ~16s (limitado por lectura NAS).
|
||||||
|
- `moov` al frente (empty_moov OK) → el player no busca metadata al final.
|
||||||
|
- Cliente (Chrome/LAN): POST→primer request ~480ms (sobre todo carga de página).
|
||||||
|
- **1ª reproducción lenta = warm-up de red (Tailscale); 2ª/3ª rápidas** (confirmado
|
||||||
|
por el usuario). No es un problema de código.
|
||||||
|
- Player YA da feedback (fases `loading-meta`/`probing-transport`/`playing` +
|
||||||
|
overlay "Preparando…" + spinner de buffering + mensaje stuck >10s). El "sin
|
||||||
|
feedback" del test fue por usar URL cruda (sin UI), no el flujo real.
|
||||||
|
- **Conclusión:** sin optimización de código necesaria. Arranque garantizado-instante
|
||||||
|
= **hueco #4 (pre-transcode)**: dejar el remux/encode hecho antes del play.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Hueco #4 — Pre-transcode (transcode-on-download)
|
||||||
|
**Estado:** 🔵 DISEÑADO (2026-05-31), pendiente de implementar.
|
||||||
|
|
||||||
|
**Qué es:** al completar una descarga (o import a biblioteca), procesar en
|
||||||
|
background para que la reproducción sea **instantánea** sin transcode en vivo.
|
||||||
|
Es una optimización: si no terminó cuando el usuario da play → fallback al
|
||||||
|
transcode en vivo (HLS actual). **Nunca bloquea.**
|
||||||
|
|
||||||
|
**Sinergia con lo existente (clave — gran parte de la infra ya está):**
|
||||||
|
- `hls_cache.go`: un encode HLS completo se cachea y el cache-HIT lo sirve
|
||||||
|
instantáneo (cero ffmpeg). Pre-transcode = poblar esa cache antes del play.
|
||||||
|
- `stream-prewarm.ts` + `createPrewarmSession`: ya lanza un encode HLS de la
|
||||||
|
siguiente ep en background. Pre-transcode = generalizar prewarm a "cualquier
|
||||||
|
download, configurable", + producir también el artefacto direct-play (3a).
|
||||||
|
- Por tanto el trabajo NUEVO es: (1) disparador on-download-complete, (2)
|
||||||
|
superficie de config en web, (3) gobernanza de recursos + cola, (4) decisión
|
||||||
|
"qué producir" (remux mp4 para 3a vs HLS cache vs nada si ya es native).
|
||||||
|
|
||||||
|
**Opciones a exponer en la web (set propuesto):**
|
||||||
|
|
||||||
|
1. **Activación + disparador**
|
||||||
|
- Toggle global on/off (default OFF — CPU/disco intensivo).
|
||||||
|
- Disparador: al completar descarga / al escanear-importar / manual
|
||||||
|
("optimizar ahora" por item) / programado (ventana horaria).
|
||||||
|
- Default recomendado: on-download-complete, pero solo en ventana idle + sin
|
||||||
|
stream en vivo activo.
|
||||||
|
|
||||||
|
2. **Qué producir (target) — modo Auto recomendado (por probe):**
|
||||||
|
- ya browser-native (mp4 h264/aac 8-bit SDR) → **nada** (3a lo sirve crudo).
|
||||||
|
- solo contenedor incompatible (mkv h264/aac) → **remux** a mp4 (barato, sin
|
||||||
|
re-encode; habilita 3a direct-play). *(necesita 3b para el manifiesto.)*
|
||||||
|
- codec incompatible (HEVC/AV1/10-bit/HDR) → **transcode** a H.264 (caro).
|
||||||
|
- Modos: solo-remux / remux+transcode / forzar H.264 universal.
|
||||||
|
- Formato salida: mp4 direct-play (seek nativo) vs HLS cache (multi-network)
|
||||||
|
vs ambos. Recomendado: mp4 si compatible, HLS si requiere transcode.
|
||||||
|
|
||||||
|
3. **Calidad**
|
||||||
|
- Mantener original (passthrough cuando se pueda) / cap 1080p / ladder ABR
|
||||||
|
(480/720/1080/original — encaja con 3d).
|
||||||
|
- "Solo transcodear si ayuda" (no tocar lo ya compatible).
|
||||||
|
|
||||||
|
4. **Selección / alcance**
|
||||||
|
- Todo / solo biblioteca (pelis+series) / solo lo problemático (p.ej. solo
|
||||||
|
4K HEVC, dejar h264).
|
||||||
|
- Solo watchlist / recién añadido / todo. Reglas por carpeta de biblioteca.
|
||||||
|
|
||||||
|
5. **Gobernanza de recursos (lo más importante — es pesado):**
|
||||||
|
- Concurrencia (N transcodes paralelos, default 1).
|
||||||
|
- HW accel si disponible (nvenc/qsv/vaapi); cap de threads CPU.
|
||||||
|
- Ventana horaria (solo idle, p.ej. 02:00–08:00).
|
||||||
|
- **Pausar cuando hay stream en vivo** (no pelear por CPU con la reproducción).
|
||||||
|
- Prioridad de cola (watchlist primero / más pequeño primero / más nuevo).
|
||||||
|
- (Laptops) solo con AC / no en batería.
|
||||||
|
|
||||||
|
6. **Disco / retención (liga con el hueco medio de espacio en disco):**
|
||||||
|
- Dónde guardar (cache dir) + tamaño máx + evicción LRU (ya parcial en cache).
|
||||||
|
- Mantener SIEMPRE el original; el transcode es artefacto adicional.
|
||||||
|
- TTL: borrar pre-transcode no visto en N días; pin a visto/favorito.
|
||||||
|
- Re-transcodear al cambiar la config de calidad (invalidación).
|
||||||
|
|
||||||
|
7. **UX / estado**
|
||||||
|
- Cola + progreso por item en la web ("Optimizando para reproducción
|
||||||
|
instantánea…"). Badge en library card: "listo para play instantáneo" vs
|
||||||
|
"se transcodificará al reproducir". Notificación al terminar (opcional).
|
||||||
|
|
||||||
|
8. **Fallback / límites**
|
||||||
|
- Si no terminó a tiempo → transcode en vivo (HLS). Nunca bloquea el play.
|
||||||
|
- Solo ficheros locales en disco (no debrid/torrent sin bajar).
|
||||||
|
|
||||||
|
**MVP recomendado (fase 4a):** toggle on/off + disparador on-download-complete +
|
||||||
|
modo Auto (remux-si-compatible / transcode-si-no) + concurrencia 1 +
|
||||||
|
pausar-si-stream-activo + reusar `hls_cache` + badge "listo". El resto (ladder
|
||||||
|
ABR, ventanas horarias, reglas por carpeta, TTL avanzado, formato mp4 vs HLS
|
||||||
|
configurable) en fases 4b/4c.
|
||||||
|
|
||||||
|
**Dependencias:** el camino mp4/remux depende del hueco #3 (3a ya hecho; 3b para
|
||||||
|
el remux-a-mp4 con manifiesto correcto). El camino HLS-cache es implementable ya
|
||||||
|
(reusa cache + prewarm). La gobernanza (pausar-si-stream) necesita señal de
|
||||||
|
"stream activo" en el daemon (la hay: `streamSrv.HasFile()` + registro HLS).
|
||||||
15
Makefile
15
Makefile
|
|
@ -1,4 +1,4 @@
|
||||||
.PHONY: all build test lint coverage clean fmt vet check install-hooks changelog release release-patch release-minor release-major release-dry
|
.PHONY: all build test lint coverage clean fmt vet check install-hooks changelog release release-patch release-minor release-major release-dry ship ship-dry ship-push
|
||||||
|
|
||||||
BINARY = unarr
|
BINARY = unarr
|
||||||
SENTRY_DSN ?=
|
SENTRY_DSN ?=
|
||||||
|
|
@ -71,6 +71,19 @@ release-dry:
|
||||||
@test -n "$(V)" || { echo "Usage: make release-dry V=patch|minor|major|0.5.0"; exit 1; }
|
@test -n "$(V)" || { echo "Usage: make release-dry V=patch|minor|major|0.5.0"; exit 1; }
|
||||||
@./scripts/release.sh --dry-run $(V)
|
@./scripts/release.sh --dry-run $(V)
|
||||||
|
|
||||||
|
## Ship a release end-to-end (goreleaser + Hetzner + Docker Hub). Standalone backup for GH Actions.
|
||||||
|
## Reads version from internal/cmd/version.go unless V= is provided.
|
||||||
|
ship:
|
||||||
|
@./scripts/ship.sh $(V)
|
||||||
|
|
||||||
|
## Ship + git push tag to GH afterwards
|
||||||
|
ship-push:
|
||||||
|
@./scripts/ship.sh --push $(V)
|
||||||
|
|
||||||
|
## Preview ship steps without executing
|
||||||
|
ship-dry:
|
||||||
|
@./scripts/ship.sh --dry-run $(V)
|
||||||
|
|
||||||
## Remove generated files
|
## Remove generated files
|
||||||
clean:
|
clean:
|
||||||
rm -f $(BINARY) coverage.out coverage.html
|
rm -f $(BINARY) coverage.out coverage.html
|
||||||
|
|
|
||||||
149
README.md
149
README.md
|
|
@ -11,9 +11,9 @@
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[](go.mod)
|
[](go.mod)
|
||||||
|
|
||||||
Powerful terminal tool for torrent search and management. **Free and open source.**
|
The single-binary terminal client for torrent, debrid, and usenet downloads. **Free and open source.**
|
||||||
|
|
||||||
Search 30+ torrent sources, inspect torrent quality, discover popular content, find streaming providers, and manage your media collection — all from your terminal.
|
Built-in torrent engine, debrid (Real-Debrid / AllDebrid), and NZB support. Stream to mpv/vlc, transcode on the fly with hardware acceleration, and manage your library — one binary or a headless daemon with WireGuard split-tunnel and Cloudflare Funnel remote access.
|
||||||
|
|
||||||
<!-- GIF demo placeholder -->
|
<!-- GIF demo placeholder -->
|
||||||
<!--  -->
|
<!--  -->
|
||||||
|
|
@ -343,6 +343,58 @@ unarr self-update --force # reinstall even if up to date
|
||||||
|
|
||||||
`unarr doctor` checks: config file, API key, server connectivity (with latency), agent registration, download directory, disk space, and version.
|
`unarr doctor` checks: config file, API key, server connectivity (with latency), agent registration, download directory, disk space, and version.
|
||||||
|
|
||||||
|
### Updating unarr
|
||||||
|
|
||||||
|
unarr supports three update paths. Pick whichever fits your workflow.
|
||||||
|
|
||||||
|
**1. Manual self-update (always available).**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
unarr self-update # interactive update to latest
|
||||||
|
unarr self-update --force # reinstall same version
|
||||||
|
unarr self-update --allow-unsigned # accept releases without checksum signature
|
||||||
|
```
|
||||||
|
|
||||||
|
The CLI downloads the new release archive over HTTPS (from
|
||||||
|
`torrentclaw.com/releases/download/v<ver>/`), verifies SHA-256, swaps the
|
||||||
|
binary in place (`.backup` kept next to it), and restarts the systemd
|
||||||
|
user unit if the daemon is running.
|
||||||
|
|
||||||
|
**2. Auto-apply on server signal (default, since 0.9.6).**
|
||||||
|
|
||||||
|
When you press **"Force update now"** on the web (Settings → Agent → Force
|
||||||
|
update), the server sets a flag your daemon polls every sync (~3 s). On
|
||||||
|
the next sync the daemon downloads the new binary, replaces itself, and
|
||||||
|
exits — `systemd Restart=always` respawns on the new version. No SSH, no
|
||||||
|
terminal access required. Works headless on NAS / Docker.
|
||||||
|
|
||||||
|
The button shows an amber warning if your agent is below 0.9.6 (older
|
||||||
|
daemons see the signal but only log "run unarr update" — the operator
|
||||||
|
must run the command manually that one time).
|
||||||
|
|
||||||
|
**Opt out of auto-apply.** Some users prefer reviewing CHANGELOG before
|
||||||
|
applying. Disable in `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[daemon]
|
||||||
|
auto_upgrade = false
|
||||||
|
```
|
||||||
|
|
||||||
|
With `auto_upgrade = false`, pressing the web button still flags your
|
||||||
|
agent (so the daemon logs the new version on next sync), but the daemon
|
||||||
|
will not download / replace anything — you run `unarr self-update` when
|
||||||
|
you're ready.
|
||||||
|
|
||||||
|
**3. Docker auto-restart with a new tag.**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker pull torrentclaw/unarr:latest
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Tags published: `latest`, `0.9`, `0.9.7`, ... — pin to a minor (`0.9`)
|
||||||
|
for opt-in patch updates without surprises.
|
||||||
|
|
||||||
## Clean
|
## Clean
|
||||||
|
|
||||||
Remove temporary files, logs, resume data, and other artifacts generated by unarr. Shows what will be removed and asks for confirmation before deleting.
|
Remove temporary files, logs, resume data, and other artifacts generated by unarr. Shows what will be removed and asks for confirmation before deleting.
|
||||||
|
|
@ -424,6 +476,7 @@ tv_shows_dir = "~/Media/TV Shows"
|
||||||
[daemon]
|
[daemon]
|
||||||
poll_interval = "30s"
|
poll_interval = "30s"
|
||||||
heartbeat_interval = "30s"
|
heartbeat_interval = "30s"
|
||||||
|
auto_upgrade = true # apply server-flagged upgrades in-place (since 0.9.6)
|
||||||
|
|
||||||
[notifications]
|
[notifications]
|
||||||
enabled = true
|
enabled = true
|
||||||
|
|
@ -466,6 +519,40 @@ If `transcode.enabled = true` but `ffmpeg` / `ffprobe` aren't on PATH, the
|
||||||
daemon logs a warning at startup and HLS sessions are rejected at runtime
|
daemon logs a warning at startup and HLS sessions are rejected at runtime
|
||||||
with a clear error — install ffmpeg or set `enabled = false`.
|
with a clear error — install ffmpeg or set `enabled = false`.
|
||||||
|
|
||||||
|
#### `[downloads.hls_cache]` — persistent HLS segment cache
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[downloads.hls_cache]
|
||||||
|
enabled = true # on by default
|
||||||
|
size_gb = 5 # disk budget; LRU eviction once exceeded
|
||||||
|
dir = "" # custom path; empty = ~/.cache/unarr/hls-cache
|
||||||
|
```
|
||||||
|
|
||||||
|
| Key | Type | Default | Notes |
|
||||||
|
|-----|------|---------|-------|
|
||||||
|
| `enabled` | bool | `true` | Persists finished HLS encodes per `(source, quality, audio_index)`. A second play of the same file at the same quality reuses the segments — no ffmpeg, near-zero CPU, instant playback. Set to `false` to delete segments on session close (original behavior). |
|
||||||
|
| `size_gb` | int | `5` | Cache budget in gigabytes. When exceeded the LRU sweeper evicts the least-recently-used cached encodes hourly. Minimum 1 GB (smaller values are clamped up). |
|
||||||
|
| `dir` | string | `""` | Custom storage path. Empty defaults to `~/.cache/unarr/hls-cache` (Linux/macOS) or the user cache dir (Windows). |
|
||||||
|
|
||||||
|
**What it does.** First play encodes normally (ffmpeg writes segments).
|
||||||
|
On session close, if every segment is on disk and ffmpeg exited cleanly,
|
||||||
|
the directory is sealed with a `.complete` marker and kept. Next time the
|
||||||
|
same source + quality combo is requested, the daemon serves segments
|
||||||
|
straight from disk — no transcode, no warm-up, no CPU cost.
|
||||||
|
|
||||||
|
**Why per (source, quality, audio).** Renaming the file or switching
|
||||||
|
quality invalidates the entry: the segments are tied to the exact source
|
||||||
|
bytes and the exact ffmpeg parameters. Re-encoding generates a new key.
|
||||||
|
|
||||||
|
**Eviction.** A background goroutine wakes every hour. If total cache size
|
||||||
|
exceeds `size_gb`, it deletes the oldest entries (by mtime) until under
|
||||||
|
budget. Active sessions are pinned — they never get evicted mid-play.
|
||||||
|
|
||||||
|
**Disable.** Either edit the TOML to set `enabled = false`, or remove the
|
||||||
|
cache directory manually (it'll be recreated as needed). Disabling does
|
||||||
|
not delete existing cached segments — drop `dir` (or `~/.cache/unarr/hls-cache`)
|
||||||
|
to reclaim the space.
|
||||||
|
|
||||||
#### `[downloads.vpn]`
|
#### `[downloads.vpn]`
|
||||||
|
|
||||||
| Key | Type | Default | Notes |
|
| Key | Type | Default | Notes |
|
||||||
|
|
@ -476,6 +563,64 @@ with a clear error — install ffmpeg or set `enabled = false`.
|
||||||
See the [VPN](#vpn) section above for how it works (split-tunnel, no root) and
|
See the [VPN](#vpn) section above for how it works (split-tunnel, no root) and
|
||||||
how to protect your other devices.
|
how to protect your other devices.
|
||||||
|
|
||||||
|
#### `[downloads.funnel]` — public HTTPS hostname for the daemon (CloudFlare Quick Tunnel)
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[downloads.funnel]
|
||||||
|
enabled = false # off by default
|
||||||
|
```
|
||||||
|
|
||||||
|
| Key | Type | Default | Notes |
|
||||||
|
|-----|------|---------|-------|
|
||||||
|
| `enabled` | bool | `false` | Spawns `cloudflared tunnel --url http://localhost:<stream_port>` as a child process at daemon startup. Toggle with `unarr funnel on` / `off`. Requires `cloudflared` on PATH. |
|
||||||
|
|
||||||
|
**What it does.** Without a tunnel, the daemon is reachable on `localhost`,
|
||||||
|
your LAN, and (if installed) Tailscale. That covers the same-machine and
|
||||||
|
Tailscale-connected cases, but the **browser-based player on torrentclaw.com
|
||||||
|
fails on any other network** because HTTPS pages can't fetch HTTP resources
|
||||||
|
("mixed content"). Enabling the funnel gives the daemon a public
|
||||||
|
`https://<random>.trycloudflare.com` hostname so the web player picks it up
|
||||||
|
and playback works from anywhere — phone on cellular, friend's laptop on a
|
||||||
|
foreign Wi-Fi, anywhere. The Stremio addon already works cross-network
|
||||||
|
(native mpv/VLC players ignore CORS), so this is strictly a web-player fix.
|
||||||
|
|
||||||
|
**Privacy posture.** Bytes pass through CloudFlare's edge — TorrentClaw never
|
||||||
|
relays content (we don't see your traffic), CloudFlare does. Quick Tunnels
|
||||||
|
are **anonymous** (no CF account required); the registration is unauthenticated
|
||||||
|
and the hostname is a random label, but CF logs request metadata like any CDN
|
||||||
|
would. If you want zero third-party byte access, use Tailscale instead.
|
||||||
|
|
||||||
|
**Limitations (free Quick Tunnels).**
|
||||||
|
| Aspect | Limit |
|
||||||
|
|--------|-------|
|
||||||
|
| Session lifetime | ~6 hours, then the hostname rotates. cloudflared re-registers automatically; the web picks up the new URL on the next sync. In-flight HLS sessions break across the rotation (browser retries). |
|
||||||
|
| Bandwidth | No documented hard cap, but CF reserves the right to throttle. 1080p HLS (~6 Mbps) is fine; 4K HEVC at 25 Mbps may hit throttling. |
|
||||||
|
| Latency | +20–80 ms vs direct LAN/Tailscale (extra hop browser → CF edge → tunnel). HLS player buffer absorbs it. |
|
||||||
|
| Concurrency | One tunnel serves N viewers. CF rate-limits ~200 req/s, plenty for HLS segments. |
|
||||||
|
| TOS | CloudFlare flags Quick Tunnels as "not for production traffic". They can decommission an abusive tunnel without notice. |
|
||||||
|
|
||||||
|
For heavy / high-throughput / persistent-URL use cases, switch to a CloudFlare
|
||||||
|
Named Tunnel (free, needs a CF account) or run your own reverse proxy — both
|
||||||
|
out of scope for the bundled command.
|
||||||
|
|
||||||
|
**Disable.** `unarr funnel off` flips `enabled` to `false` in the TOML and
|
||||||
|
prompts you to restart the daemon. You can also edit `config.toml` directly:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[downloads.funnel]
|
||||||
|
enabled = false
|
||||||
|
```
|
||||||
|
|
||||||
|
**Install cloudflared.**
|
||||||
|
- Linux: `apt install cloudflared` (after adding CF's apt repo) — see
|
||||||
|
<https://pkg.cloudflare.com>. Or pull the static binary from
|
||||||
|
<https://github.com/cloudflare/cloudflared/releases>.
|
||||||
|
- macOS: `brew install cloudflared`.
|
||||||
|
- Windows: `winget install --id Cloudflare.cloudflared`.
|
||||||
|
|
||||||
|
If `cloudflared` is not on PATH the daemon logs a warning at startup and
|
||||||
|
falls back to LAN/Tailscale-only reachability.
|
||||||
|
|
||||||
### Environment variables
|
### Environment variables
|
||||||
|
|
||||||
Environment variables override config file values:
|
Environment variables override config file values:
|
||||||
|
|
|
||||||
|
|
@ -1,48 +1,77 @@
|
||||||
|
# unarr — TorrentClaw agent
|
||||||
|
#
|
||||||
|
# Quick start:
|
||||||
|
# 1. Copy this file to any directory.
|
||||||
|
# 2. Set UNARR_API_KEY to your key (Settings → API Keys on torrentclaw.com).
|
||||||
|
# 3. Set DOWNLOAD_DIR to your media folder (absolute path).
|
||||||
|
# 4. Run: docker compose up -d
|
||||||
|
#
|
||||||
|
# Get your API key: https://torrentclaw.com/settings/api-keys
|
||||||
|
# Full docs: https://torrentclaw.com/unarr
|
||||||
|
|
||||||
services:
|
services:
|
||||||
unarr:
|
unarr:
|
||||||
build:
|
|
||||||
context: ..
|
|
||||||
dockerfile: unarr/Dockerfile
|
|
||||||
image: torrentclaw/unarr:latest
|
image: torrentclaw/unarr:latest
|
||||||
|
pull_policy: always # always pull on `up` so you stay on the latest release
|
||||||
container_name: unarr
|
container_name: unarr
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
user: "1000:1000"
|
|
||||||
|
|
||||||
# Read-only root filesystem — only volumes are writable
|
# host network is required for:
|
||||||
read_only: true
|
# - streaming to reach your TV / mobile / other LAN devices (port 11818)
|
||||||
tmpfs:
|
# - HLS transcode server (port 11819)
|
||||||
- /tmp:size=64m,mode=1777
|
# - Tailscale connectivity (if you use it)
|
||||||
|
# On macOS / Windows Docker Desktop, replace with `ports` mapping (see below).
|
||||||
volumes:
|
|
||||||
# Config: your config.toml lives here
|
|
||||||
- ./config:/config
|
|
||||||
# Downloads: finished media goes here
|
|
||||||
- ~/Media:/downloads
|
|
||||||
# Data: torrent metadata, piece DB, cache
|
|
||||||
- unarr-data:/data
|
|
||||||
|
|
||||||
environment:
|
|
||||||
- TZ=${TZ:-UTC}
|
|
||||||
# Optional overrides (uncomment to use):
|
|
||||||
# - UNARR_API_KEY=tc_your_key_here
|
|
||||||
# - UNARR_API_URL=https://torrentclaw.com
|
|
||||||
|
|
||||||
# Resource limits — adjust to your needs
|
|
||||||
deploy:
|
|
||||||
resources:
|
|
||||||
limits:
|
|
||||||
memory: 512M
|
|
||||||
cpus: "2.0"
|
|
||||||
|
|
||||||
# Torrent P2P needs host network or explicit port range
|
|
||||||
# Option A: host network (simplest, full P2P performance)
|
|
||||||
network_mode: host
|
network_mode: host
|
||||||
|
|
||||||
# Option B: bridge network with port mapping (more isolated)
|
environment:
|
||||||
# Uncomment below and comment out network_mode above:
|
# --- Required ---
|
||||||
|
- UNARR_API_KEY=${UNARR_API_KEY:?Set UNARR_API_KEY in .env or export it}
|
||||||
|
|
||||||
|
# --- Optional ---
|
||||||
|
# Server URL — change only if you run a self-hosted TorrentClaw instance
|
||||||
|
- UNARR_API_URL=${UNARR_API_URL:-https://torrentclaw.com}
|
||||||
|
- TZ=${TZ:-UTC}
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
# Config: config.toml is auto-created here on first run.
|
||||||
|
# After first start, edit this file to set organize paths, quality, etc.
|
||||||
|
- ${CONFIG_DIR:-./config}:/config
|
||||||
|
|
||||||
|
# Downloads: where finished media is saved.
|
||||||
|
# Set DOWNLOAD_DIR in .env or export it before running.
|
||||||
|
- ${DOWNLOAD_DIR:?Set DOWNLOAD_DIR to your media folder}:/downloads
|
||||||
|
|
||||||
|
# Data: piece-completion DB, HLS cache, DHT nodes.
|
||||||
|
# Named volume keeps this off your media drive (avoids NFS locking issues).
|
||||||
|
- unarr-data:/data
|
||||||
|
|
||||||
|
# --- NVIDIA GPU: hardware transcode (nvenc) ---
|
||||||
|
# Uncomment on a host with an NVIDIA GPU + nvidia-container-toolkit. The
|
||||||
|
# image already bundles an nvenc-enabled ffmpeg and sets
|
||||||
|
# NVIDIA_DRIVER_CAPABILITIES=video,compute,utility, so this device
|
||||||
|
# reservation is the only thing needed to enable HW transcode. Without a GPU
|
||||||
|
# the same image falls back to software (libx264) automatically — leave it
|
||||||
|
# commented. (docker run equivalent: add --gpus all)
|
||||||
|
# deploy:
|
||||||
|
# resources:
|
||||||
|
# reservations:
|
||||||
|
# devices:
|
||||||
|
# - driver: nvidia
|
||||||
|
# count: all
|
||||||
|
# capabilities: [gpu]
|
||||||
|
# # Optional: cap CPU/RAM for transcoding on shared hosts
|
||||||
|
# limits:
|
||||||
|
# memory: 2G
|
||||||
|
# cpus: "4.0"
|
||||||
|
|
||||||
|
# --- macOS / Windows alternative (replace network_mode: host above) ---
|
||||||
|
# network_mode: bridge
|
||||||
# ports:
|
# ports:
|
||||||
# - "6881-6889:6881-6889/tcp"
|
# - "11818:11818" # direct stream (VLC, download)
|
||||||
# - "6881-6889:6881-6889/udp"
|
# - "11819:11819" # HLS transcode (web player)
|
||||||
|
# - "42069:42069" # BitTorrent incoming peers
|
||||||
|
# Note: streaming will only reach devices on the same machine.
|
||||||
|
# For LAN / Tailscale playback use a Linux host with network_mode: host.
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
unarr-data:
|
unarr-data:
|
||||||
|
|
|
||||||
105
internal/agent/active_tasks.go
Normal file
105
internal/agent/active_tasks.go
Normal file
|
|
@ -0,0 +1,105 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// activeTasksFilePathFn is overridable for testing.
|
||||||
|
var activeTasksFilePathFn = func() string {
|
||||||
|
return filepath.Join(config.DataDir(), "active-tasks.json")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ActiveTaskStore persists the dispatch payloads (agent.Task) of in-flight
|
||||||
|
// DOWNLOAD tasks so the daemon can re-submit them after a restart and have the
|
||||||
|
// downloaders resume the partial data — torrent via the persisted
|
||||||
|
// piece-completion DB, debrid via HTTP Range, usenet via its segment tracker.
|
||||||
|
//
|
||||||
|
// Distinct from LocalState (tasks.json), which holds transient status/progress
|
||||||
|
// for syncing to the web; this holds the re-dispatch payload needed to restart
|
||||||
|
// the work. An entry is added when a download starts and removed when it
|
||||||
|
// reaches a genuine terminal state (completed / failed / cancelled) — but NOT
|
||||||
|
// when the daemon is shutting down, so an interrupted download survives the
|
||||||
|
// restart and resumes.
|
||||||
|
type ActiveTaskStore struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
tasks map[string]Task
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewActiveTaskStore creates an empty store. Call Load() to hydrate it from disk.
|
||||||
|
func NewActiveTaskStore() *ActiveTaskStore {
|
||||||
|
return &ActiveTaskStore{tasks: make(map[string]Task)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add records (or replaces) a task and persists the set.
|
||||||
|
func (s *ActiveTaskStore) Add(t Task) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
s.tasks[t.ID] = t
|
||||||
|
s.flushLocked()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove drops a task and persists the set. No-op if absent.
|
||||||
|
func (s *ActiveTaskStore) Remove(taskID string) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
if _, ok := s.tasks[taskID]; !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
delete(s.tasks, taskID)
|
||||||
|
s.flushLocked()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load reads the persisted tasks from disk into the store and returns them.
|
||||||
|
// Returns nil on a missing or unreadable file (a fresh daemon has nothing to
|
||||||
|
// resume). Safe to call once at startup before any Add/Remove.
|
||||||
|
func (s *ActiveTaskStore) Load() []Task {
|
||||||
|
data, err := os.ReadFile(activeTasksFilePathFn())
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var tasks []Task
|
||||||
|
if json.Unmarshal(data, &tasks) != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
s.tasks = make(map[string]Task, len(tasks))
|
||||||
|
for _, t := range tasks {
|
||||||
|
if t.ID != "" {
|
||||||
|
s.tasks[t.ID] = t
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out := make([]Task, 0, len(s.tasks))
|
||||||
|
for _, t := range s.tasks {
|
||||||
|
out = append(out, t)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// flushLocked atomically writes the current set to disk. Caller holds s.mu.
|
||||||
|
// Best-effort: a write failure is non-fatal (the in-memory set stays correct;
|
||||||
|
// at worst a crash before the next flush loses one resume entry).
|
||||||
|
func (s *ActiveTaskStore) flushLocked() {
|
||||||
|
tasks := make([]Task, 0, len(s.tasks))
|
||||||
|
for _, t := range s.tasks {
|
||||||
|
tasks = append(tasks, t)
|
||||||
|
}
|
||||||
|
data, err := json.MarshalIndent(tasks, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
path := activeTasksFilePathFn()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
tmp := path + ".tmp"
|
||||||
|
if err := os.WriteFile(tmp, data, 0o644); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, path)
|
||||||
|
}
|
||||||
75
internal/agent/active_tasks_test.go
Normal file
75
internal/agent/active_tasks_test.go
Normal file
|
|
@ -0,0 +1,75 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// withTempStorePath points the store file at a temp location for the duration
|
||||||
|
// of a test and restores the original afterward.
|
||||||
|
func withTempStorePath(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
orig := activeTasksFilePathFn
|
||||||
|
path := filepath.Join(t.TempDir(), "active-tasks.json")
|
||||||
|
activeTasksFilePathFn = func() string { return path }
|
||||||
|
t.Cleanup(func() { activeTasksFilePathFn = orig })
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestActiveTaskStore_AddLoadRoundTrip(t *testing.T) {
|
||||||
|
withTempStorePath(t)
|
||||||
|
|
||||||
|
s := NewActiveTaskStore()
|
||||||
|
s.Add(Task{ID: "a", InfoHash: "hashA", Title: "Movie A", Mode: "download"})
|
||||||
|
s.Add(Task{ID: "b", NzbID: "nzbB", Title: "Show B"})
|
||||||
|
|
||||||
|
// A fresh store hydrated from disk must see both.
|
||||||
|
loaded := NewActiveTaskStore().Load()
|
||||||
|
if len(loaded) != 2 {
|
||||||
|
t.Fatalf("Load returned %d tasks, want 2", len(loaded))
|
||||||
|
}
|
||||||
|
byID := map[string]Task{}
|
||||||
|
for _, tk := range loaded {
|
||||||
|
byID[tk.ID] = tk
|
||||||
|
}
|
||||||
|
if byID["a"].InfoHash != "hashA" || byID["a"].Title != "Movie A" {
|
||||||
|
t.Errorf("task a not round-tripped: %+v", byID["a"])
|
||||||
|
}
|
||||||
|
if byID["b"].NzbID != "nzbB" {
|
||||||
|
t.Errorf("task b not round-tripped: %+v", byID["b"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestActiveTaskStore_Remove(t *testing.T) {
|
||||||
|
withTempStorePath(t)
|
||||||
|
|
||||||
|
s := NewActiveTaskStore()
|
||||||
|
s.Add(Task{ID: "a", Title: "A"})
|
||||||
|
s.Add(Task{ID: "b", Title: "B"})
|
||||||
|
s.Remove("a")
|
||||||
|
s.Remove("missing") // no-op
|
||||||
|
|
||||||
|
loaded := NewActiveTaskStore().Load()
|
||||||
|
if len(loaded) != 1 || loaded[0].ID != "b" {
|
||||||
|
t.Fatalf("after Remove(a), Load = %+v, want only b", loaded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestActiveTaskStore_Overwrite(t *testing.T) {
|
||||||
|
withTempStorePath(t)
|
||||||
|
|
||||||
|
s := NewActiveTaskStore()
|
||||||
|
s.Add(Task{ID: "a", Title: "old"})
|
||||||
|
s.Add(Task{ID: "a", Title: "new"}) // same id replaces
|
||||||
|
|
||||||
|
loaded := NewActiveTaskStore().Load()
|
||||||
|
if len(loaded) != 1 || loaded[0].Title != "new" {
|
||||||
|
t.Fatalf("overwrite failed: %+v", loaded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestActiveTaskStore_LoadMissingFile(t *testing.T) {
|
||||||
|
withTempStorePath(t) // temp dir, no file written yet
|
||||||
|
if got := NewActiveTaskStore().Load(); got != nil {
|
||||||
|
t.Errorf("Load on missing file = %+v, want nil", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -91,6 +91,66 @@ func (c *Client) Deregister(ctx context.Context, agentID string) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ReportUpgradeResult tells the server the outcome of a previously requested
|
||||||
|
// upgrade so the server can clear `upgrade_requested`. Without this call the
|
||||||
|
// flag stays sticky and the daemon would re-trigger applyAutoUpgrade on every
|
||||||
|
// sync after upgrade — even for "already on target version" no-ops.
|
||||||
|
func (c *Client) ReportUpgradeResult(ctx context.Context, agentID string, success bool, version, errMsg string) error {
|
||||||
|
req := struct {
|
||||||
|
AgentID string `json:"agentId"`
|
||||||
|
Success bool `json:"success"`
|
||||||
|
Version string `json:"version,omitempty"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}{AgentID: agentID, Success: success, Version: version, Error: errMsg}
|
||||||
|
var resp StatusResponse
|
||||||
|
if err := c.doPost(ctx, "/api/internal/agent/upgrade-result", req, &resp); err != nil {
|
||||||
|
return fmt.Errorf("report upgrade result: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkSessionReady signals the server that the first HLS segment + init.mp4
|
||||||
|
// landed on disk for the given session. The web side flips
|
||||||
|
// streaming_session.ready_at = NOW(), which its SSE endpoint emits to
|
||||||
|
// subscribed players so the "Preparando…" UI ends without polling HEAD
|
||||||
|
// on /hls/<id>/master.m3u8.
|
||||||
|
//
|
||||||
|
// Best-effort: the server is the source of truth for session state and
|
||||||
|
// will reach the same conclusion via HEAD probes anyway if this call
|
||||||
|
// fails. We log the error in the caller but don't retry — by the time
|
||||||
|
// a retry would land the user is likely already playing.
|
||||||
|
func (c *Client) MarkSessionReady(ctx context.Context, sessionID string) error {
|
||||||
|
req := struct {
|
||||||
|
SessionID string `json:"sessionId"`
|
||||||
|
}{SessionID: sessionID}
|
||||||
|
var resp StatusResponse
|
||||||
|
if err := c.doPost(ctx, "/api/internal/agent/session-ready", req, &resp); err != nil {
|
||||||
|
return fmt.Errorf("mark session ready: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefreshStreamURL re-resolves a fresh debrid direct URL for a live streaming
|
||||||
|
// session (hueco #2 / 2c). Called by the daemon when a debrid source expires
|
||||||
|
// mid-stream (the link is time-limited; the content is still cached). Returns
|
||||||
|
// the new URL on success; an error (incl. 409/410) means refresh isn't
|
||||||
|
// possible and the caller should stop trying.
|
||||||
|
func (c *Client) RefreshStreamURL(ctx context.Context, sessionID string) (string, error) {
|
||||||
|
req := struct {
|
||||||
|
SessionID string `json:"sessionId"`
|
||||||
|
}{SessionID: sessionID}
|
||||||
|
var resp struct {
|
||||||
|
DirectURL string `json:"directUrl"`
|
||||||
|
}
|
||||||
|
if err := c.doPost(ctx, "/api/internal/agent/stream-url", req, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("refresh stream url: %w", err)
|
||||||
|
}
|
||||||
|
if resp.DirectURL == "" {
|
||||||
|
return "", fmt.Errorf("refresh stream url: empty url in response")
|
||||||
|
}
|
||||||
|
return resp.DirectURL, nil
|
||||||
|
}
|
||||||
|
|
||||||
// ReportStatus reports download progress. Returns server-side flags the CLI must act on.
|
// ReportStatus reports download progress. Returns server-side flags the CLI must act on.
|
||||||
func (c *Client) ReportStatus(ctx context.Context, update StatusUpdate) (*StatusResponse, error) {
|
func (c *Client) ReportStatus(ctx context.Context, update StatusUpdate) (*StatusResponse, error) {
|
||||||
var resp StatusResponse
|
var resp StatusResponse
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,8 @@ import (
|
||||||
"strings"
|
"strings"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/upgrade"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DaemonConfig holds daemon runtime settings.
|
// DaemonConfig holds daemon runtime settings.
|
||||||
|
|
@ -20,12 +22,23 @@ type DaemonConfig struct {
|
||||||
Version string
|
Version string
|
||||||
DownloadDir string
|
DownloadDir string
|
||||||
StreamPort int // port for the HTTP stream server
|
StreamPort int // port for the HTTP stream server
|
||||||
|
StreamSecret string // hex HMAC key for stream tokens (reported so the web can mint HLS tokens)
|
||||||
LanIP string // LAN IP (reported in sync for stream URL resolution)
|
LanIP string // LAN IP (reported in sync for stream URL resolution)
|
||||||
TailscaleIP string // Tailscale IP (reported in sync for stream URL resolution)
|
TailscaleIP string // Tailscale IP (reported in sync for stream URL resolution)
|
||||||
CanDelete bool // library.allow_delete is enabled
|
CanDelete bool // library.allow_delete is enabled
|
||||||
ScanPaths []string // configured scan paths for file deletion validation
|
ScanPaths []string // configured scan paths for file deletion validation
|
||||||
HWAccel string // detected encoder backend ("nvenc"/"qsv"/"vaapi"/"videotoolbox"/"none")
|
HWAccel string // detected encoder backend ("nvenc"/"qsv"/"vaapi"/"videotoolbox"/"none")
|
||||||
MaxTranscodeHeight int // resolution cap the agent can transcode comfortably (px)
|
MaxTranscodeHeight int // resolution cap the agent can transcode comfortably (px)
|
||||||
|
// Diagnostic data populated by engine.DetectHWAccelDiagnostic at daemon
|
||||||
|
// start. Surfaced in the web "Diagnose transcoder" modal — lets a user
|
||||||
|
// see which encoders the ffmpeg binary supports and which devices the
|
||||||
|
// host exposes without running `unarr probe-hwaccel`.
|
||||||
|
FFmpegVersion string // first line of `ffmpeg -version`
|
||||||
|
FFmpegPath string // resolved binary path
|
||||||
|
HWEncoders []string // HW-class encoder names found in `ffmpeg -encoders`
|
||||||
|
HWDevices []string // device files + driver bins detected at probe time
|
||||||
|
AutoUpgrade bool // honor server-flagged upgrades by downloading + restarting (default: true)
|
||||||
|
Downlink string // realtime downlink transport: "auto" (SSE+long-poll fallback) | "sse" | "poll"
|
||||||
}
|
}
|
||||||
|
|
||||||
// Daemon manages agent registration and the sync loop.
|
// Daemon manages agent registration and the sync loop.
|
||||||
|
|
@ -55,6 +68,10 @@ type Daemon struct {
|
||||||
vpnMode string
|
vpnMode string
|
||||||
vpnServer string
|
vpnServer string
|
||||||
|
|
||||||
|
// CloudFlare Quick Tunnel public URL; folded into DaemonState + heartbeat
|
||||||
|
// so the web can prefer it over Tailscale/LAN for in-browser playback.
|
||||||
|
funnelURL string
|
||||||
|
|
||||||
// Watching tracks whether a user is viewing download progress in the web UI.
|
// Watching tracks whether a user is viewing download progress in the web UI.
|
||||||
Watching atomic.Bool
|
Watching atomic.Bool
|
||||||
|
|
||||||
|
|
@ -85,6 +102,22 @@ func (d *Daemon) SetVPNState(active bool, mode, server string) {
|
||||||
d.vpnServer = server
|
d.vpnServer = server
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetFunnelURL records the CloudFlare Quick Tunnel hostname so it's reflected
|
||||||
|
// in the daemon state file (read by `unarr funnel status`) and in heartbeat
|
||||||
|
// requests (so the web prefers it over Tailscale/LAN). Pass "" to clear.
|
||||||
|
func (d *Daemon) SetFunnelURL(url string) {
|
||||||
|
d.funnelURL = url
|
||||||
|
d.State.FunnelURL = url
|
||||||
|
WriteState(&d.State)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateStreamSecret sets the hex HMAC key reported on register so the web can
|
||||||
|
// mint HLS stream tokens the agent will accept.
|
||||||
|
func (d *Daemon) UpdateStreamSecret(secretHex string) {
|
||||||
|
d.cfg.StreamSecret = secretHex
|
||||||
|
d.sync.cfg.StreamSecret = secretHex
|
||||||
|
}
|
||||||
|
|
||||||
// UpdateStreamPort updates the stream port reported in sync requests.
|
// UpdateStreamPort updates the stream port reported in sync requests.
|
||||||
func (d *Daemon) UpdateStreamPort(port int) {
|
func (d *Daemon) UpdateStreamPort(port int) {
|
||||||
d.cfg.StreamPort = port
|
d.cfg.StreamPort = port
|
||||||
|
|
@ -102,13 +135,20 @@ func (d *Daemon) Register(ctx context.Context) error {
|
||||||
Version: d.cfg.Version,
|
Version: d.cfg.Version,
|
||||||
DownloadDir: d.cfg.DownloadDir,
|
DownloadDir: d.cfg.DownloadDir,
|
||||||
StreamPort: d.cfg.StreamPort,
|
StreamPort: d.cfg.StreamPort,
|
||||||
|
StreamSecret: d.cfg.StreamSecret,
|
||||||
LanIP: d.cfg.LanIP,
|
LanIP: d.cfg.LanIP,
|
||||||
TailscaleIP: d.cfg.TailscaleIP,
|
TailscaleIP: d.cfg.TailscaleIP,
|
||||||
HWAccel: d.cfg.HWAccel,
|
HWAccel: d.cfg.HWAccel,
|
||||||
MaxTranscodeHeight: d.cfg.MaxTranscodeHeight,
|
MaxTranscodeHeight: d.cfg.MaxTranscodeHeight,
|
||||||
|
FFmpegVersion: d.cfg.FFmpegVersion,
|
||||||
|
FFmpegPath: d.cfg.FFmpegPath,
|
||||||
|
HWEncoders: d.cfg.HWEncoders,
|
||||||
|
HWDevices: d.cfg.HWDevices,
|
||||||
VPNActive: d.vpnActive,
|
VPNActive: d.vpnActive,
|
||||||
VPNMode: d.vpnMode,
|
VPNMode: d.vpnMode,
|
||||||
VPNServer: d.vpnServer,
|
VPNServer: d.vpnServer,
|
||||||
|
FunnelURL: d.funnelURL,
|
||||||
|
IsDocker: RunningInDocker(),
|
||||||
}
|
}
|
||||||
if free, total, err := DiskInfo(d.cfg.DownloadDir); err == nil {
|
if free, total, err := DiskInfo(d.cfg.DownloadDir); err == nil {
|
||||||
req.DiskFreeBytes = free
|
req.DiskFreeBytes = free
|
||||||
|
|
@ -162,6 +202,7 @@ func (d *Daemon) Register(ctx context.Context) error {
|
||||||
VPNActive: d.vpnActive,
|
VPNActive: d.vpnActive,
|
||||||
VPNMode: d.vpnMode,
|
VPNMode: d.vpnMode,
|
||||||
VPNServer: d.vpnServer,
|
VPNServer: d.vpnServer,
|
||||||
|
FunnelURL: d.funnelURL,
|
||||||
}
|
}
|
||||||
WriteState(&d.State)
|
WriteState(&d.State)
|
||||||
|
|
||||||
|
|
@ -206,8 +247,12 @@ func (d *Daemon) Run(ctx context.Context) error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
d.sync.OnStreamRequest = func(req StreamRequest) {
|
d.sync.OnStreamRequest = func(req StreamRequest) {
|
||||||
|
// Off the sync loop: the handler does blocking I/O (os.Stat retries on
|
||||||
|
// NFS, then ffprobe in SetFile) — running it inline would stall task
|
||||||
|
// dispatch + status reporting for other items. The single-stream model
|
||||||
|
// (atomic SetFile swap, last-wins) tolerates concurrent requests.
|
||||||
if d.OnStreamRequested != nil {
|
if d.OnStreamRequested != nil {
|
||||||
d.OnStreamRequested(req)
|
go d.OnStreamRequested(req)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
d.sync.OnStreamSession = func(sess StreamSession) {
|
d.sync.OnStreamSession = func(sess StreamSession) {
|
||||||
|
|
@ -216,10 +261,16 @@ func (d *Daemon) Run(ctx context.Context) error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
d.sync.OnUpgrade = func(version string) {
|
d.sync.OnUpgrade = func(version string) {
|
||||||
if version != d.lastNotifiedVersion {
|
if version == d.lastNotifiedVersion {
|
||||||
d.lastNotifiedVersion = version
|
return
|
||||||
log.Printf("New version available: %s (run `unarr self-update` to upgrade)", version)
|
|
||||||
}
|
}
|
||||||
|
d.lastNotifiedVersion = version
|
||||||
|
if !d.cfg.AutoUpgrade {
|
||||||
|
log.Printf("[upgrade] new version available: %s — auto_upgrade=false, run `unarr update` to apply", version)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[upgrade] new version available: %s — applying auto-upgrade", version)
|
||||||
|
go d.applyAutoUpgrade(version)
|
||||||
}
|
}
|
||||||
d.sync.OnScan = func() {
|
d.sync.OnScan = func() {
|
||||||
log.Printf("Library scan requested by server")
|
log.Printf("Library scan requested by server")
|
||||||
|
|
@ -234,6 +285,9 @@ func (d *Daemon) Run(ctx context.Context) error {
|
||||||
d.sync.GetVPNState = func() (bool, string, string) {
|
d.sync.GetVPNState = func() (bool, string, string) {
|
||||||
return d.vpnActive, d.vpnMode, d.vpnServer
|
return d.vpnActive, d.vpnMode, d.vpnServer
|
||||||
}
|
}
|
||||||
|
d.sync.GetFunnelURL = func() string {
|
||||||
|
return d.funnelURL
|
||||||
|
}
|
||||||
d.sync.OnSyncSuccess = func() {
|
d.sync.OnSyncSuccess = func() {
|
||||||
d.State.LastHeartbeat = time.Now()
|
d.State.LastHeartbeat = time.Now()
|
||||||
if d.GetActiveCount != nil {
|
if d.GetActiveCount != nil {
|
||||||
|
|
@ -263,6 +317,67 @@ func (d *Daemon) Deregister() {
|
||||||
RemoveState()
|
RemoveState()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// applyAutoUpgrade downloads the target version and exits so the service
|
||||||
|
// supervisor (systemd Restart=always on Linux) respawns on the new binary.
|
||||||
|
// Triggered by the server's upgrade signal — opt-in flag set by the user from
|
||||||
|
// the web UI; the daemon never auto-upgrades on a passive version bump.
|
||||||
|
//
|
||||||
|
// Reports the outcome to /api/internal/agent/upgrade-result so the server
|
||||||
|
// clears `upgrade_requested`. Without this report the flag stays sticky and
|
||||||
|
// the daemon would loop on every sync — including the no-op case where it's
|
||||||
|
// already on the target version.
|
||||||
|
func (d *Daemon) applyAutoUpgrade(targetVersion string) {
|
||||||
|
currentClean := strings.TrimPrefix(d.cfg.Version, "v")
|
||||||
|
targetClean := strings.TrimPrefix(targetVersion, "v")
|
||||||
|
|
||||||
|
// No-op: server signal arrived but we're already running the target. This
|
||||||
|
// happens when the daemon restarts after a previous auto-upgrade before
|
||||||
|
// reportUpgradeResult cleared the flag, or when the operator manually
|
||||||
|
// installed the same version off-band. Skip Execute (which would also
|
||||||
|
// no-op) AND skip os.Exit, but DO clear the flag — otherwise we loop.
|
||||||
|
if currentClean == targetClean {
|
||||||
|
log.Printf("[upgrade] already on v%s — clearing server flag", currentClean)
|
||||||
|
ctxR, cancelR := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancelR()
|
||||||
|
if err := d.client.ReportUpgradeResult(ctxR, d.cfg.AgentID, true, currentClean, ""); err != nil {
|
||||||
|
log.Printf("[upgrade] report-result failed (will retry on next signal): %v", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
upgrader := &upgrade.Upgrader{
|
||||||
|
CurrentVersion: currentClean,
|
||||||
|
OnProgress: func(msg string) {
|
||||||
|
log.Printf("[upgrade] %s", msg)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||||
|
defer cancel()
|
||||||
|
result := upgrader.Execute(ctx, targetVersion)
|
||||||
|
if !result.Success {
|
||||||
|
log.Printf("[upgrade] auto-upgrade failed: %v", result.Error)
|
||||||
|
errMsg := ""
|
||||||
|
if result.Error != nil {
|
||||||
|
errMsg = result.Error.Error()
|
||||||
|
}
|
||||||
|
ctxR, cancelR := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancelR()
|
||||||
|
if err := d.client.ReportUpgradeResult(ctxR, d.cfg.AgentID, false, targetClean, errMsg); err != nil {
|
||||||
|
log.Printf("[upgrade] report-result failed: %v", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[upgrade] upgraded v%s → v%s; reporting result + exiting so service supervisor restarts on new binary",
|
||||||
|
result.OldVersion, result.NewVersion)
|
||||||
|
ctxR, cancelR := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
if err := d.client.ReportUpgradeResult(ctxR, d.cfg.AgentID, true, result.NewVersion, ""); err != nil {
|
||||||
|
log.Printf("[upgrade] report-result failed: %v", err)
|
||||||
|
}
|
||||||
|
cancelR()
|
||||||
|
time.Sleep(500 * time.Millisecond)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
// isTransientError returns true for errors worth retrying (429, 5xx, network).
|
// isTransientError returns true for errors worth retrying (429, 5xx, network).
|
||||||
func isTransientError(err error) bool {
|
func isTransientError(err error) bool {
|
||||||
if err == nil {
|
if err == nil {
|
||||||
|
|
|
||||||
26
internal/agent/docker.go
Normal file
26
internal/agent/docker.go
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import "os"
|
||||||
|
|
||||||
|
// RunningInDocker reports whether the agent process is running inside a Docker
|
||||||
|
// (or compatible OCI) container. The web uses this to swap the in-app "force
|
||||||
|
// update" button — which drives the binary self-update path that hard-stops
|
||||||
|
// inside a container (see internal/upgrade) — for a copy-paste `docker pull`
|
||||||
|
// command instead.
|
||||||
|
//
|
||||||
|
// Detection order:
|
||||||
|
// 1. UNARR_DOCKER env truthy — baked into the official image's Dockerfile, so
|
||||||
|
// it also covers podman/containerd running our image (which don't create
|
||||||
|
// /.dockerenv).
|
||||||
|
// 2. /.dockerenv exists — the standard marker Docker writes into every
|
||||||
|
// container, covering images that didn't set the env.
|
||||||
|
func RunningInDocker() bool {
|
||||||
|
switch os.Getenv("UNARR_DOCKER") {
|
||||||
|
case "1", "true", "yes":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if _, err := os.Stat("/.dockerenv"); err == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
216
internal/agent/downlink_test.go
Normal file
216
internal/agent/downlink_test.go
Normal file
|
|
@ -0,0 +1,216 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestDownlinkMode(t *testing.T) {
|
||||||
|
cases := map[string]string{
|
||||||
|
"": "auto",
|
||||||
|
"auto": "auto",
|
||||||
|
"AUTO": "auto",
|
||||||
|
" sse ": "sse",
|
||||||
|
"sse": "sse",
|
||||||
|
"poll": "poll",
|
||||||
|
"garbage": "auto",
|
||||||
|
}
|
||||||
|
for in, want := range cases {
|
||||||
|
sc, _ := newTestSyncClient("http://127.0.0.1:0")
|
||||||
|
sc.cfg.Downlink = in
|
||||||
|
if got := sc.downlinkMode(); got != want {
|
||||||
|
t.Errorf("downlinkMode(%q) = %q, want %q", in, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleDownlinkEvent_SyncNudge(t *testing.T) {
|
||||||
|
sc, _ := newTestSyncClient("http://127.0.0.1:0")
|
||||||
|
sc.handleDownlinkEvent(DownlinkEvent{Event: DownlinkEventSync, Data: json.RawMessage(`{"reason":"wake"}`)})
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-sc.SyncNow:
|
||||||
|
// good — TriggerSync fired
|
||||||
|
default:
|
||||||
|
t.Error("sync event did not trigger an immediate sync")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleDownlinkEvent_TypedControls(t *testing.T) {
|
||||||
|
sc, _ := newTestSyncClient("http://127.0.0.1:0")
|
||||||
|
|
||||||
|
var gotAction, gotTask string
|
||||||
|
var gotDelete bool
|
||||||
|
sc.OnControl = func(action, taskID string, deleteFiles bool) {
|
||||||
|
gotAction, gotTask, gotDelete = action, taskID, deleteFiles
|
||||||
|
}
|
||||||
|
|
||||||
|
payload := `{"controls":[{"action":"cancel","taskId":"task-xyz","deleteFiles":true}]}`
|
||||||
|
sc.handleDownlinkEvent(DownlinkEvent{Event: DownlinkEventCommand, Data: json.RawMessage(payload)})
|
||||||
|
|
||||||
|
if gotAction != "cancel" || gotTask != "task-xyz" || !gotDelete {
|
||||||
|
t.Errorf("OnControl got (%q,%q,%v), want (cancel,task-xyz,true)", gotAction, gotTask, gotDelete)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleDownlinkEvent_PingIsLivenessOnly(t *testing.T) {
|
||||||
|
sc, _ := newTestSyncClient("http://127.0.0.1:0")
|
||||||
|
controlCalled := false
|
||||||
|
sc.OnControl = func(string, string, bool) { controlCalled = true }
|
||||||
|
|
||||||
|
sc.handleDownlinkEvent(DownlinkEvent{Event: DownlinkEventPing})
|
||||||
|
|
||||||
|
if controlCalled {
|
||||||
|
t.Error("ping must not invoke OnControl")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-sc.SyncNow:
|
||||||
|
t.Error("ping must not trigger a sync")
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleDownlinkEvent_BadPayloadNoPanic(t *testing.T) {
|
||||||
|
sc, _ := newTestSyncClient("http://127.0.0.1:0")
|
||||||
|
sc.OnControl = func(string, string, bool) { t.Error("OnControl must not fire on bad payload") }
|
||||||
|
// Should log + return, not panic.
|
||||||
|
sc.handleDownlinkEvent(DownlinkEvent{Event: DownlinkEventCommand, Data: json.RawMessage(`{not json`)})
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunEventStreamOnce_Healthy: a server that sends a heartbeat then a sync
|
||||||
|
// event, then closes → runEventStreamOnce returns true (healthy) and the sync
|
||||||
|
// nudge fired.
|
||||||
|
func TestRunEventStreamOnce_Healthy(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/event-stream")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
f, _ := w.(http.Flusher)
|
||||||
|
w.Write([]byte(": hb\n\n"))
|
||||||
|
if f != nil {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
w.Write([]byte("event: sync\ndata: {}\n\n"))
|
||||||
|
if f != nil {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
// Return → response body closes → stream ends.
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
sc, _ := newTestSyncClient(srv.URL)
|
||||||
|
sc.livenessTimeout = 500 * time.Millisecond
|
||||||
|
|
||||||
|
healthy := sc.runEventStreamOnce(context.Background())
|
||||||
|
if !healthy {
|
||||||
|
t.Error("expected healthy=true after receiving frames")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-sc.SyncNow:
|
||||||
|
default:
|
||||||
|
t.Error("expected a sync nudge from the sync event")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunEventStreamOnce_DeadOrBuffered: server connects 200 OK but sends
|
||||||
|
// nothing → liveness deadline fires → returns false (so auto mode falls back).
|
||||||
|
func TestRunEventStreamOnce_DeadOrBuffered(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/event-stream")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
if f, ok := w.(http.Flusher); ok {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
// Send NO frames — simulate a silently-buffering proxy.
|
||||||
|
<-r.Context().Done()
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
sc, _ := newTestSyncClient(srv.URL)
|
||||||
|
sc.livenessTimeout = 150 * time.Millisecond
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
healthy := sc.runEventStreamOnce(context.Background())
|
||||||
|
if healthy {
|
||||||
|
t.Error("expected healthy=false when no frame arrives within liveness deadline")
|
||||||
|
}
|
||||||
|
if elapsed := time.Since(start); elapsed > 2*time.Second {
|
||||||
|
t.Errorf("liveness deadline did not fire promptly (took %s)", elapsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunEventStreamOnce_PreambleThenStall: a partial-buffering proxy that
|
||||||
|
// flushes the connect preamble (one heartbeat) then goes silent must be treated
|
||||||
|
// as UNHEALTHY (false), so the auto fallback eventually triggers. This is the
|
||||||
|
// common buffering mode the zero-frame test doesn't cover.
|
||||||
|
func TestRunEventStreamOnce_PreambleThenStall(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/event-stream")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
f, _ := w.(http.Flusher)
|
||||||
|
// Flush ONE heartbeat (the preamble) then stall — never send more.
|
||||||
|
w.Write([]byte(": connected hb=15000\n\n"))
|
||||||
|
if f != nil {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
<-r.Context().Done()
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
sc, _ := newTestSyncClient(srv.URL)
|
||||||
|
sc.livenessTimeout = 150 * time.Millisecond
|
||||||
|
|
||||||
|
if sc.runEventStreamOnce(context.Background()) {
|
||||||
|
t.Error("a stream that flushes one ping then stalls must be unhealthy (else fallback never triggers)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunEventStreamOnce_ConnectFail: dead server → false, no hang.
|
||||||
|
func TestRunEventStreamOnce_ConnectFail(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {}))
|
||||||
|
url := srv.URL
|
||||||
|
srv.Close() // port now refuses
|
||||||
|
|
||||||
|
sc, _ := newTestSyncClient(url)
|
||||||
|
sc.livenessTimeout = 500 * time.Millisecond
|
||||||
|
|
||||||
|
if sc.runEventStreamOnce(context.Background()) {
|
||||||
|
t.Error("expected healthy=false on connect failure")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunEventStreamOnce_CtxCancel: cancelling ctx returns promptly.
|
||||||
|
func TestRunEventStreamOnce_CtxCancel(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/event-stream")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
if f, ok := w.(http.Flusher); ok {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
<-r.Context().Done()
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
sc, _ := newTestSyncClient(srv.URL)
|
||||||
|
sc.livenessTimeout = 10 * time.Second
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
go func() {
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
cancel()
|
||||||
|
}()
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
sc.runEventStreamOnce(ctx)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("runEventStreamOnce did not return after ctx cancel")
|
||||||
|
}
|
||||||
|
}
|
||||||
208
internal/agent/events_client.go
Normal file
208
internal/agent/events_client.go
Normal file
|
|
@ -0,0 +1,208 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DownlinkEvent is one parsed Server-Sent Event from the agent events stream
|
||||||
|
// (GET /api/internal/agent/events). Event is the SSE "event:" name; Data is the
|
||||||
|
// raw "data:" payload (nil for heartbeat pings).
|
||||||
|
type DownlinkEvent struct {
|
||||||
|
Event string
|
||||||
|
Data json.RawMessage
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommandEvent is the payload of an "command" downlink event — typed control
|
||||||
|
// actions the server pushes for instant application (cancel/pause). Mirrors the
|
||||||
|
// `controls` field of /agent/sync so the same OnControl callback handles both.
|
||||||
|
type CommandEvent struct {
|
||||||
|
Controls []ControlAction `json:"controls"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Downlink event names. Heartbeat pings surface as a distinct event so the
|
||||||
|
// consumer can reset its liveness deadline without acting on them.
|
||||||
|
const (
|
||||||
|
DownlinkEventPing = "ping" // SSE comment line (`: hb`) — liveness only
|
||||||
|
DownlinkEventSync = "sync" // nudge: run a full /agent/sync
|
||||||
|
DownlinkEventCommand = "command" // typed control actions
|
||||||
|
)
|
||||||
|
|
||||||
|
// Bounds on the SSE reader, identical in spirit to the retired WebRTC signal
|
||||||
|
// reader: a hostile or buggy server must not be able to grow daemon memory by
|
||||||
|
// streaming one unbounded line or unbounded `data:` continuation lines.
|
||||||
|
const (
|
||||||
|
eventsSSEMaxLineBytes = 256 * 1024
|
||||||
|
eventsSSEMaxEventBytes = 1024 * 1024
|
||||||
|
)
|
||||||
|
|
||||||
|
// EventStream wraps an open SSE downlink connection. Read from Events() until
|
||||||
|
// the channel closes (server recycle, network drop, or ctx cancel), then call
|
||||||
|
// Close() and reopen if you want to keep listening. Always defer Close().
|
||||||
|
type EventStream struct {
|
||||||
|
resp *http.Response
|
||||||
|
cancel context.CancelFunc
|
||||||
|
events chan DownlinkEvent
|
||||||
|
errs chan error
|
||||||
|
done chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Events streams server-pushed downlink events. Heartbeat comments surface as
|
||||||
|
// DownlinkEvent{Event: DownlinkEventPing}. The channel closes when the
|
||||||
|
// connection ends.
|
||||||
|
func (s *EventStream) Events() <-chan DownlinkEvent { return s.events }
|
||||||
|
|
||||||
|
// Err returns the terminating error (if any) once Events() has closed.
|
||||||
|
func (s *EventStream) Err() error {
|
||||||
|
select {
|
||||||
|
case err := <-s.errs:
|
||||||
|
return err
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close cancels the request and waits for the reader goroutine to drain.
|
||||||
|
// Safe to call more than once.
|
||||||
|
func (s *EventStream) Close() error {
|
||||||
|
if s.cancel != nil {
|
||||||
|
s.cancel()
|
||||||
|
}
|
||||||
|
if s.resp != nil {
|
||||||
|
s.resp.Body.Close()
|
||||||
|
}
|
||||||
|
<-s.done
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenEventStream opens a long-lived SSE connection to the agent events
|
||||||
|
// downlink. Routed through MirrorPool failover for the INITIAL connect only
|
||||||
|
// (a mid-stream drop is surfaced as a closed channel, not retried here — the
|
||||||
|
// caller reopens). Caller MUST Close() (or cancel ctx) to free resources.
|
||||||
|
func (c *Client) OpenEventStream(ctx context.Context) (*EventStream, error) {
|
||||||
|
streamCtx, cancel := context.WithCancel(ctx)
|
||||||
|
|
||||||
|
var resp *http.Response
|
||||||
|
err := c.withMirrorFailover(func(base string) error {
|
||||||
|
req, reqErr := http.NewRequestWithContext(streamCtx, http.MethodGet, base+"/api/internal/agent/events", nil)
|
||||||
|
if reqErr != nil {
|
||||||
|
return fmt.Errorf("create events request: %w", reqErr)
|
||||||
|
}
|
||||||
|
c.setHeaders(req)
|
||||||
|
req.Header.Set("Accept", "text/event-stream")
|
||||||
|
req.Header.Set("Cache-Control", "no-cache")
|
||||||
|
|
||||||
|
// No-timeout client: the connection is intentionally long-lived; ctx
|
||||||
|
// controls cancellation (same as the wake long-poll).
|
||||||
|
r, doErr := c.wakeClient.Do(req)
|
||||||
|
if doErr != nil {
|
||||||
|
return fmt.Errorf("events request failed: %w", doErr)
|
||||||
|
}
|
||||||
|
if r.StatusCode != http.StatusOK {
|
||||||
|
body, _ := io.ReadAll(io.LimitReader(r.Body, 1<<10))
|
||||||
|
r.Body.Close()
|
||||||
|
return &HTTPError{StatusCode: r.StatusCode, Message: strings.TrimSpace(string(body))}
|
||||||
|
}
|
||||||
|
resp = r
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
cancel()
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
stream := &EventStream{
|
||||||
|
resp: resp,
|
||||||
|
cancel: cancel,
|
||||||
|
events: make(chan DownlinkEvent, 8),
|
||||||
|
errs: make(chan error, 1),
|
||||||
|
done: make(chan struct{}),
|
||||||
|
}
|
||||||
|
go stream.read()
|
||||||
|
return stream, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *EventStream) read() {
|
||||||
|
defer close(s.done)
|
||||||
|
defer close(s.events)
|
||||||
|
|
||||||
|
scanner := bufio.NewScanner(s.resp.Body)
|
||||||
|
scanner.Buffer(make([]byte, 16*1024), eventsSSEMaxLineBytes)
|
||||||
|
|
||||||
|
ctx := s.resp.Request.Context()
|
||||||
|
var dataBuf bytes.Buffer
|
||||||
|
var eventName string
|
||||||
|
|
||||||
|
emit := func(ev DownlinkEvent) bool {
|
||||||
|
select {
|
||||||
|
case s.events <- ev:
|
||||||
|
return true
|
||||||
|
case <-ctx.Done():
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for scanner.Scan() {
|
||||||
|
line := strings.TrimRight(scanner.Text(), "\r")
|
||||||
|
|
||||||
|
if line == "" {
|
||||||
|
// Blank line ends an event — dispatch if we accumulated data.
|
||||||
|
if dataBuf.Len() > 0 {
|
||||||
|
name := eventName
|
||||||
|
if name == "" {
|
||||||
|
name = "message"
|
||||||
|
}
|
||||||
|
data := make([]byte, dataBuf.Len())
|
||||||
|
copy(data, dataBuf.Bytes())
|
||||||
|
if !emit(DownlinkEvent{Event: name, Data: json.RawMessage(data)}) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
dataBuf.Reset()
|
||||||
|
eventName = ""
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.HasPrefix(line, ":") {
|
||||||
|
// SSE comment / heartbeat — surface as a ping so the consumer resets
|
||||||
|
// its liveness deadline (and can tell a live stream from a silently
|
||||||
|
// buffered one that never delivers anything).
|
||||||
|
if !emit(DownlinkEvent{Event: DownlinkEventPing}) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(line, "event:") {
|
||||||
|
eventName = strings.TrimSpace(line[len("event:"):])
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(line, "data:") {
|
||||||
|
payload := strings.TrimSpace(line[len("data:"):])
|
||||||
|
if dataBuf.Len()+len(payload)+1 > eventsSSEMaxEventBytes {
|
||||||
|
select {
|
||||||
|
case s.errs <- fmt.Errorf("sse: event exceeded %d bytes", eventsSSEMaxEventBytes):
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if dataBuf.Len() > 0 {
|
||||||
|
dataBuf.WriteByte('\n')
|
||||||
|
}
|
||||||
|
dataBuf.WriteString(payload)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// id:, retry:, unknown fields — ignored.
|
||||||
|
}
|
||||||
|
if err := scanner.Err(); err != nil {
|
||||||
|
select {
|
||||||
|
case s.errs <- err:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
193
internal/agent/events_client_test.go
Normal file
193
internal/agent/events_client_test.go
Normal file
|
|
@ -0,0 +1,193 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// sseServer returns an httptest server that writes the given raw SSE body and
|
||||||
|
// flushes, then holds the connection until the request context is cancelled (so
|
||||||
|
// the client drives the close, like the real long-lived endpoint).
|
||||||
|
func sseServer(t *testing.T, body string) *httptest.Server {
|
||||||
|
t.Helper()
|
||||||
|
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/event-stream")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
if _, err := w.Write([]byte(body)); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if f, ok := w.(http.Flusher); ok {
|
||||||
|
f.Flush()
|
||||||
|
}
|
||||||
|
<-r.Context().Done()
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOpenEventStream_ParsesTypedEvents(t *testing.T) {
|
||||||
|
body := "retry: 2000\n\n" +
|
||||||
|
": connected hb=15000\n\n" +
|
||||||
|
"event: sync\ndata: {\"reason\":\"wake\"}\n\n" +
|
||||||
|
"event: command\ndata: {\"controls\":[{\"action\":\"cancel\",\"taskId\":\"t1\"}]}\n\n"
|
||||||
|
srv := sseServer(t, body)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
_, client := newTestSyncClient(srv.URL)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
stream, err := client.OpenEventStream(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OpenEventStream: %v", err)
|
||||||
|
}
|
||||||
|
defer stream.Close()
|
||||||
|
|
||||||
|
var got []DownlinkEvent
|
||||||
|
timeout := time.After(2 * time.Second)
|
||||||
|
for len(got) < 3 {
|
||||||
|
select {
|
||||||
|
case ev, ok := <-stream.Events():
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("stream closed early after %d events", len(got))
|
||||||
|
}
|
||||||
|
got = append(got, ev)
|
||||||
|
case <-timeout:
|
||||||
|
t.Fatalf("timed out; got %d events: %+v", len(got), got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// First frame is the heartbeat comment surfaced as a ping.
|
||||||
|
if got[0].Event != DownlinkEventPing {
|
||||||
|
t.Errorf("event[0] = %q, want ping", got[0].Event)
|
||||||
|
}
|
||||||
|
if got[1].Event != DownlinkEventSync {
|
||||||
|
t.Errorf("event[1] = %q, want sync", got[1].Event)
|
||||||
|
}
|
||||||
|
if got[2].Event != DownlinkEventCommand {
|
||||||
|
t.Errorf("event[2] = %q, want command", got[2].Event)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(got[2].Data), "cancel") {
|
||||||
|
t.Errorf("command data missing payload: %s", got[2].Data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOpenEventStream_MultiLineData(t *testing.T) {
|
||||||
|
// Two data: lines for one event must join with a newline.
|
||||||
|
body := "event: sync\ndata: line1\ndata: line2\n\n"
|
||||||
|
srv := sseServer(t, body)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
_, client := newTestSyncClient(srv.URL)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
stream, err := client.OpenEventStream(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OpenEventStream: %v", err)
|
||||||
|
}
|
||||||
|
defer stream.Close()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case ev := <-stream.Events():
|
||||||
|
if string(ev.Data) != "line1\nline2" {
|
||||||
|
t.Errorf("data = %q, want \"line1\\nline2\"", ev.Data)
|
||||||
|
}
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("timed out waiting for event")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOpenEventStream_RejectsOversizedEvent(t *testing.T) {
|
||||||
|
// Many data: continuation lines until past eventsSSEMaxEventBytes → the
|
||||||
|
// reader surfaces an error and closes the channel (so the loop reconnects).
|
||||||
|
var b strings.Builder
|
||||||
|
b.WriteString("event: command\n")
|
||||||
|
chunk := "data: " + strings.Repeat("x", 4096) + "\n"
|
||||||
|
for b.Len() < eventsSSEMaxEventBytes+8192 {
|
||||||
|
b.WriteString(chunk)
|
||||||
|
}
|
||||||
|
b.WriteString("\n")
|
||||||
|
srv := sseServer(t, b.String())
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
_, client := newTestSyncClient(srv.URL)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
stream, err := client.OpenEventStream(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OpenEventStream: %v", err)
|
||||||
|
}
|
||||||
|
defer stream.Close()
|
||||||
|
|
||||||
|
// Drain until the channel closes (the oversized event must NOT be emitted).
|
||||||
|
timeout := time.After(2 * time.Second)
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case ev, ok := <-stream.Events():
|
||||||
|
if !ok {
|
||||||
|
if stream.Err() == nil {
|
||||||
|
t.Error("expected an error after oversized event, got nil")
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if ev.Event == DownlinkEventCommand {
|
||||||
|
t.Fatalf("oversized command event must not be dispatched")
|
||||||
|
}
|
||||||
|
case <-timeout:
|
||||||
|
t.Fatal("timed out; channel never closed after oversized event")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOpenEventStream_Non200ReturnsError(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
fmt.Fprint(w, `{"error":"not found"}`)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
_, client := newTestSyncClient(srv.URL)
|
||||||
|
_, err := client.OpenEventStream(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error on 404, got nil")
|
||||||
|
}
|
||||||
|
var httpErr *HTTPError
|
||||||
|
if !errors.As(err, &httpErr) || httpErr.StatusCode != http.StatusNotFound {
|
||||||
|
t.Errorf("expected HTTPError 404, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEventStream_CloseCancelsRead(t *testing.T) {
|
||||||
|
srv := sseServer(t, ": connected\n\n")
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
_, client := newTestSyncClient(srv.URL)
|
||||||
|
stream, err := client.OpenEventStream(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OpenEventStream: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drain the initial ping.
|
||||||
|
select {
|
||||||
|
case <-stream.Events():
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("no initial ping")
|
||||||
|
}
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
stream.Close()
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("Close() did not return — read goroutine leaked")
|
||||||
|
}
|
||||||
|
}
|
||||||
88
internal/agent/mirror_transport.go
Normal file
88
internal/agent/mirror_transport.go
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MirrorRoundTripper gives any *http.Client the same mirror failover the agent
|
||||||
|
// control-plane Client has: on a transient transport error or a retryable 5xx
|
||||||
|
// it rewrites the request to the next mirror in the shared MirrorPool and
|
||||||
|
// retries. It exists so the public-API go-client stops diverging from the agent
|
||||||
|
// client — both now survive a primary-domain takedown using the SAME pool and
|
||||||
|
// the SAME transient-error policy (IsTransient).
|
||||||
|
//
|
||||||
|
// Requests whose body cannot be replayed (Body != nil && GetBody == nil) are
|
||||||
|
// sent once with no failover, so a consumed body is never re-read. Standard
|
||||||
|
// library requests built with a *bytes.Reader/strings.Reader (and all GETs) set
|
||||||
|
// GetBody, so this only affects exotic streaming bodies the public API doesn't use.
|
||||||
|
type MirrorRoundTripper struct {
|
||||||
|
pool *MirrorPool
|
||||||
|
inner http.RoundTripper
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMirrorRoundTripper wraps inner (defaults to http.DefaultTransport) with
|
||||||
|
// failover across pool's mirrors.
|
||||||
|
func NewMirrorRoundTripper(pool *MirrorPool, inner http.RoundTripper) *MirrorRoundTripper {
|
||||||
|
if inner == nil {
|
||||||
|
inner = http.DefaultTransport
|
||||||
|
}
|
||||||
|
return &MirrorRoundTripper{pool: pool, inner: inner}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RoundTrip points the request at the current mirror and, on a transient
|
||||||
|
// failure, rotates the pool and retries against the next one. A non-transient
|
||||||
|
// HTTP status (4xx, or a 5xx IsTransient doesn't retry) or a non-replayable body
|
||||||
|
// is returned to the caller unchanged.
|
||||||
|
func (m *MirrorRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
|
attempts := 1
|
||||||
|
if req.Body == nil || req.GetBody != nil { // replayable → may fail over
|
||||||
|
if n := m.pool.Len(); n > attempts {
|
||||||
|
attempts = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var lastErr error
|
||||||
|
for i := 0; i < attempts; i++ {
|
||||||
|
out := req.Clone(req.Context())
|
||||||
|
if req.GetBody != nil {
|
||||||
|
body, err := req.GetBody()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("mirror transport: rebuild body: %w", err)
|
||||||
|
}
|
||||||
|
out.Body = body
|
||||||
|
}
|
||||||
|
if base, err := url.Parse(m.pool.Current()); err == nil && base.Host != "" {
|
||||||
|
out.URL.Scheme = base.Scheme
|
||||||
|
out.URL.Host = base.Host
|
||||||
|
out.Host = base.Host
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := m.inner.RoundTrip(out)
|
||||||
|
last := i == attempts-1
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
if last || !IsTransient(err) {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
lastErr = err
|
||||||
|
case resp.StatusCode >= 400 && IsTransient(&HTTPError{StatusCode: resp.StatusCode}):
|
||||||
|
if last {
|
||||||
|
return resp, nil // surface the real 5xx to the caller
|
||||||
|
}
|
||||||
|
resp.Body.Close()
|
||||||
|
lastErr = fmt.Errorf("mirror %s: HTTP %d", out.URL.Host, resp.StatusCode)
|
||||||
|
default:
|
||||||
|
return resp, nil // success, or a status we must not retry (4xx/auth)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, rotated := m.pool.Rotate(); !rotated {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if lastErr == nil {
|
||||||
|
lastErr = fmt.Errorf("mirror transport: all mirrors failed")
|
||||||
|
}
|
||||||
|
return nil, lastErr
|
||||||
|
}
|
||||||
172
internal/agent/mirror_transport_test.go
Normal file
172
internal/agent/mirror_transport_test.go
Normal file
|
|
@ -0,0 +1,172 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_FailoverOn503(t *testing.T) {
|
||||||
|
var primaryHits, mirrorHits int
|
||||||
|
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
primaryHits++
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
}))
|
||||||
|
defer primary.Close()
|
||||||
|
mirror := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
mirrorHits++
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
io.WriteString(w, "ok")
|
||||||
|
}))
|
||||||
|
defer mirror.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(primary.URL, []string{mirror.URL})
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, primary.URL+"/api/v1/search", nil)
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Errorf("status = %d, want 200", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if primaryHits != 1 || mirrorHits != 1 {
|
||||||
|
t.Errorf("hits primary=%d mirror=%d, want 1/1", primaryHits, mirrorHits)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_NoFailoverOn404(t *testing.T) {
|
||||||
|
var mirrorHits int
|
||||||
|
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
}))
|
||||||
|
defer primary.Close()
|
||||||
|
mirror := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
mirrorHits++
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer mirror.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(primary.URL, []string{mirror.URL})
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, primary.URL+"/x", nil)
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Errorf("status = %d, want 404 (surfaced, not retried)", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if mirrorHits != 0 {
|
||||||
|
t.Errorf("mirror hit %d times — must NOT fail over on 404", mirrorHits)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_FailoverOnConnRefused(t *testing.T) {
|
||||||
|
dead := httptest.NewServer(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {}))
|
||||||
|
deadURL := dead.URL
|
||||||
|
dead.Close() // port now refuses connections
|
||||||
|
|
||||||
|
mirror := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer mirror.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(deadURL, []string{mirror.URL})
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, deadURL+"/x", nil)
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip should have failed over, got: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Errorf("status = %d, want 200 after failover", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_ReplaysBodyOnFailover(t *testing.T) {
|
||||||
|
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
}))
|
||||||
|
defer primary.Close()
|
||||||
|
var gotBody string
|
||||||
|
mirror := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
b, _ := io.ReadAll(r.Body)
|
||||||
|
gotBody = string(b)
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer mirror.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(primary.URL, []string{mirror.URL})
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
req, _ := http.NewRequest(http.MethodPost, primary.URL+"/x", strings.NewReader("payload"))
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if gotBody != "payload" {
|
||||||
|
t.Errorf("mirror received body %q, want \"payload\" (body must be replayed on failover)", gotBody)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_NonReplayableBodyNoFailover(t *testing.T) {
|
||||||
|
var primaryHits, mirrorHits int
|
||||||
|
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
primaryHits++
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
}))
|
||||||
|
defer primary.Close()
|
||||||
|
mirror := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
mirrorHits++
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer mirror.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(primary.URL, []string{mirror.URL})
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
// A body with no GetBody can't be replayed → must be sent once, no failover.
|
||||||
|
req, _ := http.NewRequest(http.MethodPost, primary.URL+"/x", io.NopCloser(strings.NewReader("payload")))
|
||||||
|
req.GetBody = nil
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusServiceUnavailable {
|
||||||
|
t.Errorf("status = %d, want 503 (single attempt, no failover)", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if primaryHits != 1 || mirrorHits != 0 {
|
||||||
|
t.Errorf("hits primary=%d mirror=%d, want 1/0 (non-replayable body must not fail over)", primaryHits, mirrorHits)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMirrorRoundTripper_SingleMirrorSurfaces503(t *testing.T) {
|
||||||
|
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
}))
|
||||||
|
defer primary.Close()
|
||||||
|
|
||||||
|
pool := NewMirrorPool(primary.URL, nil)
|
||||||
|
rt := NewMirrorRoundTripper(pool, http.DefaultTransport)
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, primary.URL+"/x", nil)
|
||||||
|
|
||||||
|
resp, err := rt.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RoundTrip: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusServiceUnavailable {
|
||||||
|
t.Errorf("status = %d, want 503 surfaced (no mirror to fail over to)", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -2,6 +2,8 @@ package agent
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"time"
|
"time"
|
||||||
|
|
@ -9,6 +11,13 @@ import (
|
||||||
"github.com/torrentclaw/unarr/internal/config"
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrDaemonNotRunning is returned when no daemon state file exists on disk.
|
||||||
|
// Callers may wrap it with %w; downstream code uses errors.Is to detect it.
|
||||||
|
// NOTE: the message text is matched by the sentry package (string-match, to
|
||||||
|
// avoid an import cycle). Keep the prefix "daemon does not appear to be
|
||||||
|
// running" stable, or update sentry.daemonNotRunningMarker accordingly.
|
||||||
|
var ErrDaemonNotRunning = errors.New("daemon does not appear to be running (state file not found)")
|
||||||
|
|
||||||
// DaemonState is written to disk every heartbeat for external tools to read.
|
// DaemonState is written to disk every heartbeat for external tools to read.
|
||||||
type DaemonState struct {
|
type DaemonState struct {
|
||||||
AgentID string `json:"agentId"`
|
AgentID string `json:"agentId"`
|
||||||
|
|
@ -29,6 +38,11 @@ type DaemonState struct {
|
||||||
VPNActive bool `json:"vpnActive,omitempty"`
|
VPNActive bool `json:"vpnActive,omitempty"`
|
||||||
VPNMode string `json:"vpnMode,omitempty"` // managed | self-hosted
|
VPNMode string `json:"vpnMode,omitempty"` // managed | self-hosted
|
||||||
VPNServer string `json:"vpnServer,omitempty"` // WireGuard endpoint (ip:port)
|
VPNServer string `json:"vpnServer,omitempty"` // WireGuard endpoint (ip:port)
|
||||||
|
|
||||||
|
// CloudFlare Quick Tunnel state, so `unarr funnel status` can report the
|
||||||
|
// HTTPS hostname the daemon is reachable at from anywhere on the internet.
|
||||||
|
// Empty when the funnel is off or hasn't registered yet.
|
||||||
|
FunnelURL string `json:"funnelUrl,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// stateFilePathFn is overridable for testing.
|
// stateFilePathFn is overridable for testing.
|
||||||
|
|
@ -64,17 +78,31 @@ func WriteState(state *DaemonState) {
|
||||||
os.Rename(tmp, path)
|
os.Rename(tmp, path)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ReadState reads the daemon state from disk. Returns nil if not found.
|
// ReadState reads the daemon state from disk. Returns nil if not found or
|
||||||
|
// unreadable. Use LoadState when callers need to distinguish "not running"
|
||||||
|
// from "state file corrupted".
|
||||||
func ReadState() *DaemonState {
|
func ReadState() *DaemonState {
|
||||||
|
state, _ := LoadState()
|
||||||
|
return state
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadState reads the daemon state and returns explicit errors:
|
||||||
|
// - ErrDaemonNotRunning when the state file does not exist
|
||||||
|
// - a wrapped json error when the file exists but cannot be decoded
|
||||||
|
// (a real bug worth reporting to Sentry)
|
||||||
|
func LoadState() (*DaemonState, error) {
|
||||||
data, err := os.ReadFile(StateFilePath())
|
data, err := os.ReadFile(StateFilePath())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return nil, ErrDaemonNotRunning
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
var state DaemonState
|
var state DaemonState
|
||||||
if json.Unmarshal(data, &state) != nil {
|
if err := json.Unmarshal(data, &state); err != nil {
|
||||||
return nil
|
return nil, fmt.Errorf("decode daemon state %s: %w", StateFilePath(), err)
|
||||||
}
|
}
|
||||||
return &state
|
return &state, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveState deletes the state file (called on clean shutdown).
|
// RemoveState deletes the state file (called on clean shutdown).
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
package agent
|
package agent
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
@ -104,3 +105,39 @@ func TestReadStateCorruptedJSON(t *testing.T) {
|
||||||
t.Errorf("ReadState() should return nil for corrupted JSON, got %+v", state)
|
t.Errorf("ReadState() should return nil for corrupted JSON, got %+v", state)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadStateNotFound(t *testing.T) {
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
origFn := stateFilePathFn
|
||||||
|
stateFilePathFn = func() string { return filepath.Join(tmpDir, "nonexistent.json") }
|
||||||
|
defer func() { stateFilePathFn = origFn }()
|
||||||
|
|
||||||
|
state, err := LoadState()
|
||||||
|
if state != nil {
|
||||||
|
t.Errorf("LoadState() state = %+v, want nil", state)
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrDaemonNotRunning) {
|
||||||
|
t.Errorf("LoadState() err = %v, want ErrDaemonNotRunning", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadStateCorruptedJSON(t *testing.T) {
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
origFn := stateFilePathFn
|
||||||
|
path := filepath.Join(tmpDir, "daemon.state.json")
|
||||||
|
stateFilePathFn = func() string { return path }
|
||||||
|
defer func() { stateFilePathFn = origFn }()
|
||||||
|
|
||||||
|
os.WriteFile(path, []byte("not valid json{{{"), 0o644)
|
||||||
|
|
||||||
|
state, err := LoadState()
|
||||||
|
if state != nil {
|
||||||
|
t.Errorf("LoadState() state = %+v, want nil", state)
|
||||||
|
}
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("LoadState() err = nil, want decode error")
|
||||||
|
}
|
||||||
|
if errors.Is(err, ErrDaemonNotRunning) {
|
||||||
|
t.Error("corrupt state must not be reported as ErrDaemonNotRunning — it would be filtered from Sentry")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,10 @@ package agent
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"log"
|
"log"
|
||||||
"runtime"
|
"runtime"
|
||||||
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
@ -15,6 +17,23 @@ const (
|
||||||
// SyncIntervalIdle is the sync interval when nobody is watching.
|
// SyncIntervalIdle is the sync interval when nobody is watching.
|
||||||
// Keep this short enough to pick up stream requests quickly without hammering the server.
|
// Keep this short enough to pick up stream requests quickly without hammering the server.
|
||||||
SyncIntervalIdle = 10 * time.Second
|
SyncIntervalIdle = 10 * time.Second
|
||||||
|
|
||||||
|
// --- Downlink (server→agent realtime) tuning ---
|
||||||
|
|
||||||
|
// downlinkLivenessTimeout is the maximum time to wait for ANY SSE frame
|
||||||
|
// (heartbeat comment or event) before declaring the stream dead. The server
|
||||||
|
// heartbeats every ~15s; ~2.5× gives slack for jitter while still catching a
|
||||||
|
// path that connects 200 OK but silently buffers (delivers nothing until
|
||||||
|
// close) — the failure mode that justifies the long-poll fallback.
|
||||||
|
downlinkLivenessTimeout = 40 * time.Second
|
||||||
|
// sseReconnectDelay is the pause between SSE connection attempts.
|
||||||
|
sseReconnectDelay = 2 * time.Second
|
||||||
|
// maxSSEFailures is the number of consecutive failed/dead SSE attempts
|
||||||
|
// before "auto" mode falls back to the long-poll wake downlink.
|
||||||
|
maxSSEFailures = 3
|
||||||
|
// downlinkFallbackWindow is how long to ride long-poll before re-probing SSE,
|
||||||
|
// so a transient proxy hiccup doesn't pin the agent on polling forever.
|
||||||
|
downlinkFallbackWindow = 5 * time.Minute
|
||||||
)
|
)
|
||||||
|
|
||||||
// SyncClient handles bidirectional state synchronization between the CLI and server.
|
// SyncClient handles bidirectional state synchronization between the CLI and server.
|
||||||
|
|
@ -40,6 +59,9 @@ type SyncClient struct {
|
||||||
// WireGuard tunnel is up, the mode, and the exit server) so the web can track
|
// WireGuard tunnel is up, the mode, and the exit server) so the web can track
|
||||||
// which agent holds the single WG slot.
|
// which agent holds the single WG slot.
|
||||||
GetVPNState func() (active bool, mode, server string)
|
GetVPNState func() (active bool, mode, server string)
|
||||||
|
// GetFunnelURL returns the CloudFlare Quick Tunnel public hostname if one
|
||||||
|
// is active, else "". Sent on every sync so the web picks it up live.
|
||||||
|
GetFunnelURL func() string
|
||||||
// OnDeleteFiles is called when the server requests file deletion from disk.
|
// OnDeleteFiles is called when the server requests file deletion from disk.
|
||||||
// It should delete the files and return the IDs of successfully deleted items.
|
// It should delete the files and return the IDs of successfully deleted items.
|
||||||
OnDeleteFiles func(items []LibraryDeleteRequest) []int
|
OnDeleteFiles func(items []LibraryDeleteRequest) []int
|
||||||
|
|
@ -50,6 +72,11 @@ type SyncClient struct {
|
||||||
watching atomic.Bool
|
watching atomic.Bool
|
||||||
interval atomic.Int64 // stored as nanoseconds
|
interval atomic.Int64 // stored as nanoseconds
|
||||||
|
|
||||||
|
// livenessTimeout is the max wait for any SSE frame before the downlink
|
||||||
|
// treats the stream as dead/buffered. Defaults to downlinkLivenessTimeout;
|
||||||
|
// overridable in tests.
|
||||||
|
livenessTimeout time.Duration
|
||||||
|
|
||||||
// pendingDeleteConfirmed holds item IDs to report as deleted in the next sync.
|
// pendingDeleteConfirmed holds item IDs to report as deleted in the next sync.
|
||||||
pendingDeleteMu sync.Mutex
|
pendingDeleteMu sync.Mutex
|
||||||
pendingDeleteConfirmed []int
|
pendingDeleteConfirmed []int
|
||||||
|
|
@ -61,10 +88,11 @@ type SyncClient struct {
|
||||||
// NewSyncClient creates a sync client.
|
// NewSyncClient creates a sync client.
|
||||||
func NewSyncClient(client *Client, cfg DaemonConfig, state *LocalState) *SyncClient {
|
func NewSyncClient(client *Client, cfg DaemonConfig, state *LocalState) *SyncClient {
|
||||||
sc := &SyncClient{
|
sc := &SyncClient{
|
||||||
client: client,
|
client: client,
|
||||||
cfg: cfg,
|
cfg: cfg,
|
||||||
state: state,
|
state: state,
|
||||||
SyncNow: make(chan struct{}, 1),
|
SyncNow: make(chan struct{}, 1),
|
||||||
|
livenessTimeout: downlinkLivenessTimeout,
|
||||||
}
|
}
|
||||||
sc.interval.Store(int64(SyncIntervalIdle))
|
sc.interval.Store(int64(SyncIntervalIdle))
|
||||||
return sc
|
return sc
|
||||||
|
|
@ -85,8 +113,9 @@ func (sc *SyncClient) TriggerSync() {
|
||||||
|
|
||||||
// Run starts the adaptive sync loop. Blocks until ctx is cancelled.
|
// Run starts the adaptive sync loop. Blocks until ctx is cancelled.
|
||||||
func (sc *SyncClient) Run(ctx context.Context) error {
|
func (sc *SyncClient) Run(ctx context.Context) error {
|
||||||
// Start wake listener in background — triggers immediate syncs on demand.
|
// Start the realtime downlink in background — pushes immediate syncs +
|
||||||
go sc.runWakeListener(ctx)
|
// typed control commands on demand (SSE-first, long-poll fallback).
|
||||||
|
go sc.runDownlink(ctx)
|
||||||
|
|
||||||
// Initial sync immediately
|
// Initial sync immediately
|
||||||
sc.doSync(ctx)
|
sc.doSync(ctx)
|
||||||
|
|
@ -146,6 +175,7 @@ func (sc *SyncClient) buildRequest() SyncRequest {
|
||||||
LanIP: sc.cfg.LanIP,
|
LanIP: sc.cfg.LanIP,
|
||||||
TailscaleIP: sc.cfg.TailscaleIP,
|
TailscaleIP: sc.cfg.TailscaleIP,
|
||||||
CanDelete: sc.cfg.CanDelete,
|
CanDelete: sc.cfg.CanDelete,
|
||||||
|
IsDocker: RunningInDocker(),
|
||||||
}
|
}
|
||||||
if sc.GetTaskStates != nil {
|
if sc.GetTaskStates != nil {
|
||||||
req.Tasks = sc.GetTaskStates()
|
req.Tasks = sc.GetTaskStates()
|
||||||
|
|
@ -162,6 +192,9 @@ func (sc *SyncClient) buildRequest() SyncRequest {
|
||||||
if sc.GetVPNState != nil {
|
if sc.GetVPNState != nil {
|
||||||
req.VPNActive, req.VPNMode, req.VPNServer = sc.GetVPNState()
|
req.VPNActive, req.VPNMode, req.VPNServer = sc.GetVPNState()
|
||||||
}
|
}
|
||||||
|
if sc.GetFunnelURL != nil {
|
||||||
|
req.FunnelURL = sc.GetFunnelURL()
|
||||||
|
}
|
||||||
// Flush confirmed deletions from previous cycle.
|
// Flush confirmed deletions from previous cycle.
|
||||||
// Once flushed, remove IDs from deleteInFlight — the server will stop sending
|
// Once flushed, remove IDs from deleteInFlight — the server will stop sending
|
||||||
// them after this sync, so deduplication protection is no longer needed.
|
// them after this sync, so deduplication protection is no longer needed.
|
||||||
|
|
@ -278,6 +311,176 @@ func (sc *SyncClient) runWakeListener(ctx context.Context) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// runWakeListenerFor runs the long-poll wake listener for up to `dur`, then
|
||||||
|
// returns so the caller can re-probe SSE. Used as the auto-mode fallback.
|
||||||
|
func (sc *SyncClient) runWakeListenerFor(ctx context.Context, dur time.Duration) {
|
||||||
|
childCtx, cancel := context.WithTimeout(ctx, dur)
|
||||||
|
defer cancel()
|
||||||
|
sc.runWakeListener(childCtx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// downlinkMode resolves the configured downlink transport:
|
||||||
|
// - "auto" (default): SSE-first, fall back to long-poll wake if SSE is
|
||||||
|
// unavailable or silently buffered, then periodically re-probe SSE.
|
||||||
|
// - "sse": SSE only, no long-poll fallback (testing / known-good networks).
|
||||||
|
// - "poll": long-poll wake only (the pre-0.14 behavior).
|
||||||
|
func (sc *SyncClient) downlinkMode() string {
|
||||||
|
switch strings.ToLower(strings.TrimSpace(sc.cfg.Downlink)) {
|
||||||
|
case "poll":
|
||||||
|
return "poll"
|
||||||
|
case "sse":
|
||||||
|
return "sse"
|
||||||
|
default:
|
||||||
|
return "auto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runDownlink is the server→agent realtime loop. It supersedes the bare
|
||||||
|
// long-poll wake listener: an SSE connection pushes typed control commands and
|
||||||
|
// sync nudges over a single persistent connection, with the long-poll wake as a
|
||||||
|
// buffering-tolerant fallback (long-poll survives proxies that buffer the
|
||||||
|
// response body and break SSE). Runs until ctx is cancelled.
|
||||||
|
func (sc *SyncClient) runDownlink(ctx context.Context) {
|
||||||
|
switch sc.downlinkMode() {
|
||||||
|
case "poll":
|
||||||
|
log.Printf("downlink: long-poll wake (downlink=poll)")
|
||||||
|
sc.runWakeListener(ctx)
|
||||||
|
case "sse":
|
||||||
|
log.Printf("downlink: SSE only (downlink=sse) — no long-poll fallback")
|
||||||
|
sc.runSSELoop(ctx, false)
|
||||||
|
default:
|
||||||
|
sc.runSSELoop(ctx, true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runSSELoop maintains the SSE downlink, reconnecting across server recycles
|
||||||
|
// and transient drops. When allowFallback is true (auto mode), it switches to
|
||||||
|
// the long-poll wake after maxSSEFailures consecutive dead attempts, then
|
||||||
|
// re-probes SSE after downlinkFallbackWindow.
|
||||||
|
func (sc *SyncClient) runSSELoop(ctx context.Context, allowFallback bool) {
|
||||||
|
failures := 0
|
||||||
|
for ctx.Err() == nil {
|
||||||
|
healthy := sc.runEventStreamOnce(ctx)
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if healthy {
|
||||||
|
failures = 0
|
||||||
|
// A healthy stream that ended is a normal server recycle — reconnect.
|
||||||
|
sc.sleep(ctx, sseReconnectDelay)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
failures++
|
||||||
|
if allowFallback && failures >= maxSSEFailures {
|
||||||
|
log.Printf("downlink: SSE unavailable after %d attempts — falling back to long-poll for %s", failures, downlinkFallbackWindow)
|
||||||
|
sc.runWakeListenerFor(ctx, downlinkFallbackWindow)
|
||||||
|
failures = 0
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
sc.sleep(ctx, sseReconnectDelay)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runEventStreamOnce opens one SSE connection and consumes it until it dies or
|
||||||
|
// ctx is cancelled. Returns true if the stream was "healthy" — i.e. it
|
||||||
|
// delivered at least one frame (event or heartbeat) — and false if it failed to
|
||||||
|
// connect or delivered nothing within downlinkLivenessTimeout (dead or silently
|
||||||
|
// buffered). The caller uses that signal to decide whether to fall back.
|
||||||
|
func (sc *SyncClient) runEventStreamOnce(ctx context.Context) bool {
|
||||||
|
streamCtx, cancel := context.WithCancel(ctx)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
stream, err := sc.client.OpenEventStream(streamCtx)
|
||||||
|
if err != nil {
|
||||||
|
if ctx.Err() == nil {
|
||||||
|
log.Printf("downlink: SSE connect failed: %v", err)
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
defer stream.Close()
|
||||||
|
|
||||||
|
healthy := false
|
||||||
|
liveness := time.NewTimer(sc.livenessTimeout)
|
||||||
|
defer liveness.Stop()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return healthy
|
||||||
|
case <-liveness.C:
|
||||||
|
// No frame within the deadline. The server heartbeats every ~15s, so
|
||||||
|
// silence past livenessTimeout (40s) means the path is dead OR
|
||||||
|
// silently buffering — INCLUDING a proxy that flushed the connect
|
||||||
|
// preamble (one ping) then stalled. Return false REGARDLESS of any
|
||||||
|
// earlier frame, so this counts toward the long-poll fallback; a
|
||||||
|
// stream that flushes one ping and goes quiet must not be treated as
|
||||||
|
// healthy or the fallback never triggers for partial bufferers.
|
||||||
|
if ctx.Err() == nil {
|
||||||
|
log.Printf("downlink: no SSE frame within %s — dropping (dead or buffered path)", sc.livenessTimeout)
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
case ev, ok := <-stream.Events():
|
||||||
|
if !ok {
|
||||||
|
if e := stream.Err(); e != nil && ctx.Err() == nil {
|
||||||
|
log.Printf("downlink: SSE stream ended: %v", e)
|
||||||
|
}
|
||||||
|
return healthy
|
||||||
|
}
|
||||||
|
if !healthy {
|
||||||
|
// First frame on this connection — the path flushes, so log once
|
||||||
|
// (on a silently-buffered path no frame ever arrives and we never
|
||||||
|
// claim connected).
|
||||||
|
log.Printf("downlink: SSE connected")
|
||||||
|
}
|
||||||
|
healthy = true
|
||||||
|
if !liveness.Stop() {
|
||||||
|
select {
|
||||||
|
case <-liveness.C:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
liveness.Reset(sc.livenessTimeout)
|
||||||
|
sc.handleDownlinkEvent(ev)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleDownlinkEvent applies one pushed downlink event. Pings are liveness-only;
|
||||||
|
// "sync" nudges an immediate full sync; "command" carries typed control actions
|
||||||
|
// applied via the same OnControl callback /agent/sync uses (idempotent, so the
|
||||||
|
// authoritative sync re-delivering them is harmless).
|
||||||
|
func (sc *SyncClient) handleDownlinkEvent(ev DownlinkEvent) {
|
||||||
|
switch ev.Event {
|
||||||
|
case DownlinkEventPing:
|
||||||
|
// Liveness only.
|
||||||
|
case DownlinkEventSync:
|
||||||
|
sc.TriggerSync()
|
||||||
|
case DownlinkEventCommand:
|
||||||
|
var cmd CommandEvent
|
||||||
|
if err := json.Unmarshal(ev.Data, &cmd); err != nil {
|
||||||
|
log.Printf("downlink: bad command payload: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, ctrl := range cmd.Controls {
|
||||||
|
log.Printf("downlink: control %s on task %s", ctrl.Action, ShortID(ctrl.TaskID))
|
||||||
|
if sc.OnControl != nil {
|
||||||
|
sc.OnControl(ctrl.Action, ctrl.TaskID, ctrl.DeleteFiles)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
// Unknown event from a newer server — ignore forward-compatibly.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sleep blocks for d or until ctx is cancelled.
|
||||||
|
func (sc *SyncClient) sleep(ctx context.Context, d time.Duration) {
|
||||||
|
select {
|
||||||
|
case <-time.After(d):
|
||||||
|
case <-ctx.Done():
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (sc *SyncClient) adjustInterval(watching bool) {
|
func (sc *SyncClient) adjustInterval(watching bool) {
|
||||||
prev := sc.watching.Load()
|
prev := sc.watching.Load()
|
||||||
sc.watching.Store(watching)
|
sc.watching.Store(watching)
|
||||||
|
|
|
||||||
|
|
@ -18,6 +18,11 @@ type RegisterRequest struct {
|
||||||
StreamPort int `json:"streamPort,omitempty"`
|
StreamPort int `json:"streamPort,omitempty"`
|
||||||
LanIP string `json:"lanIp,omitempty"`
|
LanIP string `json:"lanIp,omitempty"`
|
||||||
TailscaleIP string `json:"tailscaleIp,omitempty"`
|
TailscaleIP string `json:"tailscaleIp,omitempty"`
|
||||||
|
// StreamSecret is the daemon's per-run HMAC key (hex) for stream tokens. The
|
||||||
|
// web mints the HLS path token with it (the agent mints /stream tokens on its
|
||||||
|
// own URLs); the agent verifies both. In memory, regenerated each start, so a
|
||||||
|
// fresh register after restart re-syncs it.
|
||||||
|
StreamSecret string `json:"streamSecret,omitempty"`
|
||||||
// Transcode capabilities — let the web side suggest a smarter quality
|
// Transcode capabilities — let the web side suggest a smarter quality
|
||||||
// before the player even starts. HWAccel is the picked backend
|
// before the player even starts. HWAccel is the picked backend
|
||||||
// ("nvenc"/"qsv"/"vaapi"/"videotoolbox"/"none"). MaxTranscodeHeight is
|
// ("nvenc"/"qsv"/"vaapi"/"videotoolbox"/"none"). MaxTranscodeHeight is
|
||||||
|
|
@ -26,6 +31,15 @@ type RegisterRequest struct {
|
||||||
// up to 2160p.
|
// up to 2160p.
|
||||||
HWAccel string `json:"hwAccel,omitempty"`
|
HWAccel string `json:"hwAccel,omitempty"`
|
||||||
MaxTranscodeHeight int `json:"maxTranscodeHeight,omitempty"`
|
MaxTranscodeHeight int `json:"maxTranscodeHeight,omitempty"`
|
||||||
|
// Diagnostic surface filled by engine.DetectHWAccelDiagnostic at daemon
|
||||||
|
// start. Surfaced in the web "Diagnose transcoder" modal so users can
|
||||||
|
// see *why* their HWAccel landed on "none" without running
|
||||||
|
// `unarr probe-hwaccel` locally — most commonly the ffmpeg binary
|
||||||
|
// shipped without HW encoders (linuxbrew, brew's default formula).
|
||||||
|
FFmpegVersion string `json:"ffmpegVersion,omitempty"`
|
||||||
|
FFmpegPath string `json:"ffmpegPath,omitempty"`
|
||||||
|
HWEncoders []string `json:"hwEncoders,omitempty"`
|
||||||
|
HWDevices []string `json:"hwDevices,omitempty"`
|
||||||
// Managed-VPN split-tunnel state. The web tracks which agent holds the single
|
// Managed-VPN split-tunnel state. The web tracks which agent holds the single
|
||||||
// WireGuard slot (1 VPNResellers account = 1 WG keypair = 1 concurrent
|
// WireGuard slot (1 VPNResellers account = 1 WG keypair = 1 concurrent
|
||||||
// connection); other agents are told to use OpenVPN on their host instead.
|
// connection); other agents are told to use OpenVPN on their host instead.
|
||||||
|
|
@ -34,6 +48,14 @@ type RegisterRequest struct {
|
||||||
VPNActive bool `json:"vpnActive"`
|
VPNActive bool `json:"vpnActive"`
|
||||||
VPNMode string `json:"vpnMode,omitempty"` // managed | self-hosted
|
VPNMode string `json:"vpnMode,omitempty"` // managed | self-hosted
|
||||||
VPNServer string `json:"vpnServer,omitempty"`
|
VPNServer string `json:"vpnServer,omitempty"`
|
||||||
|
// CloudFlare Quick Tunnel hostname when enabled; the web prefers it over
|
||||||
|
// Tailscale/LAN for in-browser playback because it works on any network.
|
||||||
|
FunnelURL string `json:"funnelUrl,omitempty"`
|
||||||
|
// IsDocker tells the web the agent runs inside a container, so it shows a
|
||||||
|
// `docker pull` command instead of the in-app update button (the binary
|
||||||
|
// self-update refuses to run in Docker). No omitempty: false (a binary
|
||||||
|
// install) is a meaningful state the server must see to keep the button.
|
||||||
|
IsDocker bool `json:"isDocker"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// RegisterResponse is returned by the server after registration.
|
// RegisterResponse is returned by the server after registration.
|
||||||
|
|
@ -117,6 +139,11 @@ type StatusUpdate struct {
|
||||||
StreamURL string `json:"streamUrl,omitempty"`
|
StreamURL string `json:"streamUrl,omitempty"`
|
||||||
StreamReady bool `json:"streamReady,omitempty"`
|
StreamReady bool `json:"streamReady,omitempty"`
|
||||||
ErrorMessage string `json:"errorMessage,omitempty"`
|
ErrorMessage string `json:"errorMessage,omitempty"`
|
||||||
|
// StreamError reports a failed /stream attempt (path rejected, transient
|
||||||
|
// FS error, etc.) WITHOUT marking the download itself failed — the web
|
||||||
|
// clears streamRequested + surfaces this so the player fails fast with the
|
||||||
|
// real reason instead of a 20s "agent didn't respond" timeout.
|
||||||
|
StreamError string `json:"streamError,omitempty"`
|
||||||
// mode=seed_file: agent computes the info_hash from the local file
|
// mode=seed_file: agent computes the info_hash from the local file
|
||||||
// and reports it back so the web player can target /stream/<hash>.
|
// and reports it back so the web player can target /stream/<hash>.
|
||||||
InfoHash string `json:"infoHash,omitempty"`
|
InfoHash string `json:"infoHash,omitempty"`
|
||||||
|
|
@ -296,6 +323,7 @@ type DebridAccount struct {
|
||||||
type LibrarySyncRequest struct {
|
type LibrarySyncRequest struct {
|
||||||
Items []LibrarySyncItem `json:"items"`
|
Items []LibrarySyncItem `json:"items"`
|
||||||
ScanPath string `json:"scanPath"`
|
ScanPath string `json:"scanPath"`
|
||||||
|
AgentID string `json:"agentId,omitempty"` // lets the server scope stale-cleanup per agent
|
||||||
IsLastBatch bool `json:"isLastBatch"`
|
IsLastBatch bool `json:"isLastBatch"`
|
||||||
SyncStartedAt string `json:"syncStartedAt,omitempty"` // ISO-8601; same for all batches in a session
|
SyncStartedAt string `json:"syncStartedAt,omitempty"` // ISO-8601; same for all batches in a session
|
||||||
}
|
}
|
||||||
|
|
@ -321,6 +349,17 @@ type LibrarySyncItem struct {
|
||||||
AudioTracks any `json:"audioTracks,omitempty"`
|
AudioTracks any `json:"audioTracks,omitempty"`
|
||||||
SubtitleTracks any `json:"subtitleTracks,omitempty"`
|
SubtitleTracks any `json:"subtitleTracks,omitempty"`
|
||||||
VideoInfo any `json:"videoInfo,omitempty"`
|
VideoInfo any `json:"videoInfo,omitempty"`
|
||||||
|
// Integrity flags a damaged / incompletely-downloaded file ("damaged" or
|
||||||
|
// empty). IntegrityReason is a stable code (ebml_corrupt, moov_missing,
|
||||||
|
// no_duration, …) the web maps to a localized "re-download" message.
|
||||||
|
Integrity string `json:"integrity,omitempty"`
|
||||||
|
IntegrityReason string `json:"integrityReason,omitempty"`
|
||||||
|
// Path resilience: a stable content identity + the file's location relative
|
||||||
|
// to its library root, so the server can move a row in place on a rename /
|
||||||
|
// base-path change instead of duplicating it.
|
||||||
|
Fingerprint string `json:"fingerprint,omitempty"`
|
||||||
|
RelPath string `json:"relPath,omitempty"`
|
||||||
|
LibraryRootKey string `json:"libraryRootKey,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// LibrarySyncResponse is returned after syncing library items.
|
// LibrarySyncResponse is returned after syncing library items.
|
||||||
|
|
@ -359,6 +398,11 @@ type SyncRequest struct {
|
||||||
VPNActive bool `json:"vpnActive"`
|
VPNActive bool `json:"vpnActive"`
|
||||||
VPNMode string `json:"vpnMode,omitempty"`
|
VPNMode string `json:"vpnMode,omitempty"`
|
||||||
VPNServer string `json:"vpnServer,omitempty"`
|
VPNServer string `json:"vpnServer,omitempty"`
|
||||||
|
// CloudFlare Quick Tunnel hostname when enabled, else empty.
|
||||||
|
FunnelURL string `json:"funnelUrl,omitempty"`
|
||||||
|
// IsDocker — see RegisterRequest.IsDocker. Sent every sync so the web keeps
|
||||||
|
// the flag fresh even if the agent migrated binary↔docker between restarts.
|
||||||
|
IsDocker bool `json:"isDocker"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ControlAction represents a server-side control signal for a task.
|
// ControlAction represents a server-side control signal for a task.
|
||||||
|
|
@ -379,18 +423,42 @@ type LibraryDeleteRequest struct {
|
||||||
// HLS registry; source bytes come from FilePath (or, when only InfoHash is
|
// HLS registry; source bytes come from FilePath (or, when only InfoHash is
|
||||||
// set, from a download_task on disk).
|
// set, from a download_task on disk).
|
||||||
type StreamSession struct {
|
type StreamSession struct {
|
||||||
SessionID string `json:"sessionId"`
|
SessionID string `json:"sessionId"`
|
||||||
FilePath string `json:"filePath,omitempty"`
|
FilePath string `json:"filePath,omitempty"`
|
||||||
InfoHash string `json:"infoHash,omitempty"`
|
InfoHash string `json:"infoHash,omitempty"`
|
||||||
TaskID string `json:"taskId,omitempty"`
|
TaskID string `json:"taskId,omitempty"`
|
||||||
FileName string `json:"fileName,omitempty"`
|
FileName string `json:"fileName,omitempty"`
|
||||||
FileSize int64 `json:"fileSize,omitempty"`
|
FileSize int64 `json:"fileSize,omitempty"`
|
||||||
// Quality target the daemon should aim for when transcoding. One of
|
// Quality target the daemon should aim for when transcoding. One of
|
||||||
// "2160p" | "1080p" | "720p" | "480p" | "original" | "" (defer to config).
|
// "2160p" | "1080p" | "720p" | "480p" | "original" | "" (defer to config).
|
||||||
Quality string `json:"quality,omitempty"`
|
Quality string `json:"quality,omitempty"`
|
||||||
// AudioIndex selects the source audio track (-map 0:a:N). -1 means
|
// AudioIndex selects the source audio track (-map 0:a:N). -1 means
|
||||||
// "use the default/first track".
|
// "use the default/first track".
|
||||||
AudioIndex int `json:"audioIndex,omitempty"`
|
AudioIndex int `json:"audioIndex,omitempty"`
|
||||||
|
// BurnSubtitleIndex, when set, is the 0-based subtitle stream index
|
||||||
|
// (-map 0:s:N) of a BITMAP subtitle (PGS/DVB) to burn into the video. Text
|
||||||
|
// subtitles are served as separate WebVTT tracks and never burned. A pointer
|
||||||
|
// (not int) so absent/null = "no burn": the zero value 0 is a valid track
|
||||||
|
// index, so an int sentinel would silently burn track 0 when the field is
|
||||||
|
// omitted. Forces a full video re-encode (the overlay can't ride a copy
|
||||||
|
// path), so the web only sends it when the user picks a bitmap sub.
|
||||||
|
BurnSubtitleIndex *int `json:"burnSubtitleIndex,omitempty"`
|
||||||
|
// PlayMethod is how the daemon should serve this session:
|
||||||
|
// "" — default (HLS transcode); also what legacy servers send.
|
||||||
|
// "direct" — the source is already browser-native (the web decided this
|
||||||
|
// from library scan metadata + an agent-version gate). Serve
|
||||||
|
// the raw file over /stream (HTTP Range, no ffmpeg) instead of
|
||||||
|
// transcoding to HLS. See hueco #3 phase 3a in the roadmap.
|
||||||
|
PlayMethod string `json:"playMethod,omitempty"`
|
||||||
|
// DirectURL, when set, is an HTTPS link to the media resolved server-side
|
||||||
|
// from the user's debrid account (hueco #2 / 2a). The source has no local
|
||||||
|
// file: the daemon streams /stream from this URL via ranged GETs
|
||||||
|
// (debridFileProvider) instead of from disk/torrent. Carries the "play
|
||||||
|
// instantáneo cache-fast" promise — the web only sets it when the hash is
|
||||||
|
// confirmed debrid-cached and the container is browser-native (mp4/m4v),
|
||||||
|
// and gates it on an agent-version floor so older daemons never receive a
|
||||||
|
// field they can't serve. Takes priority over FilePath when present.
|
||||||
|
DirectURL string `json:"directUrl,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SyncResponse is returned by the server with all pending actions for the CLI.
|
// SyncResponse is returned by the server with all pending actions for the CLI.
|
||||||
|
|
|
||||||
|
|
@ -322,6 +322,14 @@ func configLibrary(cfg *config.Config) error {
|
||||||
Title("Allow file deletion from web UI?").
|
Title("Allow file deletion from web UI?").
|
||||||
Description("When enabled, the web library's Delete button can permanently remove files from disk.\nOnly activate this if you understand that deleted files cannot be recovered.").
|
Description("When enabled, the web library's Delete button can permanently remove files from disk.\nOnly activate this if you understand that deleted files cannot be recovered.").
|
||||||
Value(&cfg.Library.AllowDelete),
|
Value(&cfg.Library.AllowDelete),
|
||||||
|
huh.NewConfirm().
|
||||||
|
Title("Cache subtitles during scan?").
|
||||||
|
Description("Extract embedded text subtitles to WebVTT once during the scan and store them\nbeside the media (hidden .unarr dir) so playback subtitles are instant — and huge\nremuxes don't time out extracting on demand. Local only; nothing is uploaded.").
|
||||||
|
Value(&cfg.Library.CacheSubtitles),
|
||||||
|
huh.NewConfirm().
|
||||||
|
Title("Cache thumbnails during scan?").
|
||||||
|
Description("Pre-extract a few preview frames per file (hidden .unarr dir) so the file panel\nand seekbar previews load instantly. Small optimized JPEGs; local only.").
|
||||||
|
Value(&cfg.Library.CacheThumbnails),
|
||||||
),
|
),
|
||||||
).Run()
|
).Run()
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,7 @@ import (
|
||||||
"github.com/torrentclaw/unarr/internal/agent"
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
"github.com/torrentclaw/unarr/internal/config"
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
"github.com/torrentclaw/unarr/internal/engine"
|
"github.com/torrentclaw/unarr/internal/engine"
|
||||||
|
"github.com/torrentclaw/unarr/internal/funnel"
|
||||||
"github.com/torrentclaw/unarr/internal/library"
|
"github.com/torrentclaw/unarr/internal/library"
|
||||||
"github.com/torrentclaw/unarr/internal/library/mediainfo"
|
"github.com/torrentclaw/unarr/internal/library/mediainfo"
|
||||||
"github.com/torrentclaw/unarr/internal/usenet/download"
|
"github.com/torrentclaw/unarr/internal/usenet/download"
|
||||||
|
|
@ -142,10 +143,42 @@ func runDaemonStart() error {
|
||||||
// is what the web side uses to decide whether the user should pre-empt
|
// is what the web side uses to decide whether the user should pre-empt
|
||||||
// transcoding by downloading a smaller version (4K source on a software
|
// transcoding by downloading a smaller version (4K source on a software
|
||||||
// libx264-only host is the canonical case where pre-download wins).
|
// libx264-only host is the canonical case where pre-download wins).
|
||||||
hwAccelPick := engine.DetectHWAccel(context.Background(), cfg.Library.FFmpegPath)
|
//
|
||||||
maxTranscodeHeight := 1080
|
// Use the full diagnostic (encoders + devices + ffmpeg version) instead
|
||||||
if hwAccelPick != engine.HWAccelNone {
|
// of just the picked backend — the extra fields ride along in the
|
||||||
maxTranscodeHeight = 2160
|
// register payload so the web "Diagnose transcoder" modal can show *why*
|
||||||
|
// libx264 was selected on a host with a GPU (e.g. brew's ffmpeg without
|
||||||
|
// --enable-nvenc). 10 s ceiling so a hung ffmpeg binary can't stall
|
||||||
|
// startup forever.
|
||||||
|
ffmpegResolved, _ := mediainfo.ResolveFFmpeg(cfg.Library.FFmpegPath)
|
||||||
|
probeCtx, probeCancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer probeCancel() // guard against a panic inside DetectHWAccelDiagnostic
|
||||||
|
hwDiag := engine.DetectHWAccelDiagnostic(probeCtx, ffmpegResolved)
|
||||||
|
log.Println(hwDiag.LogLine())
|
||||||
|
hwAccelPick := hwDiag.Pick
|
||||||
|
// Measure the real transcode ceiling instead of guessing from the backend.
|
||||||
|
// HW encoders return 2160 instantly; a software-only host runs a bounded
|
||||||
|
// encode benchmark so a weak NAS/CPU reports the rung it can actually
|
||||||
|
// sustain (720/480) and the web side routes oversized sources to an
|
||||||
|
// external player instead of a stuttering transcode. This blocks
|
||||||
|
// registration on a software host, so it's bounded tight (3 rungs × 6 s =
|
||||||
|
// 18 s worst case; <1 s on a capable box that passes the first rung). Own
|
||||||
|
// timeout — the 10 s probeCtx above is sized for the quick diagnostic.
|
||||||
|
benchCtx, benchCancel := context.WithTimeout(context.Background(), 20*time.Second)
|
||||||
|
maxTranscodeHeight := engine.BenchmarkMaxTranscodeHeight(benchCtx, ffmpegResolved, hwAccelPick)
|
||||||
|
benchCancel()
|
||||||
|
|
||||||
|
// Warm the tonemap capability caches off the hot path. The libplacebo probe
|
||||||
|
// actually RUNS the filter (Vulkan device init ~1.7 s), so doing it lazily
|
||||||
|
// in buildTranscodeRuntime would tax the FIRST stream session and risk its
|
||||||
|
// setup timeout. A real session arrives seconds-to-minutes after startup, so
|
||||||
|
// a background warm has finished by then; if one races in first, the cache's
|
||||||
|
// own mutex makes the concurrent cold call safe (both compute the same bool).
|
||||||
|
if cfg.Download.Transcode.Enabled && ffmpegResolved != "" {
|
||||||
|
go func() {
|
||||||
|
engine.FFmpegSupportsLibplacebo(ffmpegResolved)
|
||||||
|
engine.FFmpegSupportsZscale(ffmpegResolved)
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create daemon config
|
// Create daemon config
|
||||||
|
|
@ -161,6 +194,12 @@ func runDaemonStart() error {
|
||||||
ScanPaths: library.ResolveScanPaths(cfg.Download.Dir, cfg.Organize.MoviesDir, cfg.Organize.TVShowsDir, cfg.Library.ScanPath),
|
ScanPaths: library.ResolveScanPaths(cfg.Download.Dir, cfg.Organize.MoviesDir, cfg.Organize.TVShowsDir, cfg.Library.ScanPath),
|
||||||
HWAccel: string(hwAccelPick),
|
HWAccel: string(hwAccelPick),
|
||||||
MaxTranscodeHeight: maxTranscodeHeight,
|
MaxTranscodeHeight: maxTranscodeHeight,
|
||||||
|
FFmpegVersion: hwDiag.FFmpegVersion,
|
||||||
|
FFmpegPath: hwDiag.FFmpegPath,
|
||||||
|
HWEncoders: hwDiag.Encoders,
|
||||||
|
HWDevices: hwDiag.Devices,
|
||||||
|
AutoUpgrade: cfg.Daemon.AutoUpgradeEnabled(),
|
||||||
|
Downlink: cfg.Daemon.Downlink,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create HTTP client with mirror failover so a `.com` block-out rolls
|
// Create HTTP client with mirror failover so a `.com` block-out rolls
|
||||||
|
|
@ -186,6 +225,9 @@ func runDaemonStart() error {
|
||||||
metaTimeout, _ := time.ParseDuration(cfg.Download.MetadataTimeout)
|
metaTimeout, _ := time.ParseDuration(cfg.Download.MetadataTimeout)
|
||||||
stallTimeout, _ := time.ParseDuration(cfg.Download.StallTimeout)
|
stallTimeout, _ := time.ParseDuration(cfg.Download.StallTimeout)
|
||||||
|
|
||||||
|
// Parse the seeding time target (0/"" = no time target — ratio-only or forever)
|
||||||
|
seedTime, _ := time.ParseDuration(cfg.Download.SeedTime)
|
||||||
|
|
||||||
// Create progress reporter — only used for stream tasks (handleStreamTask)
|
// Create progress reporter — only used for stream tasks (handleStreamTask)
|
||||||
// The sync goroutine handles all regular progress reporting.
|
// The sync goroutine handles all regular progress reporting.
|
||||||
statusInterval, _ := time.ParseDuration(cfg.Daemon.StatusInterval)
|
statusInterval, _ := time.ParseDuration(cfg.Daemon.StatusInterval)
|
||||||
|
|
@ -247,15 +289,18 @@ func runDaemonStart() error {
|
||||||
|
|
||||||
// Create torrent downloader
|
// Create torrent downloader
|
||||||
torrentDl, err := engine.NewTorrentDownloader(engine.TorrentConfig{
|
torrentDl, err := engine.NewTorrentDownloader(engine.TorrentConfig{
|
||||||
DataDir: cfg.Download.Dir,
|
DataDir: cfg.Download.Dir,
|
||||||
MetadataTimeout: metaTimeout,
|
PieceCompletionDir: config.DataDir(), // keep piece-completion DB off NFS/SMB mounts
|
||||||
StallTimeout: stallTimeout,
|
MetadataTimeout: metaTimeout,
|
||||||
MaxTimeout: 0,
|
StallTimeout: stallTimeout,
|
||||||
MaxDownloadRate: maxDl,
|
MaxTimeout: 0,
|
||||||
MaxUploadRate: maxUl,
|
MaxDownloadRate: maxDl,
|
||||||
ListenPort: cfg.Download.ListenPort,
|
MaxUploadRate: maxUl,
|
||||||
SeedEnabled: false,
|
ListenPort: cfg.Download.ListenPort,
|
||||||
VPNTunnel: vpnTunnel,
|
SeedEnabled: cfg.Download.SeedEnabled,
|
||||||
|
SeedRatio: cfg.Download.SeedRatio,
|
||||||
|
SeedTime: seedTime,
|
||||||
|
VPNTunnel: vpnTunnel,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("create torrent downloader: %w", err)
|
return fmt.Errorf("create torrent downloader: %w", err)
|
||||||
|
|
@ -272,8 +317,30 @@ func runDaemonStart() error {
|
||||||
log.Printf("Speed limits: download=%s upload=%s", dlStr, ulStr)
|
log.Printf("Speed limits: download=%s upload=%s", dlStr, ulStr)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if cfg.Download.SeedEnabled {
|
||||||
|
switch {
|
||||||
|
case cfg.Download.SeedRatio > 0 && seedTime > 0:
|
||||||
|
log.Printf("[torrent] seeding enabled (stop at ratio %.2f or %s, whichever first)", cfg.Download.SeedRatio, seedTime)
|
||||||
|
case cfg.Download.SeedRatio > 0:
|
||||||
|
log.Printf("[torrent] seeding enabled (stop at ratio %.2f)", cfg.Download.SeedRatio)
|
||||||
|
case seedTime > 0:
|
||||||
|
log.Printf("[torrent] seeding enabled (stop after %s)", seedTime)
|
||||||
|
default:
|
||||||
|
log.Printf("[torrent] seeding enabled (no ratio/time target — seeds until shutdown)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Create debrid downloader
|
// Create debrid downloader
|
||||||
debridDl := engine.NewDebridDownloader()
|
debridDl := engine.NewDebridDownloader()
|
||||||
|
usenetDl := engine.NewUsenetDownloader(agentClient)
|
||||||
|
|
||||||
|
// Pre-flight disk reserve: refuse a download that would leave less than this
|
||||||
|
// many bytes free, so a download never fills the filesystem to 0 mid-write.
|
||||||
|
minFreeBytes := int64(cfg.Download.MinFreeDiskMB) << 20
|
||||||
|
torrentDl.SetMinFreeBytes(minFreeBytes)
|
||||||
|
debridDl.SetMinFreeBytes(minFreeBytes)
|
||||||
|
usenetDl.SetMinFreeBytes(minFreeBytes)
|
||||||
|
log.Printf("[disk] download free-space reserve: %d MiB", cfg.Download.MinFreeDiskMB)
|
||||||
|
|
||||||
// Create download manager
|
// Create download manager
|
||||||
manager := engine.NewManager(engine.ManagerConfig{
|
manager := engine.NewManager(engine.ManagerConfig{
|
||||||
|
|
@ -286,23 +353,111 @@ func runDaemonStart() error {
|
||||||
TVShowsDir: cfg.Organize.TVShowsDir,
|
TVShowsDir: cfg.Organize.TVShowsDir,
|
||||||
OutputDir: cfg.Download.Dir,
|
OutputDir: cfg.Download.Dir,
|
||||||
},
|
},
|
||||||
}, reporter, torrentDl, debridDl, engine.NewUsenetDownloader(agentClient))
|
}, reporter, torrentDl, debridDl, usenetDl)
|
||||||
|
|
||||||
|
// Resume store: persist in-flight downloads so a daemon restart can re-submit
|
||||||
|
// them (the downloaders resume the partial data). Wire it before any Submit.
|
||||||
|
taskStore := agent.NewActiveTaskStore()
|
||||||
|
manager.SetTaskStore(taskStore)
|
||||||
|
|
||||||
// Create persistent stream server
|
// Create persistent stream server
|
||||||
streamSrv := engine.NewStreamServer(cfg.Download.StreamPort)
|
streamSrv := engine.NewStreamServer(cfg.Download.StreamPort)
|
||||||
streamSrv.SetUPnPEnabled(cfg.Download.EnableUPnP)
|
streamSrv.SetUPnPEnabled(cfg.Download.EnableUPnP)
|
||||||
streamSrv.SetCORSAllowedOrigins(cfg.Download.CORSExtraOrigins)
|
// Wire ffmpeg so /thumbnail can extract single frames for the web's "file
|
||||||
|
// characteristics" panel (frames on demand). Empty = thumbnails 503.
|
||||||
|
streamSrv.SetFFmpegPath(ffmpegResolved)
|
||||||
|
// Write-through cache extracted WebVTT into the hidden ".unarr" sidecar dir so
|
||||||
|
// /sub serves instantly (and giant remuxes that exceed the on-demand timeout
|
||||||
|
// work once the scan prewarm has filled the cache). Default true.
|
||||||
|
streamSrv.SetCacheSubtitles(cfg.Library.CacheSubtitles)
|
||||||
|
streamSrv.SetCacheThumbnails(cfg.Library.CacheThumbnails)
|
||||||
|
// Tell /trickplay which tile width the scan prewarm built the sprite at (the
|
||||||
|
// agent owns the width; the web requests by path only). 0 = disabled → 404.
|
||||||
|
trickW := 0
|
||||||
|
if cfg.Library.Trickplay.Enabled {
|
||||||
|
if trickW = cfg.Library.Trickplay.Width; trickW <= 0 {
|
||||||
|
trickW = 240
|
||||||
|
}
|
||||||
|
}
|
||||||
|
streamSrv.SetTrickplayWidth(trickW)
|
||||||
|
streamSrv.SetRequireStreamToken(cfg.Download.RequireStreamToken)
|
||||||
|
// Report the stream-token signing key ONLY when enforcing, so the web's
|
||||||
|
// "secret present → mint HLS token" signal accurately means "this agent
|
||||||
|
// verifies tokens". Reporting it with enforcement off would make the web
|
||||||
|
// mint HLS path tokens the agent never peels → 404. Set before Register().
|
||||||
|
if cfg.Download.RequireStreamToken {
|
||||||
|
d.UpdateStreamSecret(streamSrv.StreamSecretHex())
|
||||||
|
}
|
||||||
|
// CORS extras = operator config + dynamic mirror list from /api/mirrors.
|
||||||
|
// Without the mirror merge, a user playing from `torrentclaw.to` (or any
|
||||||
|
// future mirror) hits the daemon, gets 200 + body, but no
|
||||||
|
// `Access-Control-Allow-Origin` → browser drops the response → player
|
||||||
|
// reports "404 todos los canales". Fetching /api/mirrors at startup
|
||||||
|
// future-proofs against mirror additions without a CLI rebuild.
|
||||||
|
corsExtras := append([]string(nil), cfg.Download.CORSExtraOrigins...)
|
||||||
|
corsExtras = append(corsExtras, mirrorCORSOrigins(ctx, cfg, userAgent)...)
|
||||||
|
streamSrv.SetCORSAllowedOrigins(corsExtras)
|
||||||
|
|
||||||
|
// HTTPS stream listener (agent-TLS feature): only armed when a certificate is
|
||||||
|
// present on disk — without a valid cert there is nothing to serve over TLS,
|
||||||
|
// and the HTTP listener + funnel keep working. The future ACME broker writes
|
||||||
|
// the cert pair to certs/agent.{crt,key} under the agent state dir.
|
||||||
|
if cfg.Download.HTTPSStreamPort > 0 {
|
||||||
|
certPath := filepath.Join(config.DataDir(), "certs", "agent.crt")
|
||||||
|
keyPath := filepath.Join(config.DataDir(), "certs", "agent.key")
|
||||||
|
if err := streamSrv.LoadTLSCertificateFromFiles(certPath, keyPath); err != nil {
|
||||||
|
log.Printf("[stream] HTTPS disabled — no usable certificate at %s (%v)", certPath, err)
|
||||||
|
} else {
|
||||||
|
streamSrv.EnableTLS(cfg.Download.HTTPSStreamPort)
|
||||||
|
log.Printf("[stream] HTTPS armed on port %d with certificate %s", cfg.Download.HTTPSStreamPort, certPath)
|
||||||
|
}
|
||||||
|
}
|
||||||
// Reap HLS tmpdirs left over from a previous daemon run before we start
|
// Reap HLS tmpdirs left over from a previous daemon run before we start
|
||||||
// accepting new sessions. The in-memory registry doesn't survive a
|
// accepting new sessions. The in-memory registry doesn't survive a
|
||||||
// restart, so without this disk usage grows unbounded across restarts.
|
// restart, so without this disk usage grows unbounded across restarts.
|
||||||
if err := engine.CleanupHLSOrphanDirs(); err != nil {
|
if err := engine.CleanupHLSOrphanDirs(); err != nil {
|
||||||
log.Printf("[hls] orphan tmpdir cleanup: %v", err)
|
log.Printf("[hls] orphan tmpdir cleanup: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Persistent HLS segment cache — survives across sessions so re-plays
|
||||||
|
// of the same file at the same quality skip ffmpeg entirely. Off when
|
||||||
|
// hls_cache.enabled = false; size cap from hls_cache.size_gb; path from
|
||||||
|
// hls_cache.dir (defaults to ~/.cache/unarr/hls-cache).
|
||||||
|
var hlsCache *engine.HLSCache
|
||||||
|
if cfg.Download.HLSCache.Enabled {
|
||||||
|
cacheDir := cfg.Download.HLSCache.Dir
|
||||||
|
if cacheDir == "" {
|
||||||
|
if base, err := os.UserCacheDir(); err == nil {
|
||||||
|
cacheDir = filepath.Join(base, "unarr", "hls-cache")
|
||||||
|
} else {
|
||||||
|
cacheDir = filepath.Join(os.TempDir(), "unarr-hls-cache")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c, err := engine.NewHLSCache(cacheDir, cfg.Download.HLSCache.SizeGB)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[hls_cache] init failed (%v) — falling back to per-session tmpdirs", err)
|
||||||
|
} else {
|
||||||
|
hlsCache = c
|
||||||
|
hlsCache.StartSweeper(ctx, time.Hour)
|
||||||
|
log.Printf("[hls_cache] enabled: dir=%s budget=%dGB", cacheDir, cfg.Download.HLSCache.SizeGB)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
log.Printf("[hls_cache] disabled by config — every play re-encodes from scratch")
|
||||||
|
}
|
||||||
if err := streamSrv.Listen(ctx); err != nil {
|
if err := streamSrv.Listen(ctx); err != nil {
|
||||||
return fmt.Errorf("start stream server: %w", err)
|
return fmt.Errorf("start stream server: %w", err)
|
||||||
}
|
}
|
||||||
d.UpdateStreamPort(streamSrv.Port())
|
d.UpdateStreamPort(streamSrv.Port())
|
||||||
|
|
||||||
|
// CloudFlare Quick Tunnel — needs the ACTUAL listening port (the
|
||||||
|
// configured port may have been busy and bumped). Spawning here ensures
|
||||||
|
// cloudflared --url points at the right socket. Failures degrade to
|
||||||
|
// Tailscale/LAN only; the supervisor keeps the tunnel up across CF's
|
||||||
|
// periodic rotation + transient cloudflared crashes.
|
||||||
|
if cfg.Download.Funnel.Enabled {
|
||||||
|
go superviseFunnel(ctx, d, streamSrv.Port())
|
||||||
|
}
|
||||||
|
|
||||||
// Warn at startup if transcode is enabled but ffmpeg/ffprobe are missing.
|
// Warn at startup if transcode is enabled but ffmpeg/ffprobe are missing.
|
||||||
// HLS sessions get rejected at runtime (see daemon.go ~line 455), but
|
// HLS sessions get rejected at runtime (see daemon.go ~line 455), but
|
||||||
// surfacing it here gives the operator a chance to install ffmpeg before
|
// surfacing it here gives the operator a chance to install ffmpeg before
|
||||||
|
|
@ -323,6 +478,10 @@ func runDaemonStart() error {
|
||||||
|
|
||||||
// Trigger immediate sync when a download slot frees up
|
// Trigger immediate sync when a download slot frees up
|
||||||
manager.OnTaskDone = func() { d.TriggerSync() }
|
manager.OnTaskDone = func() { d.TriggerSync() }
|
||||||
|
// Event-driven uplink: every status transition (resolving/downloading/
|
||||||
|
// verifying/organizing/…) pushes to the server right away instead of waiting
|
||||||
|
// for the next adaptive tick. Coalesced by TriggerSync's buffered-1 channel.
|
||||||
|
manager.OnStateChange = func() { d.TriggerSync() }
|
||||||
|
|
||||||
// Wire: sync receives new tasks → submit to manager or handle stream
|
// Wire: sync receives new tasks → submit to manager or handle stream
|
||||||
d.OnTasksClaimed = func(tasks []agent.Task) {
|
d.OnTasksClaimed = func(tasks []agent.Task) {
|
||||||
|
|
@ -337,13 +496,27 @@ func runDaemonStart() error {
|
||||||
streamRegistry.mu.Lock()
|
streamRegistry.mu.Lock()
|
||||||
streamRegistry.cancels[t.ID] = streamCancel
|
streamRegistry.cancels[t.ID] = streamCancel
|
||||||
streamRegistry.mu.Unlock()
|
streamRegistry.mu.Unlock()
|
||||||
go handleStreamTask(streamCtx, t, reporter, cfg, agentClient, streamSrv)
|
go handleStreamTask(streamCtx, t, reporter, cfg, agentClient, streamSrv, func() { d.TriggerSync() })
|
||||||
} else {
|
} else {
|
||||||
manager.Submit(ctx, t)
|
manager.Submit(ctx, t)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Resume downloads interrupted by the previous shutdown/crash. Re-submit
|
||||||
|
// each persisted task; its downloader picks up the partial data (torrent via
|
||||||
|
// the piece-completion DB, debrid via Range, usenet via its tracker). Done
|
||||||
|
// before the sync loop starts; a later web re-dispatch of the same id is
|
||||||
|
// deduped by the manager.
|
||||||
|
if resume := taskStore.Load(); len(resume) > 0 {
|
||||||
|
log.Printf("[resume] re-submitting %d interrupted download(s)", len(resume))
|
||||||
|
for _, t := range resume {
|
||||||
|
t.ForceStart = false // respect MaxConcurrent on bulk auto-resume
|
||||||
|
log.Printf("[resume] %s — %s", agent.ShortID(t.ID), t.Title)
|
||||||
|
manager.Submit(ctx, t)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Wire: sync receives control signals → act on manager
|
// Wire: sync receives control signals → act on manager
|
||||||
d.OnControlAction = func(action, taskID string, deleteFiles bool) {
|
d.OnControlAction = func(action, taskID string, deleteFiles bool) {
|
||||||
switch action {
|
switch action {
|
||||||
|
|
@ -419,33 +592,67 @@ func runDaemonStart() error {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
filePath := filepath.Clean(sr.FilePath)
|
// reportStreamError tells the web a /stream attempt failed WITHOUT
|
||||||
if !isAllowedStreamPath(filePath, cfg.Download.Dir, cfg.Library.ScanPath,
|
// marking the download failed (StreamError, not Status). The web clears
|
||||||
cfg.Organize.MoviesDir, cfg.Organize.TVShowsDir) {
|
// streamRequested and surfaces this so the player fails fast with the
|
||||||
log.Printf("[%s] stream request rejected: path outside allowed dirs: %s", agent.ShortID(sr.TaskID), filePath)
|
// real reason instead of polling out the 20s "agent didn't respond".
|
||||||
|
reportStreamError := func(reason string) {
|
||||||
go func() {
|
go func() {
|
||||||
if _, err := agentClient.ReportStatus(ctx, agent.StatusUpdate{
|
if _, err := agentClient.ReportStatus(ctx, agent.StatusUpdate{
|
||||||
TaskID: sr.TaskID,
|
TaskID: sr.TaskID,
|
||||||
Status: "failed",
|
StreamError: reason,
|
||||||
ErrorMessage: fmt.Sprintf("path outside allowed dirs: %s", filePath),
|
|
||||||
}); err != nil {
|
}); err != nil {
|
||||||
log.Printf("[%s] stream error report failed: %v", agent.ShortID(sr.TaskID), err)
|
log.Printf("[%s] stream error report failed: %v", agent.ShortID(sr.TaskID), err)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
return
|
|
||||||
}
|
}
|
||||||
info, err := os.Stat(filePath)
|
|
||||||
if err != nil {
|
allowedRoots := []string{cfg.Download.Dir, cfg.Library.ScanPath,
|
||||||
log.Printf("[%s] stream request: file not found: %s", agent.ShortID(sr.TaskID), filePath)
|
cfg.Organize.MoviesDir, cfg.Organize.TVShowsDir}
|
||||||
go func() {
|
|
||||||
if _, err := agentClient.ReportStatus(ctx, agent.StatusUpdate{
|
filePath := filepath.Clean(sr.FilePath)
|
||||||
TaskID: sr.TaskID,
|
// Self-heal a base-path mismatch: the web may hand us a path under an old
|
||||||
Status: "failed",
|
// root (e.g. /mnt/nas/peliculas/… from before a binary→docker move) that
|
||||||
ErrorMessage: fmt.Sprintf("file not found: %s", filePath),
|
// is now outside our allowed dirs but whose file still exists under a
|
||||||
}); err != nil {
|
// current root (/downloads/…). Remap the path's tail onto an allowed root
|
||||||
log.Printf("[%s] stream error report failed: %v", agent.ShortID(sr.TaskID), err)
|
// so playback works immediately; the next re-scan persists the fix to the
|
||||||
}
|
// DB. See docs/plans/unarr-path-resilience.md.
|
||||||
}()
|
if !isAllowedStreamPath(filePath, allowedRoots...) {
|
||||||
|
if remapped := relocateUnreachable(filePath, allowedRoots); remapped != "" {
|
||||||
|
log.Printf("[%s] stream self-heal: remapped %s → %s", agent.ShortID(sr.TaskID), filePath, remapped)
|
||||||
|
filePath = remapped
|
||||||
|
} else {
|
||||||
|
log.Printf("[%s] stream request rejected: path outside allowed dirs: %s", agent.ShortID(sr.TaskID), filePath)
|
||||||
|
reportStreamError(fmt.Sprintf("path outside allowed dirs: %s", filePath))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// os.Stat over NFS can transiently fail (ESTALE/EAGAIN/timeout) right
|
||||||
|
// after a remount or under load. Retry a few times before giving up so
|
||||||
|
// a hiccup doesn't surface as a spurious "file not found" — this is the
|
||||||
|
// root of the intermittent "works on the 3rd try" stream failures.
|
||||||
|
var info os.FileInfo
|
||||||
|
var statErr error
|
||||||
|
for attempt := 0; attempt < 3; attempt++ {
|
||||||
|
if info, statErr = os.Stat(filePath); statErr == nil {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if attempt < 2 {
|
||||||
|
time.Sleep(300 * time.Millisecond)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if statErr != nil {
|
||||||
|
// Last resort before failing: the file may simply have moved within
|
||||||
|
// an allowed root — try to relocate it by path tail.
|
||||||
|
if remapped := relocateUnreachable(filePath, allowedRoots); remapped != "" {
|
||||||
|
log.Printf("[%s] stream self-heal: relocated missing %s → %s", agent.ShortID(sr.TaskID), filePath, remapped)
|
||||||
|
filePath = remapped
|
||||||
|
info, statErr = os.Stat(filePath)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if statErr != nil {
|
||||||
|
log.Printf("[%s] stream request: file not found after retries: %s (%v)", agent.ShortID(sr.TaskID), filePath, statErr)
|
||||||
|
reportStreamError(fmt.Sprintf("file not found: %s", filePath))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -453,15 +660,7 @@ func runDaemonStart() error {
|
||||||
found := engine.FindVideoFile(filePath)
|
found := engine.FindVideoFile(filePath)
|
||||||
if found == "" {
|
if found == "" {
|
||||||
log.Printf("[%s] stream request: no video file in directory: %s", agent.ShortID(sr.TaskID), filePath)
|
log.Printf("[%s] stream request: no video file in directory: %s", agent.ShortID(sr.TaskID), filePath)
|
||||||
go func() {
|
reportStreamError(fmt.Sprintf("no video file in directory: %s", filePath))
|
||||||
if _, err := agentClient.ReportStatus(ctx, agent.StatusUpdate{
|
|
||||||
TaskID: sr.TaskID,
|
|
||||||
Status: "failed",
|
|
||||||
ErrorMessage: fmt.Sprintf("no video file in directory: %s", filePath),
|
|
||||||
}); err != nil {
|
|
||||||
log.Printf("[%s] stream error report failed: %v", agent.ShortID(sr.TaskID), err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
filePath = found
|
filePath = found
|
||||||
|
|
@ -496,6 +695,97 @@ func runDaemonStart() error {
|
||||||
if playerSessionRegistry.has(sess.SessionID) {
|
if playerSessionRegistry.has(sess.SessionID) {
|
||||||
return // already running
|
return // already running
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// startHLSPlayback starts an HLS encode (local file or debrid URL) and
|
||||||
|
// wires it into the StreamServer. Shared by the local-file HLS path and
|
||||||
|
// the debrid HLS-from-URL path (hueco #2 / 2b) so both register, probe
|
||||||
|
// off the sync loop, and report readiness identically.
|
||||||
|
startHLSPlayback := func(hlsCfg engine.HLSSessionConfig, hlsCtx context.Context, hlsCancel context.CancelFunc) {
|
||||||
|
playerSessionRegistry.add(hlsCfg.SessionID, hlsCancel)
|
||||||
|
go func() {
|
||||||
|
hsess, err := engine.StartHLSSession(hlsCtx, hlsCfg)
|
||||||
|
if err != nil {
|
||||||
|
playerSessionRegistry.remove(hlsCfg.SessionID)
|
||||||
|
hlsCancel()
|
||||||
|
log.Printf("[hls %s] start failed: %v", agent.ShortID(hlsCfg.SessionID), err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
streamSrv.HLS().Register(hsess)
|
||||||
|
go watchSessionReady(hlsCtx, agentClient, hsess, hlsCfg.SessionID)
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Debrid direct-play (hueco #2 / 2a): the source has no local file — the
|
||||||
|
// web resolved an HTTPS debrid link (cache-confirmed, browser-native
|
||||||
|
// container) and the daemon streams /stream from it via ranged GETs.
|
||||||
|
// Runs BEFORE the filePath checks (there is no local path) and needs no
|
||||||
|
// ffmpeg. PlayMethod != "hls" distinguishes this from the debrid
|
||||||
|
// HLS-from-URL branch below (a non-native container the web wants
|
||||||
|
// transcoded). Provider setup does a HEAD, so hand it off to a goroutine
|
||||||
|
// to keep the sync loop from blocking other pending actions; register the
|
||||||
|
// session up front so a duplicate sync within the setup window is a
|
||||||
|
// no-op (matches the HLS branch's handoff rationale).
|
||||||
|
if sess.DirectURL != "" && sess.PlayMethod != "hls" {
|
||||||
|
playerSessionRegistry.add(sess.SessionID, func() { streamSrv.ClearFile() })
|
||||||
|
// refresh re-resolves a fresh debrid link when this one expires
|
||||||
|
// mid-stream (hueco #2 / 2c). Bound to the daemon ctx so a shutdown
|
||||||
|
// cancels an in-flight refresh.
|
||||||
|
refresh := func(rctx context.Context) (string, error) {
|
||||||
|
return agentClient.RefreshStreamURL(rctx, sess.SessionID)
|
||||||
|
}
|
||||||
|
go func() {
|
||||||
|
bctx, cancel := context.WithTimeout(ctx, 15*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
provider, perr := engine.NewDebridFileProvider(bctx, sess.DirectURL, sess.FileName, sess.FileSize, refresh)
|
||||||
|
if perr != nil {
|
||||||
|
playerSessionRegistry.remove(sess.SessionID)
|
||||||
|
log.Printf("[stream %s] debrid provider failed: %v", agent.ShortID(sess.SessionID), perr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
streamSrv.SetFile(provider, sess.TaskID)
|
||||||
|
log.Printf("[stream %s] debrid direct-play: %s (%d bytes)",
|
||||||
|
agent.ShortID(sess.SessionID), provider.FileName(), provider.FileSize())
|
||||||
|
rctx, rcancel := context.WithTimeout(ctx, 10*time.Second)
|
||||||
|
defer rcancel()
|
||||||
|
if err := agentClient.MarkSessionReady(rctx, sess.SessionID); err != nil {
|
||||||
|
log.Printf("[stream %s] mark-ready failed: %v", agent.ShortID(sess.SessionID), err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Debrid HLS-from-URL (hueco #2 / 2b): the source is debrid-cached but
|
||||||
|
// NOT browser-native (mkv/HEVC/…), so the web set playMethod="hls"
|
||||||
|
// alongside the DirectURL. ffmpeg transcodes straight from the HTTP URL —
|
||||||
|
// no local file, no torrent. Cache is keyed by info_hash (not the
|
||||||
|
// per-resolution URL) so a re-play hits the segment cache.
|
||||||
|
if sess.DirectURL != "" { // playMethod == "hls" implied (2a returned above)
|
||||||
|
tcRuntime := buildTranscodeRuntime(ctx, cfg)
|
||||||
|
if tcRuntime.FFmpegPath == "" || tcRuntime.FFprobePath == "" {
|
||||||
|
log.Printf("[hls %s] rejected: ffmpeg/ffprobe unavailable (debrid HLS)", agent.ShortID(sess.SessionID))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
hlsCtx, hlsCancel := context.WithCancel(ctx)
|
||||||
|
startHLSPlayback(engine.HLSSessionConfig{
|
||||||
|
SessionID: sess.SessionID,
|
||||||
|
SourceURL: sess.DirectURL,
|
||||||
|
CacheID: sess.InfoHash,
|
||||||
|
FileName: sess.FileName,
|
||||||
|
Quality: sess.Quality,
|
||||||
|
AudioIndex: sess.AudioIndex,
|
||||||
|
BurnSubtitleIndex: sess.BurnSubtitleIndex,
|
||||||
|
Transcode: tcRuntime,
|
||||||
|
Cache: hlsCache,
|
||||||
|
// 2c: refresh the debrid link if it expires mid-transcode; the
|
||||||
|
// auto-restart supervisor calls this before relaunching ffmpeg.
|
||||||
|
RefreshURL: func(rctx context.Context) (string, error) {
|
||||||
|
return agentClient.RefreshStreamURL(rctx, sess.SessionID)
|
||||||
|
},
|
||||||
|
}, hlsCtx, hlsCancel)
|
||||||
|
log.Printf("[hls %s] debrid HLS-from-URL: %s", agent.ShortID(sess.SessionID), sess.FileName)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
filePath := sess.FilePath
|
filePath := sess.FilePath
|
||||||
if filePath == "" {
|
if filePath == "" {
|
||||||
log.Printf("[hls %s] rejected: empty file path", agent.ShortID(sess.SessionID))
|
log.Printf("[hls %s] rejected: empty file path", agent.ShortID(sess.SessionID))
|
||||||
|
|
@ -519,29 +809,93 @@ func runDaemonStart() error {
|
||||||
filePath = found
|
filePath = found
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Direct-play (hueco #3 / 3a): the web decided this source is already
|
||||||
|
// browser-native (mp4 h264/aac 8-bit SDR) from library scan metadata,
|
||||||
|
// gated on agent version. Serve the raw file over /stream (HTTP Range,
|
||||||
|
// no ffmpeg) instead of transcoding to HLS — zero CPU, instant seek.
|
||||||
|
// Runs BEFORE the ffmpeg-availability check on purpose: direct-play
|
||||||
|
// needs no ffmpeg, so it must work even when transcode is disabled.
|
||||||
|
if sess.PlayMethod == "direct" {
|
||||||
|
streamSrv.SetFile(engine.NewDiskFileProvider(filePath), sess.TaskID)
|
||||||
|
// cancel just clears the served file so daemon shutdown / drain
|
||||||
|
// stops exposing it on /stream. There's no ffmpeg child to kill.
|
||||||
|
playerSessionRegistry.add(sess.SessionID, func() { streamSrv.ClearFile() })
|
||||||
|
log.Printf("[stream %s] direct-play: %s", agent.ShortID(sess.SessionID), filepath.Base(filePath))
|
||||||
|
// File is on disk → ready immediately. Tell the web so the player
|
||||||
|
// attaches <video src> without burning its HEAD-probe retry budget.
|
||||||
|
go func() {
|
||||||
|
rctx, cancel := context.WithTimeout(ctx, 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := agentClient.MarkSessionReady(rctx, sess.SessionID); err != nil {
|
||||||
|
log.Printf("[stream %s] mark-ready failed: %v", agent.ShortID(sess.SessionID), err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
tcRuntime := buildTranscodeRuntime(ctx, cfg)
|
tcRuntime := buildTranscodeRuntime(ctx, cfg)
|
||||||
if tcRuntime.FFmpegPath == "" || tcRuntime.FFprobePath == "" {
|
if tcRuntime.FFmpegPath == "" || tcRuntime.FFprobePath == "" {
|
||||||
log.Printf("[hls %s] rejected: ffmpeg/ffprobe unavailable", agent.ShortID(sess.SessionID))
|
log.Printf("[hls %s] rejected: ffmpeg/ffprobe unavailable", agent.ShortID(sess.SessionID))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
hlsCtx, hlsCancel := context.WithCancel(ctx)
|
|
||||||
playerSessionRegistry.add(sess.SessionID, hlsCancel)
|
// Remux path (hueco #3 / 3b): codecs are browser-native (h264/aac) but
|
||||||
hlsCfg := engine.HLSSessionConfig{
|
// the container isn't (mkv). ffmpeg `-c copy` → growing fMP4 served raw
|
||||||
SessionID: sess.SessionID,
|
// over /stream — no video re-encode, no HLS. The web decided this from
|
||||||
SourcePath: filePath,
|
// scan metadata + version gate; we still need ffmpeg (copy uses it).
|
||||||
FileName: sess.FileName,
|
if sess.PlayMethod == "remux" {
|
||||||
Quality: sess.Quality,
|
tStart := time.Now()
|
||||||
AudioIndex: sess.AudioIndex,
|
probeCtx, cancelProbe := context.WithTimeout(ctx, 15*time.Second)
|
||||||
Transcode: tcRuntime,
|
probe, perr := engine.ProbeFile(probeCtx, tcRuntime.FFprobePath, filePath)
|
||||||
}
|
cancelProbe()
|
||||||
hsess, err := engine.StartHLSSession(hlsCtx, hlsCfg)
|
if perr != nil {
|
||||||
if err != nil {
|
log.Printf("[stream %s] remux probe failed: %v", agent.ShortID(sess.SessionID), perr)
|
||||||
playerSessionRegistry.remove(sess.SessionID)
|
return
|
||||||
hlsCancel()
|
}
|
||||||
log.Printf("[hls %s] start failed: %v", agent.ShortID(sess.SessionID), err)
|
tProbe := time.Now()
|
||||||
|
remuxCtx, remuxCancel := context.WithCancel(ctx)
|
||||||
|
src, serr := engine.NewRemuxSource(remuxCtx, filePath, probe, tcRuntime.FFmpegPath, sess.FileName)
|
||||||
|
if serr != nil {
|
||||||
|
remuxCancel()
|
||||||
|
log.Printf("[stream %s] remux start failed: %v", agent.ShortID(sess.SessionID), serr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
streamSrv.SetGrowingFile(src, sess.TaskID)
|
||||||
|
// cancel stops the ffmpeg copy; SetGrowingFile/ClearFile also Close()
|
||||||
|
// the source, so the temp file is always cleaned up.
|
||||||
|
playerSessionRegistry.add(sess.SessionID, func() { remuxCancel(); streamSrv.ClearFile() })
|
||||||
|
// Startup timing (TTFF diagnosis): probe = ffprobe on the source;
|
||||||
|
// spawn = ffmpeg launch + tmp setup. First-fMP4-byte is logged by the
|
||||||
|
// source itself; serveGrowing logs any client read that blocks waiting
|
||||||
|
// for ffmpeg to catch up.
|
||||||
|
log.Printf("[stream %s] remux (copy) → fMP4: %s [probe=%v spawn=%v]",
|
||||||
|
agent.ShortID(sess.SessionID), filepath.Base(filePath),
|
||||||
|
tProbe.Sub(tStart).Round(time.Millisecond), time.Since(tProbe).Round(time.Millisecond))
|
||||||
|
go func() {
|
||||||
|
rctx, cancel := context.WithTimeout(ctx, 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := agentClient.MarkSessionReady(rctx, sess.SessionID); err != nil {
|
||||||
|
log.Printf("[stream %s] mark-ready failed: %v", agent.ShortID(sess.SessionID), err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
streamSrv.HLS().Register(hsess)
|
|
||||||
|
// Local-file HLS (the original path). StartHLSSession runs ffprobe
|
||||||
|
// (15 s cap) inside startHLSPlayback's goroutine so the sync loop
|
||||||
|
// returns immediately — browser HEAD probes have a 30 s retry budget
|
||||||
|
// that absorbs the gap until the playlist registers.
|
||||||
|
hlsCtx, hlsCancel := context.WithCancel(ctx)
|
||||||
|
startHLSPlayback(engine.HLSSessionConfig{
|
||||||
|
SessionID: sess.SessionID,
|
||||||
|
SourcePath: filePath,
|
||||||
|
FileName: sess.FileName,
|
||||||
|
Quality: sess.Quality,
|
||||||
|
AudioIndex: sess.AudioIndex,
|
||||||
|
BurnSubtitleIndex: sess.BurnSubtitleIndex,
|
||||||
|
Transcode: tcRuntime,
|
||||||
|
Cache: hlsCache,
|
||||||
|
}, hlsCtx, hlsCancel)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Periodic DHT node persistence (every 5 min)
|
// Periodic DHT node persistence (every 5 min)
|
||||||
|
|
@ -612,13 +966,16 @@ func runDaemonStart() error {
|
||||||
cancelStreamContexts()
|
cancelStreamContexts()
|
||||||
cancelAllPlayerSessions()
|
cancelAllPlayerSessions()
|
||||||
streamSrv.Shutdown(context.Background())
|
streamSrv.Shutdown(context.Background())
|
||||||
cancel()
|
|
||||||
|
|
||||||
// Give active downloads 30s to finish
|
// Drain active downloads BEFORE cancelling the daemon context. Shutdown
|
||||||
|
// sets shuttingDown + cancels each task context itself, so interrupted
|
||||||
|
// downloads keep their resume-store entry. Cancelling the shared ctx first
|
||||||
|
// would make them look like genuine failures and wipe the entry → no resume.
|
||||||
shutdownCtx, shutdownCancel := context.WithTimeout(context.Background(), 30*time.Second)
|
shutdownCtx, shutdownCancel := context.WithTimeout(context.Background(), 30*time.Second)
|
||||||
defer shutdownCancel()
|
defer shutdownCancel()
|
||||||
manager.Shutdown(shutdownCtx)
|
manager.Shutdown(shutdownCtx)
|
||||||
|
|
||||||
|
cancel()
|
||||||
d.Deregister()
|
d.Deregister()
|
||||||
fmt.Println(" Daemon stopped.")
|
fmt.Println(" Daemon stopped.")
|
||||||
return nil
|
return nil
|
||||||
|
|
@ -651,6 +1008,53 @@ func isAllowedStreamPath(filePath string, allowedDirs ...string) bool {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// relocateUnreachable tries to find a file the web asked us to stream under a
|
||||||
|
// path we can't serve (e.g. an old base path) by joining the longest suffix of
|
||||||
|
// that path onto each current allowed root and checking it exists. Returns the
|
||||||
|
// found absolute path or "".
|
||||||
|
//
|
||||||
|
// Conservative by design — it must never serve the WRONG file:
|
||||||
|
// - Requires a tail of at least three segments (collection/season/file), so a
|
||||||
|
// generic "Season 01/Episode.mkv" can't match a different show by accident.
|
||||||
|
// Flat single-file-at-root layouts simply aren't self-healed here; the next
|
||||||
|
// re-scan re-maps them instead.
|
||||||
|
// - Re-checks containment AFTER resolving symlinks, so a symlink inside a root
|
||||||
|
// pointing outside it can't be used to escape the allowed dirs (isAllowed‑
|
||||||
|
// StreamPath alone is a lexical check that os.Stat would happily follow out).
|
||||||
|
func relocateUnreachable(filePath string, allowedRoots []string) string {
|
||||||
|
segs := strings.Split(filepath.ToSlash(filePath), "/")
|
||||||
|
// Longest tail first (most specific match wins). Stop before 3-segment tails
|
||||||
|
// so a short, ambiguous suffix can't match the wrong file.
|
||||||
|
for start := 0; start <= len(segs)-3; start++ {
|
||||||
|
tail := filepath.Join(segs[start:]...)
|
||||||
|
if tail == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, root := range allowedRoots {
|
||||||
|
if root == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
cand := filepath.Join(root, tail)
|
||||||
|
if !isAllowedStreamPath(cand, root) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fi, err := os.Stat(cand)
|
||||||
|
if err != nil || fi.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Re-validate containment against the symlink-resolved real paths so
|
||||||
|
// a symlink under the root can't point the stream outside it.
|
||||||
|
realCand, e1 := filepath.EvalSymlinks(cand)
|
||||||
|
realRoot, e2 := filepath.EvalSymlinks(root)
|
||||||
|
if e1 != nil || e2 != nil || !isAllowedStreamPath(realCand, realRoot) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return cand
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
func formatSpeedLog(bps int64) string {
|
func formatSpeedLog(bps int64) string {
|
||||||
switch {
|
switch {
|
||||||
case bps >= 1024*1024*1024:
|
case bps >= 1024*1024*1024:
|
||||||
|
|
@ -667,6 +1071,23 @@ func formatSpeedLog(bps int64) string {
|
||||||
// runAutoScan runs a library scan + sync on a timer or on-demand via scanNow channel.
|
// runAutoScan runs a library scan + sync on a timer or on-demand via scanNow channel.
|
||||||
// It scans all provided paths and syncs each independently so stale-item cleanup
|
// It scans all provided paths and syncs each independently so stale-item cleanup
|
||||||
// is scoped to the correct directory prefix on the server.
|
// is scoped to the correct directory prefix on the server.
|
||||||
|
// basePathChanged reports whether the library's scan root moved since the last
|
||||||
|
// saved cache — i.e. the previously-scanned root is no longer one of the current
|
||||||
|
// scan paths. Used to force a full (non-incremental) re-scan so the server can
|
||||||
|
// re-map paths by fingerprint and reap the old prefix.
|
||||||
|
func basePathChanged(existing *library.LibraryCache, scanPaths []string) bool {
|
||||||
|
if existing == nil || len(existing.Items) == 0 || existing.Path == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
prev := filepath.Clean(existing.Path)
|
||||||
|
for _, p := range scanPaths {
|
||||||
|
if filepath.Clean(p) == prev {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration, ac *agent.Client, scanNow <-chan struct{}, scanPaths []string) {
|
func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration, ac *agent.Client, scanNow <-chan struct{}, scanPaths []string) {
|
||||||
log.Printf("[auto-scan] enabled: every %s, paths: %v", interval, scanPaths)
|
log.Printf("[auto-scan] enabled: every %s, paths: %v", interval, scanPaths)
|
||||||
|
|
||||||
|
|
@ -692,10 +1113,36 @@ func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration,
|
||||||
workers = 8
|
workers = 8
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// If the library base path changed (e.g. the agent moved from the host
|
||||||
|
// binary to docker, remapping /mnt/nas/peliculas → /downloads, or the
|
||||||
|
// user moved their media folder), force a FULL re-scan instead of an
|
||||||
|
// incremental one. The fingerprint merge on the server then relocates
|
||||||
|
// existing rows in place rather than duplicating, and per-agent cleanup
|
||||||
|
// reaps the old prefix. See docs/plans/unarr-path-resilience.md.
|
||||||
|
forceFull := basePathChanged(existing, scanPaths)
|
||||||
|
if forceFull {
|
||||||
|
log.Printf("[auto-scan] WARNING: library base path changed (was %q, now %v) — "+
|
||||||
|
"running a FULL re-scan. This can take a while on large libraries; "+
|
||||||
|
"playback and matches are preserved.", existing.Path, scanPaths)
|
||||||
|
}
|
||||||
|
|
||||||
scanOpts := library.ScanOptions{
|
scanOpts := library.ScanOptions{
|
||||||
Workers: workers,
|
Workers: workers,
|
||||||
FFprobePath: cfg.Library.FFprobePath,
|
FFprobePath: cfg.Library.FFprobePath,
|
||||||
Incremental: existing != nil,
|
Incremental: existing != nil && !forceFull,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve ffmpeg once for the sidecar prewarm (extracts text subs → WebVTT
|
||||||
|
// and panel thumbnail frames → JPEG into the hidden ".unarr" cache so /sub
|
||||||
|
// and /thumbnail are instant + huge remuxes work). Empty/err = prewarm is
|
||||||
|
// skipped silently (on-demand extraction still runs).
|
||||||
|
prewarmFFmpeg := ""
|
||||||
|
if cfg.Library.CacheSubtitles || cfg.Library.CacheThumbnails || cfg.Library.Trickplay.Enabled {
|
||||||
|
if ff, err := mediainfo.ResolveFFmpeg(cfg.Library.FFmpegPath); err == nil {
|
||||||
|
prewarmFFmpeg = ff
|
||||||
|
} else {
|
||||||
|
log.Printf("[auto-scan] sidecar prewarm disabled: ffmpeg unavailable: %v", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Scan each path independently and sync per path so the server can
|
// Scan each path independently and sync per path so the server can
|
||||||
|
|
@ -712,6 +1159,19 @@ func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration,
|
||||||
}
|
}
|
||||||
mergedItems = append(mergedItems, cache.Items...)
|
mergedItems = append(mergedItems, cache.Items...)
|
||||||
|
|
||||||
|
if prewarmFFmpeg != "" {
|
||||||
|
library.PrewarmSidecars(ctx, cache, library.PrewarmOptions{
|
||||||
|
FFmpegPath: prewarmFFmpeg,
|
||||||
|
CacheSubtitles: cfg.Library.CacheSubtitles,
|
||||||
|
CacheThumbnails: cfg.Library.CacheThumbnails,
|
||||||
|
Workers: 2,
|
||||||
|
Trickplay: cfg.Library.Trickplay.Enabled,
|
||||||
|
TrickplayIntervalSec: cfg.Library.Trickplay.IntervalSeconds(),
|
||||||
|
TrickplayWidth: cfg.Library.Trickplay.Width,
|
||||||
|
MaxLoadRatio: cfg.Library.PrewarmMaxLoadRatio,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
items := library.BuildSyncItems(cache)
|
items := library.BuildSyncItems(cache)
|
||||||
if len(items) == 0 {
|
if len(items) == 0 {
|
||||||
log.Printf("[auto-scan] no items under %s", scanPath)
|
log.Printf("[auto-scan] no items under %s", scanPath)
|
||||||
|
|
@ -729,6 +1189,7 @@ func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration,
|
||||||
_, err := ac.SyncLibrary(ctx, agent.LibrarySyncRequest{
|
_, err := ac.SyncLibrary(ctx, agent.LibrarySyncRequest{
|
||||||
Items: items[i:end],
|
Items: items[i:end],
|
||||||
ScanPath: scanPath,
|
ScanPath: scanPath,
|
||||||
|
AgentID: cfg.Agent.ID,
|
||||||
IsLastBatch: isLast,
|
IsLastBatch: isLast,
|
||||||
SyncStartedAt: syncStartedAt,
|
SyncStartedAt: syncStartedAt,
|
||||||
})
|
})
|
||||||
|
|
@ -773,3 +1234,144 @@ func runAutoScan(ctx context.Context, cfg config.Config, interval time.Duration,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// superviseFunnel keeps a CloudFlare Quick Tunnel up across cloudflared
|
||||||
|
// crashes and CF's ~6h tunnel rotation. On a clean exit (cancellation) it
|
||||||
|
// returns; on a crash it clears the reported URL and respawns with an
|
||||||
|
// exponential backoff so we don't hammer cloudflared into a tight loop when
|
||||||
|
// it can't reach the CF edge.
|
||||||
|
func superviseFunnel(ctx context.Context, d *agent.Daemon, port int) {
|
||||||
|
backoff := 2 * time.Second
|
||||||
|
const maxBackoff = 5 * time.Minute
|
||||||
|
for ctx.Err() == nil {
|
||||||
|
t, err := funnel.Start(ctx, funnel.Config{Port: port})
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[funnel] could not start CloudFlare tunnel (%v) — retrying in %s", err, backoff)
|
||||||
|
select {
|
||||||
|
case <-time.After(backoff):
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
}
|
||||||
|
backoff = min(backoff*2, maxBackoff)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
log.Printf("[funnel] cloudflared started, waiting for public URL...")
|
||||||
|
go func() {
|
||||||
|
url, werr := t.WaitURL(45 * time.Second)
|
||||||
|
if werr != nil {
|
||||||
|
log.Printf("[funnel] cloudflared did not emit a URL (%v)", werr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[funnel] public URL: %s", url)
|
||||||
|
d.SetFunnelURL(url)
|
||||||
|
}()
|
||||||
|
// Block until cloudflared exits (CF rotation, crash, or shutdown).
|
||||||
|
exitErr := <-t.Done()
|
||||||
|
_ = t.Close()
|
||||||
|
d.SetFunnelURL("")
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if exitErr != nil {
|
||||||
|
log.Printf("[funnel] cloudflared exited: %v — restarting in %s", exitErr, backoff)
|
||||||
|
} else {
|
||||||
|
log.Printf("[funnel] cloudflared exited cleanly — restarting in %s", backoff)
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-time.After(backoff):
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
}
|
||||||
|
backoff = min(backoff*2, maxBackoff)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// mirrorCORSOrigins fetches /api/mirrors from the configured primary (+ extra
|
||||||
|
// mirror candidates + static IPFS fallback) and returns the discovered URLs as
|
||||||
|
// Origin strings. Best-effort: any failure logs a warning and returns an empty
|
||||||
|
// slice; the static defaultCORSAllowedOrigins in validate.go covers the known
|
||||||
|
// mirrors (.com / .to / built-in onion) so the daemon still accepts the
|
||||||
|
// official surfaces when this call fails.
|
||||||
|
//
|
||||||
|
// Bounded to a short timeout so a slow /api/mirrors response can't delay
|
||||||
|
// daemon startup — every second here is a second the user can't play.
|
||||||
|
func mirrorCORSOrigins(parent context.Context, cfg config.Config, userAgent string) []string {
|
||||||
|
ctx, cancel := context.WithTimeout(parent, 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
candidates := append([]string{cfg.Auth.APIURL}, cfg.Auth.Mirrors...)
|
||||||
|
resp, err := agent.FetchMirrorsWithFallback(ctx, candidates, userAgent)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[cors] mirror discovery failed (%v) — using static allowlist only", err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
seen := make(map[string]struct{})
|
||||||
|
out := make([]string, 0, len(resp.Mirrors))
|
||||||
|
add := func(rawURL string) {
|
||||||
|
if rawURL == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
origin := strings.TrimRight(rawURL, "/")
|
||||||
|
if _, dup := seen[origin]; dup {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
seen[origin] = struct{}{}
|
||||||
|
out = append(out, origin)
|
||||||
|
}
|
||||||
|
for _, m := range resp.Mirrors {
|
||||||
|
add(m.URL)
|
||||||
|
}
|
||||||
|
if resp.Tor != nil {
|
||||||
|
add(resp.Tor.URL)
|
||||||
|
}
|
||||||
|
if len(out) > 0 {
|
||||||
|
log.Printf("[cors] merged %d mirror origins from /api/mirrors", len(out))
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// watchSessionReady polls HLSSession.ReadyCount until the first segment +
|
||||||
|
// init.mp4 are on disk, then POSTs /api/internal/agent/session-ready so
|
||||||
|
// the web side flips streaming_session.ready_at — which its SSE endpoint
|
||||||
|
// pushes to subscribed players. Cache-HIT sessions are ready the moment
|
||||||
|
// StartHLSSession returns and POST immediately.
|
||||||
|
//
|
||||||
|
// Bounded by a 60 s deadline so a permanently stuck encoder doesn't keep
|
||||||
|
// a goroutine alive forever; if seg-0 never lands the player falls back
|
||||||
|
// to its existing HEAD-probe retry path anyway.
|
||||||
|
func watchSessionReady(ctx context.Context, client *agent.Client, hsess *engine.HLSSession, sessionID string) {
|
||||||
|
deadline := time.Now().Add(60 * time.Second)
|
||||||
|
ticker := time.NewTicker(200 * time.Millisecond)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
// Session torn down through a path that didn't cancel ctx (registry
|
||||||
|
// replace, idle sweep, internal kill). Bail before polling further —
|
||||||
|
// without this check the watcher could keep alive for up to 60 s on
|
||||||
|
// a dead HLSSession that's never going to become ready.
|
||||||
|
if hsess.IsClosed() {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// Cache HIT or seg-0 ready → notify + done.
|
||||||
|
if hsess.FromCache() || hsess.ReadyCount() >= 1 {
|
||||||
|
// Parent ctx so a session cancel mid-POST (user closed tab,
|
||||||
|
// daemon shutdown) tears down the in-flight webhook instead of
|
||||||
|
// blocking the goroutine for up to 10 s on a now-orphan call.
|
||||||
|
rctx, cancel := context.WithTimeout(ctx, 10*time.Second)
|
||||||
|
if err := client.MarkSessionReady(rctx, sessionID); err != nil {
|
||||||
|
log.Printf("[hls %s] mark-ready failed: %v", agent.ShortID(sessionID), err)
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
}
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
log.Printf("[hls %s] mark-ready: timeout waiting for seg-0", agent.ShortID(sessionID))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
|
|
@ -262,9 +263,12 @@ func runDaemonReload() error {
|
||||||
// stopDaemonByPID reads the state file and sends a graceful stop to the daemon PID.
|
// stopDaemonByPID reads the state file and sends a graceful stop to the daemon PID.
|
||||||
// Used as fallback on platforms without a service manager (and as Windows implementation).
|
// Used as fallback on platforms without a service manager (and as Windows implementation).
|
||||||
func stopDaemonByPID() error {
|
func stopDaemonByPID() error {
|
||||||
state := agent.ReadState()
|
state, err := agent.LoadState()
|
||||||
if state == nil {
|
if err != nil {
|
||||||
return fmt.Errorf("daemon does not appear to be running (state file not found)")
|
if errors.Is(err, agent.ErrDaemonNotRunning) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return fmt.Errorf("read daemon state: %w", err)
|
||||||
}
|
}
|
||||||
return killPID(state.PID)
|
return killPID(state.PID)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -113,17 +113,18 @@ func runDownloadWithDeps(input, method string, deps downloadDeps) error {
|
||||||
MetadataTimeout: 15 * time.Minute,
|
MetadataTimeout: 15 * time.Minute,
|
||||||
StallTimeout: 10 * time.Minute,
|
StallTimeout: 10 * time.Minute,
|
||||||
MaxTimeout: 0, // unlimited
|
MaxTimeout: 0, // unlimited
|
||||||
SeedEnabled: false,
|
// One-shot foreground download: leech then exit. Seeding only makes sense
|
||||||
|
// for the always-on daemon (see DownloadConfig.SeedEnabled).
|
||||||
|
SeedEnabled: false,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("create downloader: %w", err)
|
return fmt.Errorf("create downloader: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a dummy reporter (no API reporting for one-shot)
|
// Local-only reporter: one-shot downloads have no server-side task, so a nil
|
||||||
reporter := engine.NewProgressReporter(
|
// client keeps terminal progress working without spamming the status API
|
||||||
deps.newAgentClient(cfg.Auth.APIURL, cfg.Auth.APIKey, "unarr/"+Version),
|
// (which 400s the synthetic "oneshot-" id).
|
||||||
5*time.Second,
|
reporter := engine.NewProgressReporter(nil, 5*time.Second)
|
||||||
)
|
|
||||||
|
|
||||||
debridDl := deps.newDebridDl()
|
debridDl := deps.newDebridDl()
|
||||||
|
|
||||||
|
|
|
||||||
165
internal/cmd/funnel.go
Normal file
165
internal/cmd/funnel.go
Normal file
|
|
@ -0,0 +1,165 @@
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/fatih/color"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func newFunnelCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "funnel",
|
||||||
|
Short: "Expose the daemon over a public HTTPS hostname via CloudFlare Quick Tunnel",
|
||||||
|
Long: `Turn the CloudFlare Quick Tunnel on/off and check its status.
|
||||||
|
|
||||||
|
When on, the daemon spawns cloudflared as a child process and registers a
|
||||||
|
` + "`https://<random>.trycloudflare.com`" + ` hostname tunnelled to its local
|
||||||
|
HLS server. The torrentclaw.com / torrentclaw.to web player picks the tunnel
|
||||||
|
URL first so cross-network playback works from any browser without Tailscale
|
||||||
|
or port forwarding.
|
||||||
|
|
||||||
|
Trade-offs:
|
||||||
|
• Bytes proxy through CloudFlare. We don't relay; CF does. Preserves the
|
||||||
|
TorrentClaw legal posture but means CF sees your traffic shape.
|
||||||
|
• Quick Tunnels are anonymous — no CF account required.
|
||||||
|
• Hostname is random per session and rotates roughly every 6 h.
|
||||||
|
|
||||||
|
Requires the cloudflared binary on PATH. Install:
|
||||||
|
Linux : https://pkg.cloudflare.com (apt) or download from
|
||||||
|
https://github.com/cloudflare/cloudflared/releases
|
||||||
|
macOS : brew install cloudflared
|
||||||
|
Windows: winget install --id Cloudflare.cloudflared`,
|
||||||
|
Example: ` unarr funnel status # is the tunnel up? what's the URL?
|
||||||
|
unarr funnel on # turn it on
|
||||||
|
unarr funnel off # turn it off`,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
return cmd.Help()
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.AddCommand(newFunnelStatusCmd(), newFunnelOnCmd(), newFunnelOffCmd())
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFunnelStatusCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "status",
|
||||||
|
Short: "Show CloudFlare tunnel configuration + live URL",
|
||||||
|
Example: " unarr funnel status",
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
return runFunnelStatus()
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runFunnelStatus() error {
|
||||||
|
bold := color.New(color.Bold)
|
||||||
|
dim := color.New(color.FgHiBlack)
|
||||||
|
green := color.New(color.FgGreen)
|
||||||
|
yellow := color.New(color.FgYellow)
|
||||||
|
cyan := color.New(color.FgCyan)
|
||||||
|
|
||||||
|
cfg := loadConfig()
|
||||||
|
|
||||||
|
fmt.Println()
|
||||||
|
bold.Println(" CloudFlare Quick Tunnel")
|
||||||
|
fmt.Println()
|
||||||
|
|
||||||
|
if !cfg.Download.Funnel.Enabled {
|
||||||
|
dim.Println(" Mode: off")
|
||||||
|
fmt.Println()
|
||||||
|
dim.Println(" Enable with `unarr funnel on` to give the daemon a public HTTPS URL")
|
||||||
|
dim.Println(" so cross-network browser playback works without Tailscale.")
|
||||||
|
fmt.Println()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
cyan.Println(" Mode: on")
|
||||||
|
|
||||||
|
state := agent.ReadState()
|
||||||
|
alive := state != nil && isDaemonAlive(state)
|
||||||
|
fmt.Println()
|
||||||
|
switch {
|
||||||
|
case alive && state.FunnelURL != "":
|
||||||
|
green.Println(" ✓ Tunnel ACTIVE")
|
||||||
|
fmt.Printf(" URL: %s\n", state.FunnelURL)
|
||||||
|
fmt.Println()
|
||||||
|
dim.Println(" This URL rotates roughly every 6 h. The web player picks it up")
|
||||||
|
dim.Println(" automatically — no action needed on your side.")
|
||||||
|
case alive:
|
||||||
|
yellow.Println(" ⚠ Daemon is running but the tunnel hasn't registered yet.")
|
||||||
|
dim.Println(" Check `unarr daemon logs` for a [funnel] line. Common cause:")
|
||||||
|
dim.Println(" cloudflared isn't installed on PATH.")
|
||||||
|
default:
|
||||||
|
dim.Println(" Daemon not running — start it (`unarr start`) to bring the tunnel up.")
|
||||||
|
}
|
||||||
|
fmt.Println()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFunnelOnCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "on",
|
||||||
|
Short: "Turn the CloudFlare tunnel on",
|
||||||
|
Example: " unarr funnel on",
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
return setFunnelEnabled(true)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFunnelOffCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "off",
|
||||||
|
Short: "Turn the CloudFlare tunnel off",
|
||||||
|
Example: " unarr funnel off",
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
return setFunnelEnabled(false)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func setFunnelEnabled(enabled bool) error {
|
||||||
|
green := color.New(color.FgGreen)
|
||||||
|
dim := color.New(color.FgHiBlack)
|
||||||
|
|
||||||
|
cfg := loadConfig()
|
||||||
|
if cfg.Download.Funnel.Enabled == enabled {
|
||||||
|
fmt.Println()
|
||||||
|
dim.Printf(" Tunnel is already %s — nothing to do.\n", onOffWord(enabled))
|
||||||
|
fmt.Println()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg.Download.Funnel.Enabled = enabled
|
||||||
|
|
||||||
|
configPath := config.FilePath()
|
||||||
|
if cfgFile != "" {
|
||||||
|
configPath = cfgFile
|
||||||
|
}
|
||||||
|
if err := config.Save(cfg, configPath); err != nil {
|
||||||
|
return fmt.Errorf("save config: %w", err)
|
||||||
|
}
|
||||||
|
appCfg = cfg
|
||||||
|
|
||||||
|
fmt.Println()
|
||||||
|
green.Printf(" ✓ CloudFlare tunnel %s.\n", onOffWord(enabled))
|
||||||
|
|
||||||
|
// Subprocess is launched/torn down by the daemon at startup; a plain config
|
||||||
|
// reload does not bring it up. Prompt for a restart when the daemon is alive.
|
||||||
|
if state := agent.ReadState(); state != nil && isDaemonAlive(state) {
|
||||||
|
fmt.Println()
|
||||||
|
dim.Println(" The daemon is running. Restart it for this to take effect:")
|
||||||
|
dim.Println(" unarr daemon restart")
|
||||||
|
}
|
||||||
|
fmt.Println()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func onOffWord(enabled bool) string {
|
||||||
|
if enabled {
|
||||||
|
return "on"
|
||||||
|
}
|
||||||
|
return "off"
|
||||||
|
}
|
||||||
|
|
@ -92,5 +92,11 @@ func buildTranscodeRuntime(ctx context.Context, cfg config.Config) engine.Transc
|
||||||
VideoBitrate: cfg.Download.Transcode.VideoBitrate,
|
VideoBitrate: cfg.Download.Transcode.VideoBitrate,
|
||||||
AudioBitrate: cfg.Download.Transcode.AudioBitrate,
|
AudioBitrate: cfg.Download.Transcode.AudioBitrate,
|
||||||
MaxHeight: cfg.Download.Transcode.MaxHeight,
|
MaxHeight: cfg.Download.Transcode.MaxHeight,
|
||||||
|
// Tonemap HDR→SDR only when this ffmpeg build has zscale; otherwise the
|
||||||
|
// filter would error and break playback, so HDR plays untonemapped.
|
||||||
|
TonemapHDR: engine.FFmpegSupportsZscale(ffmpegPath),
|
||||||
|
// libplacebo (GPU) is preferred over zscale when present — checked here so
|
||||||
|
// the per-session arg builder can pick it for HDR sources.
|
||||||
|
HasLibplacebo: engine.FFmpegSupportsLibplacebo(ffmpegPath),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@
|
||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
|
@ -43,9 +44,12 @@ func startReloadWatcher(rc *ReloadableConfig) {
|
||||||
|
|
||||||
// sendReloadSignal sends SIGUSR1 to the running daemon process.
|
// sendReloadSignal sends SIGUSR1 to the running daemon process.
|
||||||
func sendReloadSignal() error {
|
func sendReloadSignal() error {
|
||||||
state := agent.ReadState()
|
state, err := agent.LoadState()
|
||||||
if state == nil {
|
if err != nil {
|
||||||
return fmt.Errorf("daemon does not appear to be running (state file not found)")
|
if errors.Is(err, agent.ErrDaemonNotRunning) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return fmt.Errorf("read daemon state: %w", err)
|
||||||
}
|
}
|
||||||
p, err := os.FindProcess(state.PID)
|
p, err := os.FindProcess(state.PID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
||||||
74
internal/cmd/relocate_test.go
Normal file
74
internal/cmd/relocate_test.go
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func mkfile(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, []byte("x"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRelocateUnreachable(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
// A 3-segment-deep file under the current root.
|
||||||
|
mkfile(t, filepath.Join(root, "Acme Show", "Season 01", "ep.mkv"))
|
||||||
|
// A 2-segment-deep file (too shallow to be matched by a short tail).
|
||||||
|
mkfile(t, filepath.Join(root, "Season 01", "lonely.mkv"))
|
||||||
|
|
||||||
|
roots := []string{root}
|
||||||
|
|
||||||
|
// Base-path change: an old-root path whose 3-seg tail exists under the new
|
||||||
|
// root → relocates to the real file.
|
||||||
|
got := relocateUnreachable("/old/base/Acme Show/Season 01/ep.mkv", roots)
|
||||||
|
want := filepath.Join(root, "Acme Show", "Season 01", "ep.mkv")
|
||||||
|
if got != want {
|
||||||
|
t.Errorf("relocate moved file: got %q want %q", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only a 2-segment tail would match → must NOT relocate (ambiguous).
|
||||||
|
if got := relocateUnreachable("/old/Season 01/lonely.mkv", roots); got != "" {
|
||||||
|
t.Errorf("2-segment tail should not match, got %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nonexistent file → no relocation.
|
||||||
|
if got := relocateUnreachable("/old/base/Acme Show/Season 01/missing.mkv", roots); got != "" {
|
||||||
|
t.Errorf("missing file should not relocate, got %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Traversal attempt: ".." segments are cleaned by filepath.Join and the
|
||||||
|
// result is re-validated, so it can't escape.
|
||||||
|
if got := relocateUnreachable("/old/../../../etc/passwd", roots); got != "" {
|
||||||
|
t.Errorf("traversal should not match, got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRelocateUnreachableSymlinkEscape(t *testing.T) {
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
t.Skip("symlink semantics differ on windows")
|
||||||
|
}
|
||||||
|
root := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
// A real file living OUTSIDE any allowed root.
|
||||||
|
mkfile(t, filepath.Join(outside, "sub", "secret.mkv"))
|
||||||
|
// A symlink inside the root pointing at the outside tree.
|
||||||
|
if err := os.Symlink(outside, filepath.Join(root, "link")); err != nil {
|
||||||
|
t.Skipf("symlink unsupported: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The lexical candidate root/link/sub/secret.mkv exists (os.Stat follows the
|
||||||
|
// symlink), but after resolving symlinks it's outside the root → must be
|
||||||
|
// rejected so the stream can't escape the allowed dirs.
|
||||||
|
got := relocateUnreachable("/old/link/sub/secret.mkv", []string{root})
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("symlink escape must be rejected, got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -2,11 +2,14 @@ package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/fatih/color"
|
"github.com/fatih/color"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
tc "github.com/torrentclaw/go-client"
|
tc "github.com/torrentclaw/go-client"
|
||||||
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
"github.com/torrentclaw/unarr/internal/config"
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
"github.com/torrentclaw/unarr/internal/sentry"
|
"github.com/torrentclaw/unarr/internal/sentry"
|
||||||
"github.com/torrentclaw/unarr/internal/upgrade"
|
"github.com/torrentclaw/unarr/internal/upgrade"
|
||||||
|
|
@ -25,16 +28,20 @@ var (
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
rootCmd = &cobra.Command{
|
rootCmd = &cobra.Command{
|
||||||
Use: "unarr",
|
Use: "unarr",
|
||||||
Short: "unarr — torrent search and management",
|
Version: Version,
|
||||||
Long: `unarr is a powerful terminal tool for torrent search and management.
|
Short: "Terminal torrent + debrid + usenet client — download, stream, transcode",
|
||||||
|
Long: `unarr is a terminal-native client that downloads torrents, debrid links,
|
||||||
Search 30+ torrent sources, inspect torrent quality, discover popular content,
|
and usenet (NZB) — all from the same binary. It streams content straight
|
||||||
find streaming providers, and manage your media collection — all from your terminal.
|
to mpv/vlc with sequential piece prioritization, transcodes on the fly via
|
||||||
|
ffmpeg with hardware acceleration (NVENC, QSV, VA-API, VideoToolbox), and
|
||||||
|
organizes your library into Movies/TV folders. Run it one-shot or as a
|
||||||
|
long-running daemon with a built-in WireGuard split-tunnel and remote
|
||||||
|
playback over Cloudflare Funnel.
|
||||||
|
|
||||||
Get started:
|
Get started:
|
||||||
unarr init First-time configuration wizard
|
unarr init First-time configuration wizard
|
||||||
unarr search "breaking bad" Search for content
|
unarr download <magnet|hash> Grab a torrent one-shot
|
||||||
unarr start Start the download daemon
|
unarr start Start the download daemon
|
||||||
|
|
||||||
Documentation: https://torrentclaw.com/cli
|
Documentation: https://torrentclaw.com/cli
|
||||||
|
|
@ -55,7 +62,7 @@ Source: https://github.com/torrentclaw/unarr`,
|
||||||
// Command groups for organized help output
|
// Command groups for organized help output
|
||||||
rootCmd.AddGroup(
|
rootCmd.AddGroup(
|
||||||
&cobra.Group{ID: "start", Title: "Getting Started:"},
|
&cobra.Group{ID: "start", Title: "Getting Started:"},
|
||||||
&cobra.Group{ID: "search", Title: "Search & Discovery:"},
|
&cobra.Group{ID: "search", Title: "Catalog & Discovery:"},
|
||||||
&cobra.Group{ID: "download", Title: "Downloads & Streaming:"},
|
&cobra.Group{ID: "download", Title: "Downloads & Streaming:"},
|
||||||
&cobra.Group{ID: "daemon", Title: "Daemon Management:"},
|
&cobra.Group{ID: "daemon", Title: "Daemon Management:"},
|
||||||
&cobra.Group{ID: "system", Title: "System & Diagnostics:"},
|
&cobra.Group{ID: "system", Title: "System & Diagnostics:"},
|
||||||
|
|
@ -105,6 +112,8 @@ Source: https://github.com/torrentclaw/unarr`,
|
||||||
daemonCmd.GroupID = "daemon"
|
daemonCmd.GroupID = "daemon"
|
||||||
vpnCmd := newVPNCmd()
|
vpnCmd := newVPNCmd()
|
||||||
vpnCmd.GroupID = "daemon"
|
vpnCmd.GroupID = "daemon"
|
||||||
|
funnelCmd := newFunnelCmd()
|
||||||
|
funnelCmd.GroupID = "daemon"
|
||||||
|
|
||||||
// System & Diagnostics
|
// System & Diagnostics
|
||||||
statsCmd := newStatsCmd()
|
statsCmd := newStatsCmd()
|
||||||
|
|
@ -149,6 +158,7 @@ Source: https://github.com/torrentclaw/unarr`,
|
||||||
statusCmd,
|
statusCmd,
|
||||||
daemonCmd,
|
daemonCmd,
|
||||||
vpnCmd,
|
vpnCmd,
|
||||||
|
funnelCmd,
|
||||||
// System & Diagnostics
|
// System & Diagnostics
|
||||||
statsCmd,
|
statsCmd,
|
||||||
doctorCmd,
|
doctorCmd,
|
||||||
|
|
@ -228,6 +238,21 @@ func getClient() *tc.Client {
|
||||||
|
|
||||||
opts = append(opts, tc.WithUserAgent("unarr/"+Version))
|
opts = append(opts, tc.WithUserAgent("unarr/"+Version))
|
||||||
|
|
||||||
|
// Mirror failover for the public-API client, matching the agent control-plane
|
||||||
|
// client's resilience: wrap the transport so search/popular/etc. rotate across
|
||||||
|
// cfg.Auth.Mirrors on a primary takedown, using the same MirrorPool TYPE +
|
||||||
|
// IsTransient policy the agent client uses (a fresh pool instance — the two
|
||||||
|
// clients fail over independently). WithRetry(0) disables the go-client's own
|
||||||
|
// retry loop so the transport owns failover exclusively (no nested
|
||||||
|
// retry×backoff on an outage). WithTimeout(30s) is set idiomatically and gives
|
||||||
|
// room for a couple of mirror attempts (go-client's bare default is 15s).
|
||||||
|
pool := agent.NewMirrorPool(cfg.Auth.APIURL, cfg.Auth.Mirrors)
|
||||||
|
opts = append(opts,
|
||||||
|
tc.WithHTTPClient(&http.Client{Transport: agent.NewMirrorRoundTripper(pool, nil)}),
|
||||||
|
tc.WithTimeout(30*time.Second),
|
||||||
|
tc.WithRetry(0, 0, 0),
|
||||||
|
)
|
||||||
|
|
||||||
apiClient = tc.NewClient(opts...)
|
apiClient = tc.NewClient(opts...)
|
||||||
return apiClient
|
return apiClient
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,7 @@ import (
|
||||||
"github.com/torrentclaw/unarr/internal/agent"
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
"github.com/torrentclaw/unarr/internal/config"
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
"github.com/torrentclaw/unarr/internal/library"
|
"github.com/torrentclaw/unarr/internal/library"
|
||||||
|
"github.com/torrentclaw/unarr/internal/library/mediainfo"
|
||||||
)
|
)
|
||||||
|
|
||||||
func newScanCmd() *cobra.Command {
|
func newScanCmd() *cobra.Command {
|
||||||
|
|
@ -139,6 +140,28 @@ func runScan(dirPath string, workers int, ffprobePath string, noSync bool) error
|
||||||
return enc.Encode(cache)
|
return enc.Encode(cache)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Pre-extract sidecars (text subs → WebVTT, panel frames → JPEG) into a hidden
|
||||||
|
// ".unarr" dir so playback gets instant subtitles/thumbnails and huge remuxes
|
||||||
|
// never hit the on-demand timeout. Best-effort + Ctrl-C interruptible (the scan
|
||||||
|
// itself is already saved).
|
||||||
|
if cfg.Library.CacheSubtitles || cfg.Library.CacheThumbnails || cfg.Library.Trickplay.Enabled {
|
||||||
|
if ff, err := mediainfo.ResolveFFmpeg(cfg.Library.FFmpegPath); err == nil {
|
||||||
|
fmt.Fprintf(os.Stderr, " Pre-extracting subtitles + thumbnails to cache… (Ctrl-C to skip)\n")
|
||||||
|
library.PrewarmSidecars(ctx, cache, library.PrewarmOptions{
|
||||||
|
FFmpegPath: ff,
|
||||||
|
CacheSubtitles: cfg.Library.CacheSubtitles,
|
||||||
|
CacheThumbnails: cfg.Library.CacheThumbnails,
|
||||||
|
Workers: 2,
|
||||||
|
Trickplay: cfg.Library.Trickplay.Enabled,
|
||||||
|
TrickplayIntervalSec: cfg.Library.Trickplay.IntervalSeconds(),
|
||||||
|
TrickplayWidth: cfg.Library.Trickplay.Width,
|
||||||
|
MaxLoadRatio: cfg.Library.PrewarmMaxLoadRatio,
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(os.Stderr, " Skipping sidecar prewarm: ffmpeg unavailable: %v\n", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Sync to server
|
// Sync to server
|
||||||
if !noSync {
|
if !noSync {
|
||||||
return syncToServer(ctx, cfg, cache)
|
return syncToServer(ctx, cfg, cache)
|
||||||
|
|
@ -186,6 +209,7 @@ func syncToServer(ctx context.Context, cfg config.Config, cache *library.Library
|
||||||
resp, err := ac.SyncLibrary(ctx, agent.LibrarySyncRequest{
|
resp, err := ac.SyncLibrary(ctx, agent.LibrarySyncRequest{
|
||||||
Items: batch,
|
Items: batch,
|
||||||
ScanPath: cache.Path,
|
ScanPath: cache.Path,
|
||||||
|
AgentID: cfg.Agent.ID,
|
||||||
IsLastBatch: isLast,
|
IsLastBatch: isLast,
|
||||||
SyncStartedAt: syncStartedAt,
|
SyncStartedAt: syncStartedAt,
|
||||||
})
|
})
|
||||||
|
|
@ -241,7 +265,7 @@ func printScanSummary(cache *library.LibraryCache) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
res := library.ResolveResolution(item.MediaInfo.Video.Height)
|
res := library.ResolveResolution(item.MediaInfo.Video.Width, item.MediaInfo.Video.Height)
|
||||||
if res == "" {
|
if res == "" {
|
||||||
res = "other"
|
res = "other"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -87,10 +87,17 @@ func cancelStreamTask(taskID string) {
|
||||||
// handleStreamTask manages a streaming task lifecycle for active torrent downloads.
|
// handleStreamTask manages a streaming task lifecycle for active torrent downloads.
|
||||||
// It creates a StreamEngine, buffers, sets the file on the persistent server,
|
// It creates a StreamEngine, buffers, sets the file on the persistent server,
|
||||||
// and reports progress until the task is cancelled or the download completes.
|
// and reports progress until the task is cancelled or the download completes.
|
||||||
func handleStreamTask(parentCtx context.Context, at agent.Task, reporter *engine.ProgressReporter, cfg config.Config, agentClient *agent.Client, srv *engine.StreamServer) {
|
func handleStreamTask(parentCtx context.Context, at agent.Task, reporter *engine.ProgressReporter, cfg config.Config, agentClient *agent.Client, srv *engine.StreamServer, onStateChange func()) {
|
||||||
ctx, cancel := context.WithCancel(parentCtx)
|
ctx, cancel := context.WithCancel(parentCtx)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
|
// NOTE: we deliberately do NOT cancel prior stream goroutines here. The
|
||||||
|
// persistent StreamServer is last-writer-wins (SetFile replaces the file;
|
||||||
|
// the deferred ClearFile is guarded by CurrentTaskID), so a displaced prior
|
||||||
|
// goroutine simply parks on its own ctx until the 30m idle guard reaps it —
|
||||||
|
// cheap. Cancelling them at entry would abort an in-flight debrid HEAD of a
|
||||||
|
// concurrently-starting task (size resolution), failing that stream.
|
||||||
|
|
||||||
// Register for web-initiated cancellation
|
// Register for web-initiated cancellation
|
||||||
streamRegistry.mu.Lock()
|
streamRegistry.mu.Lock()
|
||||||
streamRegistry.cancels[at.ID] = cancel
|
streamRegistry.cancels[at.ID] = cancel
|
||||||
|
|
@ -106,10 +113,55 @@ func handleStreamTask(parentCtx context.Context, at agent.Task, reporter *engine
|
||||||
}()
|
}()
|
||||||
|
|
||||||
task := engine.NewTaskFromAgent(at)
|
task := engine.NewTaskFromAgent(at)
|
||||||
|
// Event-driven uplink: stream tasks transition outside the Manager (which
|
||||||
|
// wires this for downloads), so set it here too — resolving/downloading/
|
||||||
|
// completed/failed get pushed to the server immediately.
|
||||||
|
task.SetOnChange(onStateChange)
|
||||||
task.ResolvedMethod = engine.MethodTorrent
|
task.ResolvedMethod = engine.MethodTorrent
|
||||||
reporter.Track(task)
|
reporter.Track(task)
|
||||||
defer reporter.ReportFinal(context.Background(), task)
|
defer reporter.ReportFinal(context.Background(), task)
|
||||||
|
|
||||||
|
// Debrid passthrough: when the web resolved a direct HTTPS link (the torrent
|
||||||
|
// is cached on the user's debrid + preferredMethod=debrid), stream FROM that
|
||||||
|
// link instead of joining the P2P swarm — served over the SAME /stream
|
||||||
|
// endpoint, so VLC / external players consume it identically (and far
|
||||||
|
// faster). No HLS transcode here: external players handle any container.
|
||||||
|
// Falls through to the P2P StreamEngine below when there is no direct URL.
|
||||||
|
if at.DirectURL != "" {
|
||||||
|
task.ResolvedMethod = engine.MethodDebrid
|
||||||
|
task.Transition(engine.StatusResolving)
|
||||||
|
bctx, bcancel := context.WithTimeout(ctx, 15*time.Second)
|
||||||
|
// fallbackSize 0 → provider derives size from a HEAD; refresh nil → no
|
||||||
|
// task-level link-refresh endpoint exists (the web re-resolves stale
|
||||||
|
// debrid URLs at the next claim). A mid-stream expiry just ends the
|
||||||
|
// stream and the user re-opens it.
|
||||||
|
provider, perr := engine.NewDebridFileProvider(bctx, at.DirectURL, at.DirectFileName, 0, nil)
|
||||||
|
bcancel()
|
||||||
|
if perr != nil {
|
||||||
|
task.ErrorMessage = "debrid stream provider: " + perr.Error()
|
||||||
|
task.Transition(engine.StatusFailed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
srv.SetFile(provider, at.ID)
|
||||||
|
task.FileName = provider.FileName()
|
||||||
|
task.TotalBytes = provider.FileSize()
|
||||||
|
task.SetStreamURL(srv.URLsJSON()) // mutex-safe: the reporter reads it via GetStreamURL
|
||||||
|
log.Printf("[%s] stream (debrid): %s (%s) url: %s", at.ID[:8], provider.FileName(), ui.FormatBytes(provider.FileSize()), srv.URL())
|
||||||
|
|
||||||
|
if agentClient != nil {
|
||||||
|
watchReporter := engine.NewWatchReporter(agentClient, srv, at.ID)
|
||||||
|
go watchReporter.Run(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Debrid serves a complete remote file — there is no download to track,
|
||||||
|
// so mark it complete immediately (the UI shows "ready"). The persistent
|
||||||
|
// server keeps serving until the idle guard reaps it (30m), same as P2P.
|
||||||
|
task.Transition(engine.StatusCompleted)
|
||||||
|
<-ctx.Done()
|
||||||
|
log.Printf("[%s] stream (debrid) stopped", at.ID[:8])
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// 1. Create StreamEngine
|
// 1. Create StreamEngine
|
||||||
eng, err := engine.NewStreamEngine(engine.StreamConfig{
|
eng, err := engine.NewStreamEngine(engine.StreamConfig{
|
||||||
DataDir: cfg.Download.Dir,
|
DataDir: cfg.Download.Dir,
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
// Version is the CLI version. Overridden by goreleaser ldflags at release time.
|
// Version is the CLI version. Overridden by goreleaser ldflags at release time.
|
||||||
var Version = "0.9.4"
|
var Version = "1.0.2-beta"
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ import (
|
||||||
"runtime"
|
"runtime"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/BurntSushi/toml"
|
"github.com/BurntSushi/toml"
|
||||||
)
|
)
|
||||||
|
|
@ -39,20 +40,55 @@ type AgentConfig struct {
|
||||||
}
|
}
|
||||||
|
|
||||||
type DownloadConfig struct {
|
type DownloadConfig struct {
|
||||||
Dir string `toml:"dir"`
|
Dir string `toml:"dir"`
|
||||||
PreferredMethod string `toml:"preferred_method"`
|
PreferredMethod string `toml:"preferred_method"`
|
||||||
PreferredQuality string `toml:"preferred_quality"` // "2160p", "1080p", "720p" — hint for auto-selection
|
PreferredQuality string `toml:"preferred_quality"` // "2160p", "1080p", "720p" — hint for auto-selection
|
||||||
MaxConcurrent int `toml:"max_concurrent"`
|
MaxConcurrent int `toml:"max_concurrent"`
|
||||||
MaxDownloadSpeed string `toml:"max_download_speed"` // e.g. "10MB", "500KB", "0" = unlimited
|
MinFreeDiskMB int `toml:"min_free_disk_mb"` // refuse a download if it would leave less than this free (reserve to keep the FS healthy); default 2048, 0 = disable
|
||||||
MaxUploadSpeed string `toml:"max_upload_speed"` // e.g. "1MB", "0" = unlimited
|
MaxDownloadSpeed string `toml:"max_download_speed"` // e.g. "10MB", "500KB", "0" = unlimited
|
||||||
MetadataTimeout string `toml:"metadata_timeout"` // e.g. "1h", "30m", "0" = unlimited (default: "0")
|
MaxUploadSpeed string `toml:"max_upload_speed"` // e.g. "1MB", "0" = unlimited
|
||||||
StallTimeout string `toml:"stall_timeout"` // e.g. "30m", "1h", "0" = unlimited (default: "30m")
|
// Seeding lifecycle (BitTorrent only). Off by default — the daemon leeches
|
||||||
ListenPort int `toml:"listen_port"` // fixed port for incoming peer connections (default: 42069, 0 = random)
|
// then drops the torrent. Enable to keep uploading after a download finishes;
|
||||||
StreamPort int `toml:"stream_port"` // fixed port for streaming HTTP server (default: 11818)
|
// seeding stops at whichever target is hit first, or never if both are unset.
|
||||||
EnableUPnP bool `toml:"enable_upnp"` // map StreamPort to the WAN via UPnP/NAT-PMP (default: false; opt-in because it exposes the unauthenticated /stream + /hls endpoints to the public internet)
|
SeedEnabled bool `toml:"seed_enabled"` // keep uploading after completion (default: false)
|
||||||
CORSExtraOrigins []string `toml:"cors_extra_origins"` // extra browser origins added on top of the baked-in allowlist (torrentclaw.com, app.torrentclaw.com, localhost:3030)
|
SeedRatio float64 `toml:"seed_ratio"` // stop once uploaded/size reaches this ratio (0 = no ratio target)
|
||||||
Transcode TranscodeConfig `toml:"transcode"`
|
SeedTime string `toml:"seed_time"` // stop after this long since completion, e.g. "24h" (0/"" = no time target)
|
||||||
VPN VPNConfig `toml:"vpn"`
|
MetadataTimeout string `toml:"metadata_timeout"` // e.g. "1h", "30m", "0" = unlimited (default: "0")
|
||||||
|
StallTimeout string `toml:"stall_timeout"` // e.g. "30m", "1h", "0" = unlimited (default: "30m")
|
||||||
|
ListenPort int `toml:"listen_port"` // fixed port for incoming peer connections (default: 42069, 0 = random)
|
||||||
|
StreamPort int `toml:"stream_port"` // fixed port for streaming HTTP server (default: 11818)
|
||||||
|
HTTPSStreamPort int `toml:"https_stream_port"` // HTTPS stream listener for direct valid-cert playback (default: 11819, 0 = disabled). Only serves once a certificate is present (agent-TLS feature).
|
||||||
|
EnableUPnP bool `toml:"enable_upnp"` // map StreamPort to the WAN via UPnP/NAT-PMP (default: false; opt-in)
|
||||||
|
// RequireStreamToken gates remote (non-loopback) /stream + /hls requests on a
|
||||||
|
// signed, short-lived token embedded in the URLs the agent reports. Default
|
||||||
|
// true (secure by default); loopback callers (local mpv/vlc) are always exempt.
|
||||||
|
// Set false only to debug a player that can't carry the token.
|
||||||
|
RequireStreamToken bool `toml:"require_stream_token"`
|
||||||
|
CORSExtraOrigins []string `toml:"cors_extra_origins"` // extra browser origins added on top of the baked-in allowlist (torrentclaw.com, app.torrentclaw.com, localhost:3030)
|
||||||
|
Transcode TranscodeConfig `toml:"transcode"`
|
||||||
|
HLSCache HLSCacheConfig `toml:"hls_cache"`
|
||||||
|
VPN VPNConfig `toml:"vpn"`
|
||||||
|
Funnel FunnelConfig `toml:"funnel"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// HLSCacheConfig controls the persistent HLS segment cache. A completed encode
|
||||||
|
// is kept on disk so a second play of the same file at the same quality skips
|
||||||
|
// ffmpeg entirely. Old entries are evicted (LRU) once the cache exceeds the
|
||||||
|
// size budget. Enabled by default — disable to save disk space at the cost of
|
||||||
|
// re-encoding every play.
|
||||||
|
type HLSCacheConfig struct {
|
||||||
|
Enabled bool `toml:"enabled"` // default: true
|
||||||
|
SizeGB int `toml:"size_gb"` // size budget in gigabytes; default: 5; minimum: 1
|
||||||
|
Dir string `toml:"dir"` // override storage path; default: ~/.cache/unarr/hls-cache
|
||||||
|
}
|
||||||
|
|
||||||
|
// FunnelConfig gates the optional CloudFlare Quick Tunnel that exposes the
|
||||||
|
// daemon's HLS server over a public HTTPS hostname (https://<random>.try
|
||||||
|
// cloudflare.com). Enabling it lets the web player on torrentclaw.com play
|
||||||
|
// from this daemon across any network without Tailscale or a public IP —
|
||||||
|
// the cost is that bytes proxy through CloudFlare's network. Off by default.
|
||||||
|
type FunnelConfig struct {
|
||||||
|
Enabled bool `toml:"enabled"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// VPNConfig gates the managed-VPN add-on split-tunnel. When enabled, the daemon
|
// VPNConfig gates the managed-VPN add-on split-tunnel. When enabled, the daemon
|
||||||
|
|
@ -74,9 +110,27 @@ type VPNConfig struct {
|
||||||
// Disabled by default; enabling requires ffmpeg + ffprobe on PATH (or
|
// Disabled by default; enabling requires ffmpeg + ffprobe on PATH (or
|
||||||
// explicit paths via the library config).
|
// explicit paths via the library config).
|
||||||
type TranscodeConfig struct {
|
type TranscodeConfig struct {
|
||||||
Enabled bool `toml:"enabled"` // master switch
|
Enabled bool `toml:"enabled"` // master switch
|
||||||
HWAccel string `toml:"hw_accel"` // "auto" | "none" | "nvenc" | "qsv" | "vaapi" | "videotoolbox"
|
HWAccel string `toml:"hw_accel"` // "auto" | "none" | "nvenc" | "qsv" | "vaapi" | "videotoolbox"
|
||||||
Preset string `toml:"preset"` // libx264 preset; "veryfast" by default
|
// Preset is the encoder speed/quality dial. Only used on software encode
|
||||||
|
// (libx264) — HW backends (NVENC/QSV/VAAPI/VideoToolbox) use vendor
|
||||||
|
// presets that don't share libx264's vocabulary and would be rejected
|
||||||
|
// by ffmpeg if passed here.
|
||||||
|
//
|
||||||
|
// Empty (default) → engine picks "superfast" — latency-biased, ~3 s
|
||||||
|
// first-play on 1080p source on a modern x86 CPU. Marginal quality loss
|
||||||
|
// at 5-25 Mbps target bitrates.
|
||||||
|
//
|
||||||
|
// For better quality at slower first-play (1-2 s slower per seg):
|
||||||
|
// "veryfast" — previous default; balanced
|
||||||
|
// "faster" — slight quality bump
|
||||||
|
// "fast" — meaningful quality bump
|
||||||
|
// "medium" — libx264 stock default; CPU-bound on 4K
|
||||||
|
// "slow" / "slower" / "veryslow" — only for batch encodes, not real-time HLS
|
||||||
|
//
|
||||||
|
// Or faster:
|
||||||
|
// "ultrafast" — lowest quality, fastest encode
|
||||||
|
Preset string `toml:"preset"`
|
||||||
VideoBitrate string `toml:"video_bitrate"` // e.g. "5M"
|
VideoBitrate string `toml:"video_bitrate"` // e.g. "5M"
|
||||||
AudioBitrate string `toml:"audio_bitrate"` // e.g. "192k"
|
AudioBitrate string `toml:"audio_bitrate"` // e.g. "192k"
|
||||||
MaxHeight int `toml:"max_height"` // optional downscale cap (e.g. 720)
|
MaxHeight int `toml:"max_height"` // optional downscale cap (e.g. 720)
|
||||||
|
|
@ -91,8 +145,32 @@ type OrganizeConfig struct {
|
||||||
|
|
||||||
type DaemonConfig struct {
|
type DaemonConfig struct {
|
||||||
StatusInterval string `toml:"status_interval"`
|
StatusInterval string `toml:"status_interval"`
|
||||||
|
// AutoUpgrade gates the daemon's response to a server-flagged upgrade
|
||||||
|
// (set via the "Force update" button on the web). When true the daemon
|
||||||
|
// downloads + replaces the binary in-place and exits so the service
|
||||||
|
// supervisor respawns on the new version. When false the daemon only
|
||||||
|
// logs "new version available" and the operator must run `unarr update`
|
||||||
|
// manually. Default: true. Available since unarr 0.9.6.
|
||||||
|
AutoUpgrade *bool `toml:"auto_upgrade"`
|
||||||
|
// Downlink selects the server→agent realtime transport. "auto" (default)
|
||||||
|
// uses an SSE push connection with the long-poll wake as a buffering-tolerant
|
||||||
|
// fallback; "sse" forces SSE only (no fallback); "poll" forces the pre-0.14
|
||||||
|
// long-poll wake only. Empty = "auto". Available since unarr 0.14.0.
|
||||||
|
Downlink string `toml:"downlink"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AutoUpgradeEnabled returns the resolved AutoUpgrade flag — defaults to true
|
||||||
|
// when the user has not set it explicitly. Pointer-vs-bool because Go's
|
||||||
|
// zero-value bool would collapse "unset" and "false" together.
|
||||||
|
func (d DaemonConfig) AutoUpgradeEnabled() bool {
|
||||||
|
if d.AutoUpgrade == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return *d.AutoUpgrade
|
||||||
|
}
|
||||||
|
|
||||||
|
func boolPtr(v bool) *bool { return &v }
|
||||||
|
|
||||||
type NotificationsConfig struct {
|
type NotificationsConfig struct {
|
||||||
Enabled bool `toml:"enabled"`
|
Enabled bool `toml:"enabled"`
|
||||||
}
|
}
|
||||||
|
|
@ -112,6 +190,43 @@ type LibraryConfig struct {
|
||||||
AutoScan bool `toml:"auto_scan"` // enable daily auto-scan in daemon (default true)
|
AutoScan bool `toml:"auto_scan"` // enable daily auto-scan in daemon (default true)
|
||||||
ScanInterval string `toml:"scan_interval"` // e.g. "24h", "12h", "6h" (default "24h")
|
ScanInterval string `toml:"scan_interval"` // e.g. "24h", "12h", "6h" (default "24h")
|
||||||
AllowDelete bool `toml:"allow_delete"` // allow web UI to request file deletion from disk
|
AllowDelete bool `toml:"allow_delete"` // allow web UI to request file deletion from disk
|
||||||
|
|
||||||
|
// Sidecar caching: extract text subtitles (WebVTT) and thumbnail frames once
|
||||||
|
// during the library scan and store them in a hidden ".unarr" dir next to the
|
||||||
|
// media file, so the stream handlers serve them instantly instead of running
|
||||||
|
// ffmpeg per request (and so huge remuxes don't hit the on-demand HTTP
|
||||||
|
// timeout). Both default true; disable to save the disk/CPU of pre-extraction.
|
||||||
|
CacheSubtitles bool `toml:"cache_subtitles"` // default true
|
||||||
|
CacheThumbnails bool `toml:"cache_thumbnails"` // default true
|
||||||
|
|
||||||
|
// Trickplay: at scan time, build ONE montage JPEG of frames sampled every
|
||||||
|
// Interval seconds (+ a JSON manifest), cached in .unarr next to the media.
|
||||||
|
// The web scrubber shows tiles from it — no live ffmpeg during playback, so
|
||||||
|
// no contention with the active stream (the cause of broken seekbar previews)
|
||||||
|
// — and the file panel picks a few positions from the same grid.
|
||||||
|
Trickplay TrickplayConfig `toml:"trickplay"`
|
||||||
|
|
||||||
|
// PrewarmMaxLoadRatio gates the heavy trickplay decode on system load: a sprite
|
||||||
|
// job only starts while the 1-min load average is ≤ this × NumCPU, so scan-time
|
||||||
|
// generation never saturates the machine or the NAS. Default 0.7; 0 falls back
|
||||||
|
// to the default. Linux-only (no load reading elsewhere → unthrottled).
|
||||||
|
PrewarmMaxLoadRatio float64 `toml:"prewarm_max_load_ratio"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TrickplayConfig controls scan-time trickplay sprite generation.
|
||||||
|
type TrickplayConfig struct {
|
||||||
|
Enabled bool `toml:"enabled"` // generate the sprite during scan (default true)
|
||||||
|
Interval string `toml:"interval"` // one frame per Interval, e.g. "10s" (default)
|
||||||
|
Width int `toml:"width"` // tile width px; height keeps aspect (default 240)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntervalSeconds parses Interval ("10s") to seconds, falling back to 10 on an
|
||||||
|
// empty/invalid value so a typo can't silently disable the sprite.
|
||||||
|
func (t TrickplayConfig) IntervalSeconds() float64 {
|
||||||
|
if d, err := time.ParseDuration(strings.TrimSpace(t.Interval)); err == nil && d > 0 {
|
||||||
|
return d.Seconds()
|
||||||
|
}
|
||||||
|
return 10
|
||||||
}
|
}
|
||||||
|
|
||||||
// Default returns a Config with sensible defaults. Used both for fresh
|
// Default returns a Config with sensible defaults. Used both for fresh
|
||||||
|
|
@ -129,21 +244,47 @@ func Default() Config {
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
Download: DownloadConfig{
|
Download: DownloadConfig{
|
||||||
PreferredMethod: "auto",
|
PreferredMethod: "auto",
|
||||||
MaxConcurrent: 3,
|
MaxConcurrent: 3,
|
||||||
StreamPort: 11818,
|
MinFreeDiskMB: 2048, // 2 GiB reserve
|
||||||
|
StreamPort: 11818,
|
||||||
|
HTTPSStreamPort: 11819,
|
||||||
|
RequireStreamToken: true, // secure by default; loopback exempt
|
||||||
Transcode: TranscodeConfig{
|
Transcode: TranscodeConfig{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
HWAccel: "auto",
|
HWAccel: "auto",
|
||||||
Preset: "veryfast",
|
// Empty preset → engine.ResolveEncoderProfile picks the
|
||||||
|
// latency-biased default ("superfast" on libx264). Override
|
||||||
|
// in config.toml when quality > first-start latency matters.
|
||||||
|
Preset: "",
|
||||||
AudioBitrate: "192k",
|
AudioBitrate: "192k",
|
||||||
MaxConcurrent: 2,
|
MaxConcurrent: 2,
|
||||||
},
|
},
|
||||||
|
Funnel: FunnelConfig{
|
||||||
|
// On by default so headless installs (NAS / Docker) get cross-network
|
||||||
|
// HTTPS playback without anyone having to terminal in. Users who
|
||||||
|
// don't want bytes proxied through CloudFlare can opt out with
|
||||||
|
// `unarr funnel off` (sets enabled=false in the TOML).
|
||||||
|
Enabled: true,
|
||||||
|
},
|
||||||
|
HLSCache: HLSCacheConfig{
|
||||||
|
// On by default — second play of a recently watched file at the
|
||||||
|
// same quality skips ffmpeg (instant start, near-zero CPU).
|
||||||
|
// Users can opt out (hls_cache.enabled=false) or shrink the
|
||||||
|
// budget (hls_cache.size_gb) when disk is tight.
|
||||||
|
Enabled: true,
|
||||||
|
SizeGB: 5,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Daemon: DaemonConfig{
|
||||||
|
// Pointer-to-true so Default() round-trips through TOML marshal
|
||||||
|
// as `auto_upgrade = true` instead of an omitted key — keeps the
|
||||||
|
// freshly-written config aligned with what README documents.
|
||||||
|
AutoUpgrade: boolPtr(true),
|
||||||
},
|
},
|
||||||
Organize: OrganizeConfig{
|
Organize: OrganizeConfig{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
},
|
},
|
||||||
Daemon: DaemonConfig{},
|
|
||||||
Notifications: NotificationsConfig{
|
Notifications: NotificationsConfig{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
},
|
},
|
||||||
|
|
@ -152,9 +293,17 @@ func Default() Config {
|
||||||
Locale: "en",
|
Locale: "en",
|
||||||
},
|
},
|
||||||
Library: LibraryConfig{
|
Library: LibraryConfig{
|
||||||
AutoScan: true,
|
AutoScan: true,
|
||||||
ScanInterval: "24h",
|
ScanInterval: "24h",
|
||||||
Workers: 8,
|
Workers: 8,
|
||||||
|
CacheSubtitles: true,
|
||||||
|
CacheThumbnails: true,
|
||||||
|
Trickplay: TrickplayConfig{
|
||||||
|
Enabled: true,
|
||||||
|
Interval: "10s",
|
||||||
|
Width: 240,
|
||||||
|
},
|
||||||
|
PrewarmMaxLoadRatio: 0.7,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -205,13 +354,46 @@ func applyDefaults(cfg *Config, meta toml.MetaData) {
|
||||||
if !meta.IsDefined("downloads", "max_concurrent") {
|
if !meta.IsDefined("downloads", "max_concurrent") {
|
||||||
cfg.Download.MaxConcurrent = 3
|
cfg.Download.MaxConcurrent = 3
|
||||||
}
|
}
|
||||||
|
if !meta.IsDefined("downloads", "min_free_disk_mb") {
|
||||||
|
cfg.Download.MinFreeDiskMB = 2048 // 2 GiB reserve so a download never fills the FS to 0
|
||||||
|
}
|
||||||
if !meta.IsDefined("downloads", "stream_port") {
|
if !meta.IsDefined("downloads", "stream_port") {
|
||||||
cfg.Download.StreamPort = 11818
|
cfg.Download.StreamPort = 11818
|
||||||
}
|
}
|
||||||
|
if !meta.IsDefined("downloads", "https_stream_port") {
|
||||||
|
cfg.Download.HTTPSStreamPort = 11819
|
||||||
|
}
|
||||||
if !meta.IsDefined("general", "country") {
|
if !meta.IsDefined("general", "country") {
|
||||||
cfg.General.Country = "US"
|
cfg.General.Country = "US"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Sidecar caching defaults ON for existing configs that predate these keys —
|
||||||
|
// it only adds small hidden files next to media and makes subs/thumbnails
|
||||||
|
// instant. Power users can set them false explicitly to opt out.
|
||||||
|
if !meta.IsDefined("library", "cache_subtitles") {
|
||||||
|
cfg.Library.CacheSubtitles = true
|
||||||
|
}
|
||||||
|
if !meta.IsDefined("library", "cache_thumbnails") {
|
||||||
|
cfg.Library.CacheThumbnails = true
|
||||||
|
}
|
||||||
|
// Trickplay defaults ON for configs predating these keys (small sidecar JPEG;
|
||||||
|
// makes the scrubber instant + contention-free). Explicit `enabled = false`
|
||||||
|
// is respected via meta.IsDefined.
|
||||||
|
if !meta.IsDefined("library", "trickplay", "enabled") {
|
||||||
|
cfg.Library.Trickplay.Enabled = true
|
||||||
|
}
|
||||||
|
if !meta.IsDefined("library", "trickplay", "interval") {
|
||||||
|
cfg.Library.Trickplay.Interval = "10s"
|
||||||
|
}
|
||||||
|
if !meta.IsDefined("library", "trickplay", "width") {
|
||||||
|
cfg.Library.Trickplay.Width = 240
|
||||||
|
}
|
||||||
|
// Load-gate defaults ON for configs predating the key, so an old install can't
|
||||||
|
// saturate the box with scan-time sprite generation.
|
||||||
|
if !meta.IsDefined("library", "prewarm_max_load_ratio") {
|
||||||
|
cfg.Library.PrewarmMaxLoadRatio = 0.7
|
||||||
|
}
|
||||||
|
|
||||||
if !meta.IsDefined("downloads", "transcode", "enabled") {
|
if !meta.IsDefined("downloads", "transcode", "enabled") {
|
||||||
cfg.Download.Transcode.Enabled = true
|
cfg.Download.Transcode.Enabled = true
|
||||||
}
|
}
|
||||||
|
|
@ -219,7 +401,12 @@ func applyDefaults(cfg *Config, meta toml.MetaData) {
|
||||||
cfg.Download.Transcode.HWAccel = "auto"
|
cfg.Download.Transcode.HWAccel = "auto"
|
||||||
}
|
}
|
||||||
if !meta.IsDefined("downloads", "transcode", "preset") {
|
if !meta.IsDefined("downloads", "transcode", "preset") {
|
||||||
cfg.Download.Transcode.Preset = "veryfast"
|
// Empty = let engine.ResolveEncoderProfile pick the latency-biased
|
||||||
|
// default ("superfast" on libx264). Users wanting better quality at
|
||||||
|
// slower first-play can override to "veryfast" / "fast" / "medium" in
|
||||||
|
// config.toml. Ignored when hw_accel picks NVENC/QSV/VAAPI/VideoToolbox
|
||||||
|
// (those have built-in vendor presets).
|
||||||
|
cfg.Download.Transcode.Preset = ""
|
||||||
}
|
}
|
||||||
if !meta.IsDefined("downloads", "transcode", "audio_bitrate") {
|
if !meta.IsDefined("downloads", "transcode", "audio_bitrate") {
|
||||||
cfg.Download.Transcode.AudioBitrate = "192k"
|
cfg.Download.Transcode.AudioBitrate = "192k"
|
||||||
|
|
@ -227,6 +414,12 @@ func applyDefaults(cfg *Config, meta toml.MetaData) {
|
||||||
if !meta.IsDefined("downloads", "transcode", "max_concurrent") {
|
if !meta.IsDefined("downloads", "transcode", "max_concurrent") {
|
||||||
cfg.Download.Transcode.MaxConcurrent = 2
|
cfg.Download.Transcode.MaxConcurrent = 2
|
||||||
}
|
}
|
||||||
|
// NOTE: Funnel default-ON only applies to fresh installs (no config file →
|
||||||
|
// Default() returns Funnel.Enabled=true straight off). When an existing
|
||||||
|
// config file lacks `[downloads.funnel]` entirely we intentionally do NOT
|
||||||
|
// flip it on here — that would silently route an upgraded operator's
|
||||||
|
// traffic through CloudFlare without their consent. They opt in with
|
||||||
|
// `unarr funnel on` whenever they're ready.
|
||||||
}
|
}
|
||||||
|
|
||||||
// Save writes config to the default or specified path using atomic write.
|
// Save writes config to the default or specified path using atomic write.
|
||||||
|
|
|
||||||
|
|
@ -215,8 +215,11 @@ name = "Test"
|
||||||
if cfg.Download.Transcode.HWAccel != "auto" {
|
if cfg.Download.Transcode.HWAccel != "auto" {
|
||||||
t.Errorf("Transcode.HWAccel = %q, want auto", cfg.Download.Transcode.HWAccel)
|
t.Errorf("Transcode.HWAccel = %q, want auto", cfg.Download.Transcode.HWAccel)
|
||||||
}
|
}
|
||||||
if cfg.Download.Transcode.Preset != "veryfast" {
|
if cfg.Download.Transcode.Preset != "" {
|
||||||
t.Errorf("Transcode.Preset = %q, want veryfast", cfg.Download.Transcode.Preset)
|
// Default is now empty — engine.ResolveEncoderProfile picks
|
||||||
|
// "superfast" on libx264 for first-start latency. Users
|
||||||
|
// wanting better quality override in config.toml.
|
||||||
|
t.Errorf("Transcode.Preset = %q, want empty", cfg.Download.Transcode.Preset)
|
||||||
}
|
}
|
||||||
if cfg.Download.Transcode.MaxConcurrent != 2 {
|
if cfg.Download.Transcode.MaxConcurrent != 2 {
|
||||||
t.Errorf("Transcode.MaxConcurrent = %d, want 2", cfg.Download.Transcode.MaxConcurrent)
|
t.Errorf("Transcode.MaxConcurrent = %d, want 2", cfg.Download.Transcode.MaxConcurrent)
|
||||||
|
|
@ -243,6 +246,55 @@ enabled = false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadSeedingDefaultsOff(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
path := filepath.Join(tmp, "config.toml")
|
||||||
|
|
||||||
|
// No [downloads] seeding keys — seeding must stay off by default.
|
||||||
|
os.WriteFile(path, []byte(`[auth]
|
||||||
|
api_key = "tc_x"
|
||||||
|
`), 0o644)
|
||||||
|
|
||||||
|
cfg, err := Load(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Load failed: %v", err)
|
||||||
|
}
|
||||||
|
if cfg.Download.SeedEnabled {
|
||||||
|
t.Error("SeedEnabled should default to false")
|
||||||
|
}
|
||||||
|
if cfg.Download.SeedRatio != 0 {
|
||||||
|
t.Errorf("SeedRatio = %v, want 0", cfg.Download.SeedRatio)
|
||||||
|
}
|
||||||
|
if cfg.Download.SeedTime != "" {
|
||||||
|
t.Errorf("SeedTime = %q, want empty", cfg.Download.SeedTime)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadSeedingExplicit(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
path := filepath.Join(tmp, "config.toml")
|
||||||
|
|
||||||
|
os.WriteFile(path, []byte(`[downloads]
|
||||||
|
seed_enabled = true
|
||||||
|
seed_ratio = 2.0
|
||||||
|
seed_time = "24h"
|
||||||
|
`), 0o644)
|
||||||
|
|
||||||
|
cfg, err := Load(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Load failed: %v", err)
|
||||||
|
}
|
||||||
|
if !cfg.Download.SeedEnabled {
|
||||||
|
t.Error("SeedEnabled = false, want true")
|
||||||
|
}
|
||||||
|
if cfg.Download.SeedRatio != 2.0 {
|
||||||
|
t.Errorf("SeedRatio = %v, want 2.0", cfg.Download.SeedRatio)
|
||||||
|
}
|
||||||
|
if cfg.Download.SeedTime != "24h" {
|
||||||
|
t.Errorf("SeedTime = %q, want 24h", cfg.Download.SeedTime)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadInvalidTOML(t *testing.T) {
|
func TestLoadInvalidTOML(t *testing.T) {
|
||||||
tmp := t.TempDir()
|
tmp := t.TempDir()
|
||||||
path := filepath.Join(tmp, "config.toml")
|
path := filepath.Join(tmp, "config.toml")
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,8 @@ var httpClient = &http.Client{
|
||||||
type DebridDownloader struct {
|
type DebridDownloader struct {
|
||||||
activeMu sync.Mutex
|
activeMu sync.Mutex
|
||||||
active map[string]context.CancelFunc
|
active map[string]context.CancelFunc
|
||||||
|
|
||||||
|
minFreeBytes int64 // disk reserve for the pre-flight space check (0 = reserve disabled)
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewDebridDownloader creates a debrid downloader.
|
// NewDebridDownloader creates a debrid downloader.
|
||||||
|
|
@ -36,6 +38,11 @@ func NewDebridDownloader() *DebridDownloader {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetMinFreeBytes sets the free-space reserve enforced before a download starts.
|
||||||
|
// Call once at construction; 0 disables the reserve (the size-vs-free check still
|
||||||
|
// runs). See CheckDiskSpace.
|
||||||
|
func (d *DebridDownloader) SetMinFreeBytes(n int64) { d.minFreeBytes = n }
|
||||||
|
|
||||||
func (d *DebridDownloader) Method() DownloadMethod { return MethodDebrid }
|
func (d *DebridDownloader) Method() DownloadMethod { return MethodDebrid }
|
||||||
|
|
||||||
// Available returns true if the task has a direct HTTPS URL from the server.
|
// Available returns true if the task has a direct HTTPS URL from the server.
|
||||||
|
|
@ -167,6 +174,12 @@ func (d *DebridDownloader) Download(ctx context.Context, task *Task, outputDir s
|
||||||
log.Printf("[%s] starting debrid download: %s", agent.ShortID(task.ID), fileName)
|
log.Printf("[%s] starting debrid download: %s", agent.ShortID(task.ID), fileName)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Pre-flight disk-space guard on the bytes still to write (resume subtracts
|
||||||
|
// what's already on disk). Best-effort; ENOSPC stays the backstop.
|
||||||
|
if err := CheckDiskSpace(outputDir, totalBytes-startOffset, d.minFreeBytes); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
|
if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
|
||||||
return nil, fmt.Errorf("create directory: %w", err)
|
return nil, fmt.Errorf("create directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
63
internal/engine/diskspace.go
Normal file
63
internal/engine/diskspace.go
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InsufficientDiskError is returned by CheckDiskSpace when a download's expected
|
||||||
|
// size (plus a reserve that keeps the filesystem healthy) won't fit in the free
|
||||||
|
// space of its target directory. The manager treats it as terminal — it does NOT
|
||||||
|
// fall back to another source (a different source would fill the same disk) and
|
||||||
|
// surfaces the message to the web as the task's error.
|
||||||
|
type InsufficientDiskError struct {
|
||||||
|
Dir string
|
||||||
|
Need int64 // bytes the download still needs to write
|
||||||
|
Free int64 // bytes currently free on Dir's filesystem
|
||||||
|
Reserve int64 // bytes to keep free after the download
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *InsufficientDiskError) Error() string {
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"insufficient disk space in %s: need %s + %s reserve, only %s free",
|
||||||
|
e.Dir, formatBytes(e.Need), formatBytes(e.Reserve), formatBytes(e.Free),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsInsufficientDisk reports whether err is (or wraps) an InsufficientDiskError.
|
||||||
|
func IsInsufficientDisk(err error) bool {
|
||||||
|
var d *InsufficientDiskError
|
||||||
|
return errors.As(err, &d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckDiskSpace fails fast when dir's filesystem can't hold needBytes while
|
||||||
|
// keeping reserveBytes free. It's the pre-flight guard so a download never fills
|
||||||
|
// the disk to 0 mid-write (which corrupts the partial file and can wedge the OS).
|
||||||
|
//
|
||||||
|
// Best-effort by design: a non-positive needBytes (size unknown) or a failure to
|
||||||
|
// stat the filesystem returns nil rather than block a download on a guard we
|
||||||
|
// can't evaluate — the OS-level ENOSPC stays the backstop.
|
||||||
|
func CheckDiskSpace(dir string, needBytes, reserveBytes int64) error {
|
||||||
|
if needBytes <= 0 {
|
||||||
|
return nil // size unknown — nothing to check against
|
||||||
|
}
|
||||||
|
free, _, err := agent.DiskInfo(dir)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[disk] free-space pre-flight skipped for %q: stat error: %v", dir, err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if free <= 0 {
|
||||||
|
// Distinct from a stat error: DiskInfo succeeded but reports no free
|
||||||
|
// space. Don't block on a value we can't trust (0/negative) — log it so a
|
||||||
|
// genuinely-full disk is visible rather than masked as a generic skip.
|
||||||
|
log.Printf("[disk] free-space pre-flight skipped for %q: DiskInfo reported non-positive free (%d)", dir, free)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if free-needBytes < reserveBytes {
|
||||||
|
return &InsufficientDiskError{Dir: dir, Need: needBytes, Free: free, Reserve: reserveBytes}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
56
internal/engine/diskspace_test.go
Normal file
56
internal/engine/diskspace_test.go
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCheckDiskSpace_Enough(t *testing.T) {
|
||||||
|
// A tiny need in a real temp dir (huge free space) → nil.
|
||||||
|
if err := CheckDiskSpace(t.TempDir(), 1024, 0); err != nil {
|
||||||
|
t.Errorf("expected nil for a 1 KiB need, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckDiskSpace_Insufficient(t *testing.T) {
|
||||||
|
// Need more than any real disk has → InsufficientDiskError.
|
||||||
|
err := CheckDiskSpace(t.TempDir(), 1<<62, 0)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected an error for an impossibly large need")
|
||||||
|
}
|
||||||
|
if !IsInsufficientDisk(err) {
|
||||||
|
t.Errorf("IsInsufficientDisk = false, want true (err=%v)", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "insufficient disk space") {
|
||||||
|
t.Errorf("error message = %q, want it to mention insufficient disk space", err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckDiskSpace_ReserveTriggers(t *testing.T) {
|
||||||
|
// Tiny need but an impossibly large reserve → free-need < reserve → error.
|
||||||
|
err := CheckDiskSpace(t.TempDir(), 1024, 1<<62)
|
||||||
|
if !IsInsufficientDisk(err) {
|
||||||
|
t.Errorf("expected insufficient when reserve exceeds free space, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckDiskSpace_UnknownSize(t *testing.T) {
|
||||||
|
// need <= 0 means the size is unknown — the check must be skipped, even with
|
||||||
|
// an enormous reserve.
|
||||||
|
if err := CheckDiskSpace(t.TempDir(), 0, 1<<62); err != nil {
|
||||||
|
t.Errorf("need=0 must skip the check, got %v", err)
|
||||||
|
}
|
||||||
|
if err := CheckDiskSpace(t.TempDir(), -5, 1<<62); err != nil {
|
||||||
|
t.Errorf("negative need must skip the check, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckDiskSpace_BadDirIsBestEffort(t *testing.T) {
|
||||||
|
// An unstat-able path → DiskInfo errors → best-effort nil (never block a
|
||||||
|
// download on a guard we can't evaluate; ENOSPC stays the backstop).
|
||||||
|
bad := filepath.Join(t.TempDir(), "does", "not", "exist")
|
||||||
|
if err := CheckDiskSpace(bad, 1<<40, 0); err != nil {
|
||||||
|
t.Errorf("unstat-able dir must skip the check, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
120
internal/engine/encode_benchmark.go
Normal file
120
internal/engine/encode_benchmark.go
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"os/exec"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// benchmarkRung is a candidate transcode-height ceiling plus the 16:9 frame
|
||||||
|
// size used to measure whether a software encoder sustains it.
|
||||||
|
type benchmarkRung struct {
|
||||||
|
height int
|
||||||
|
width int
|
||||||
|
}
|
||||||
|
|
||||||
|
// softwareBenchmarkRungs are tested high→low. The frame sizes match the real
|
||||||
|
// streaming output tiers; the H.264 level / macroblock math in hls.go is
|
||||||
|
// independent of what we measure here.
|
||||||
|
var softwareBenchmarkRungs = []benchmarkRung{
|
||||||
|
{height: 1080, width: 1920},
|
||||||
|
{height: 720, width: 1280},
|
||||||
|
{height: 480, width: 854},
|
||||||
|
}
|
||||||
|
|
||||||
|
// realtimeMarginSoftware is how much faster than realtime a synthetic encode
|
||||||
|
// must run before we call a rung "sustainable". 2.0× (not 1.5×) because the
|
||||||
|
// benchmark measures ONLY the encode of a low-entropy synthetic source and
|
||||||
|
// must cover two costs it never sees: (a) decoding the real source — software
|
||||||
|
// HEVC / 10-bit decode can rival the encode cost on its own — and (b) real
|
||||||
|
// content (film grain, motion) being far busier than testsrc2 for x264's
|
||||||
|
// rate-control + motion estimation. Erring high routes a borderline box's
|
||||||
|
// oversized sources to an external player (which works) instead of a
|
||||||
|
// stuttering transcode (which is the failure we're preventing).
|
||||||
|
const realtimeMarginSoftware = 2.0
|
||||||
|
|
||||||
|
// benchmarkClipSeconds is the synthetic clip length. Short enough that a
|
||||||
|
// capable host finishes the 1080p rung in well under a second, long enough to
|
||||||
|
// average out process spin-up.
|
||||||
|
const benchmarkClipSeconds = 3
|
||||||
|
|
||||||
|
// BenchmarkMaxTranscodeHeight returns the largest output height this host can
|
||||||
|
// software-transcode in real time, one of {1080,720,480}. Hardware encoders
|
||||||
|
// return 2160 WITHOUT benchmarking — NVENC/QSV/VAAPI/VideoToolbox all sustain
|
||||||
|
// 4K and a probe would only add startup latency.
|
||||||
|
//
|
||||||
|
// The point is the weak end. A low-power NAS or an old CPU can be
|
||||||
|
// ffmpeg-capable yet unable to keep up with a 1080p software encode, so the
|
||||||
|
// historical static 1080 ceiling makes the web side attempt a transcode that
|
||||||
|
// stutters. Measuring real throughput lets decideStreamPlan route oversized
|
||||||
|
// sources to an external player instead. Floors at 480: a box that can't
|
||||||
|
// sustain even that is barely functional, and 480-or-smaller sources transcode
|
||||||
|
// cheaply regardless — anything larger is already gated out by the 480 ceiling.
|
||||||
|
func BenchmarkMaxTranscodeHeight(ctx context.Context, ffmpegPath string, hw HWAccel) int {
|
||||||
|
if hw != HWAccelNone {
|
||||||
|
return 2160
|
||||||
|
}
|
||||||
|
if ffmpegPath == "" {
|
||||||
|
return 1080 // no benchmark possible; keep the historical default
|
||||||
|
}
|
||||||
|
measuredAny := false
|
||||||
|
for _, rung := range softwareBenchmarkRungs {
|
||||||
|
factor, ok := measureEncodeRealtimeFactor(ctx, ffmpegPath, rung)
|
||||||
|
if !ok {
|
||||||
|
// Probe couldn't run (timeout / exec error) — try a lighter rung
|
||||||
|
// rather than treat the failure as a measured "fast enough".
|
||||||
|
log.Printf("[transcode] encode benchmark: %dp probe failed — trying lower", rung.height)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
measuredAny = true
|
||||||
|
if factor >= realtimeMarginSoftware {
|
||||||
|
log.Printf("[transcode] encode benchmark: software ceiling %dp (%.1f× realtime)", rung.height, factor)
|
||||||
|
return rung.height
|
||||||
|
}
|
||||||
|
log.Printf("[transcode] encode benchmark: %dp only %.1f× realtime (<%.1f×) — trying lower", rung.height, factor, realtimeMarginSoftware)
|
||||||
|
}
|
||||||
|
if !measuredAny {
|
||||||
|
// No rung produced a measurement at all — the benchmark infrastructure
|
||||||
|
// failed (missing lavfi/testsrc2, ffmpeg wedged), NOT a slow host. Don't
|
||||||
|
// punish a possibly-capable box by flooring at 480; keep the historical
|
||||||
|
// default so behaviour is no worse than before the benchmark existed.
|
||||||
|
log.Printf("[transcode] encode benchmark: no rung could be measured (lavfi/ffmpeg issue) — keeping default 1080 ceiling")
|
||||||
|
return 1080
|
||||||
|
}
|
||||||
|
log.Printf("[transcode] encode benchmark: host can't sustain 480p software encode — flooring ceiling at 480 (oversized sources route to external)")
|
||||||
|
return 480
|
||||||
|
}
|
||||||
|
|
||||||
|
// measureEncodeRealtimeFactor encodes benchmarkClipSeconds of synthetic video
|
||||||
|
// at the rung's resolution using the real streaming encoder settings (libx264
|
||||||
|
// superfast, no B-frames) to /dev/null and returns clipDuration/wallTime — the
|
||||||
|
// realtime factor. ok=false when the probe couldn't run, so the caller skips
|
||||||
|
// rather than treating the failure as a fast result. Each probe is bounded so
|
||||||
|
// a wedged ffmpeg can't stall daemon startup.
|
||||||
|
func measureEncodeRealtimeFactor(ctx context.Context, ffmpegPath string, rung benchmarkRung) (float64, bool) {
|
||||||
|
// A 3 s superfast encode that takes longer than 6 s is <0.5× realtime —
|
||||||
|
// already far below the 2.0× bar — so capping here only kills genuinely
|
||||||
|
// hopeless rungs early and bounds worst-case startup blocking (3 rungs ×
|
||||||
|
// 6 s = 18 s) since this runs synchronously before the agent registers.
|
||||||
|
bctx, cancel := context.WithTimeout(ctx, 6*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
size := strconv.Itoa(rung.width) + "x" + strconv.Itoa(rung.height)
|
||||||
|
args := []string{
|
||||||
|
"-hide_banner", "-nostats", "-loglevel", "error",
|
||||||
|
"-f", "lavfi",
|
||||||
|
"-i", "testsrc2=size=" + size + ":rate=24:duration=" + strconv.Itoa(benchmarkClipSeconds),
|
||||||
|
"-c:v", "libx264", "-preset", "superfast", "-threads", "0",
|
||||||
|
"-bf", "0", "-sc_threshold", "0",
|
||||||
|
"-f", "null", "-",
|
||||||
|
}
|
||||||
|
start := time.Now()
|
||||||
|
err := exec.CommandContext(bctx, ffmpegPath, args...).Run()
|
||||||
|
elapsed := time.Since(start)
|
||||||
|
if err != nil || elapsed <= 0 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
return float64(benchmarkClipSeconds) / elapsed.Seconds(), true
|
||||||
|
}
|
||||||
52
internal/engine/encode_benchmark_test.go
Normal file
52
internal/engine/encode_benchmark_test.go
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os/exec"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBenchmarkMaxTranscodeHeight_HardwareSkipsProbe(t *testing.T) {
|
||||||
|
// Hardware encoders return 2160 without touching ffmpeg — pass a bogus path
|
||||||
|
// to prove no subprocess runs.
|
||||||
|
for _, hw := range []HWAccel{HWAccelNVENC, HWAccelQSV, HWAccelVAAPI, HWAccelVideoToolbox} {
|
||||||
|
got := BenchmarkMaxTranscodeHeight(context.Background(), "/nonexistent/ffmpeg", hw)
|
||||||
|
if got != 2160 {
|
||||||
|
t.Errorf("hw=%s: got %d, want 2160", hw, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBenchmarkMaxTranscodeHeight_NoFFmpegKeepsDefault(t *testing.T) {
|
||||||
|
if got := BenchmarkMaxTranscodeHeight(context.Background(), "", HWAccelNone); got != 1080 {
|
||||||
|
t.Errorf("empty ffmpeg path: got %d, want 1080 (historical default)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBenchmarkMaxTranscodeHeight_SoftwareReturnsValidRung(t *testing.T) {
|
||||||
|
ffmpeg, err := exec.LookPath("ffmpeg")
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("ffmpeg not on PATH — software benchmark needs a real encoder")
|
||||||
|
}
|
||||||
|
got := BenchmarkMaxTranscodeHeight(context.Background(), ffmpeg, HWAccelNone)
|
||||||
|
switch got {
|
||||||
|
case 1080, 720, 480:
|
||||||
|
// any rung is valid; the exact one depends on the host's CPU.
|
||||||
|
default:
|
||||||
|
t.Errorf("software ceiling = %d, want one of {1080,720,480}", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMeasureEncodeRealtimeFactor_RealEncoder(t *testing.T) {
|
||||||
|
ffmpeg, err := exec.LookPath("ffmpeg")
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("ffmpeg not on PATH")
|
||||||
|
}
|
||||||
|
factor, ok := measureEncodeRealtimeFactor(context.Background(), ffmpeg, benchmarkRung{height: 480, width: 854})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("480p probe failed to run on a host with ffmpeg")
|
||||||
|
}
|
||||||
|
if factor <= 0 {
|
||||||
|
t.Errorf("realtime factor = %.2f, want > 0", factor)
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load diff
419
internal/engine/hls_cache.go
Normal file
419
internal/engine/hls_cache.go
Normal file
|
|
@ -0,0 +1,419 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// HLSCache persists transcoded HLS segments per (source, quality, audio) so a
|
||||||
|
// second play of the same file at the same quality skips ffmpeg entirely.
|
||||||
|
//
|
||||||
|
// Layout on disk:
|
||||||
|
//
|
||||||
|
// {root}/{key}/init.mp4
|
||||||
|
// {root}/{key}/seg-0.m4s
|
||||||
|
// {root}/{key}/seg-N.m4s
|
||||||
|
// {root}/{key}/.complete
|
||||||
|
//
|
||||||
|
// Atomicity: the .complete marker is written only when ffmpeg exits 0 AND all
|
||||||
|
// segments are on disk. A dir without .complete is treated as a partial run —
|
||||||
|
// next session can reuse the segments already present, ffmpeg fills the gaps.
|
||||||
|
//
|
||||||
|
// Concurrency: Pin/Unpin increments a ref counter per key so the LRU sweeper
|
||||||
|
// never evicts a directory that an active session is reading from.
|
||||||
|
type HLSCache struct {
|
||||||
|
root string
|
||||||
|
maxBytes int64
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
refs map[string]int
|
||||||
|
writers map[string]bool // exclusive ffmpeg writer per key; nil entries are absent
|
||||||
|
|
||||||
|
// Counters surfaced via Stats() — useful for /api/internal/agent/cache-stats
|
||||||
|
// and for the sweeper's daily log line. atomic so RecordHit/RecordMiss are
|
||||||
|
// safe to call from any goroutine without taking the cache mutex.
|
||||||
|
hits atomic.Uint64
|
||||||
|
misses atomic.Uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
hlsCacheCompleteMarker = ".complete"
|
||||||
|
// hlsCacheMinBudgetGB clamps absurd / zero / negative SizeGB values to
|
||||||
|
// a sane floor. NOT a guarantee that any single encode fits — a long
|
||||||
|
// 4K HEVC re-encode can exceed it. Operators should set size_gb based
|
||||||
|
// on their actual workload.
|
||||||
|
hlsCacheMinBudgetGB = 1
|
||||||
|
// hlsCacheStartupOrphanAge: directories without .complete older than
|
||||||
|
// this are removed on cache startup. Long enough that a daemon crash
|
||||||
|
// during an in-progress encode (which legitimately leaves a partial
|
||||||
|
// dir) doesn't get nuked too aggressively if the daemon restarts fast.
|
||||||
|
hlsCacheStartupOrphanAge = 10 * time.Minute
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewHLSCache creates the cache rooted at the given dir with a size budget in
|
||||||
|
// gigabytes. A budget < hlsCacheMinBudgetGB is clamped up so a single play
|
||||||
|
// doesn't get instantly evicted mid-stream.
|
||||||
|
func NewHLSCache(root string, sizeGB int) (*HLSCache, error) {
|
||||||
|
if root == "" {
|
||||||
|
return nil, errors.New("hls_cache: empty root")
|
||||||
|
}
|
||||||
|
if sizeGB < hlsCacheMinBudgetGB {
|
||||||
|
sizeGB = hlsCacheMinBudgetGB
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(root, 0o755); err != nil {
|
||||||
|
return nil, fmt.Errorf("hls_cache: mkdir root: %w", err)
|
||||||
|
}
|
||||||
|
c := &HLSCache{
|
||||||
|
root: root,
|
||||||
|
maxBytes: int64(sizeGB) * 1024 * 1024 * 1024,
|
||||||
|
refs: make(map[string]int),
|
||||||
|
writers: make(map[string]bool),
|
||||||
|
}
|
||||||
|
// Reap dirs left over from a crashed encode. A dir without .complete that
|
||||||
|
// hasn't been touched recently was almost certainly orphaned by an
|
||||||
|
// ungraceful daemon exit — keeping it just feeds the unbounded growth
|
||||||
|
// pattern the hourly LRU is too slow to contain.
|
||||||
|
if removed, err := c.cleanStartupOrphans(); err != nil {
|
||||||
|
log.Printf("[hls_cache] startup orphan cleanup: %v", err)
|
||||||
|
} else if removed > 0 {
|
||||||
|
log.Printf("[hls_cache] startup: removed %d orphan dir(s) without .complete", removed)
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanStartupOrphans removes cache subdirectories that lack a .complete
|
||||||
|
// marker AND haven't been modified within hlsCacheStartupOrphanAge. Called
|
||||||
|
// once at construction. Safe at startup because no sessions are active yet,
|
||||||
|
// so Pin can't race with us.
|
||||||
|
func (c *HLSCache) cleanStartupOrphans() (int, error) {
|
||||||
|
entries, err := os.ReadDir(c.root)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
cutoff := time.Now().Add(-hlsCacheStartupOrphanAge)
|
||||||
|
removed := 0
|
||||||
|
for _, e := range entries {
|
||||||
|
if !e.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
dir := filepath.Join(c.root, e.Name())
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, hlsCacheCompleteMarker)); err == nil {
|
||||||
|
continue // sealed, keep
|
||||||
|
}
|
||||||
|
info, err := e.Info()
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if info.ModTime().After(cutoff) {
|
||||||
|
continue // too recent — might be a daemon that just restarted mid-encode
|
||||||
|
}
|
||||||
|
if err := os.RemoveAll(dir); err == nil {
|
||||||
|
removed++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return removed, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TryAcquireWriter attempts to claim exclusive ffmpeg-write access to a key.
|
||||||
|
// Returns true on success — the caller is then responsible for ReleaseWriter
|
||||||
|
// when ffmpeg exits / fails. Returns false if another session is already
|
||||||
|
// writing this key, in which case the caller must fall back to a private
|
||||||
|
// per-session tmpdir (no caching for that session).
|
||||||
|
func (c *HLSCache) TryAcquireWriter(key string) bool {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
if c.writers[key] {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
c.writers[key] = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReleaseWriter releases the writer claim acquired via TryAcquireWriter.
|
||||||
|
// Idempotent on unknown keys.
|
||||||
|
func (c *HLSCache) ReleaseWriter(key string) {
|
||||||
|
c.mu.Lock()
|
||||||
|
delete(c.writers, key)
|
||||||
|
c.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyFor derives a stable cache key for (source, quality, audioIndex). Using
|
||||||
|
// the absolute source path means renaming a file invalidates the cache, which
|
||||||
|
// is correct — segment content is tied to the encoded source.
|
||||||
|
func (c *HLSCache) KeyFor(sourcePath, quality string, audioIndex, burnSubtitleIndex int) string {
|
||||||
|
abs, err := filepath.Abs(sourcePath)
|
||||||
|
if err != nil {
|
||||||
|
abs = sourcePath
|
||||||
|
}
|
||||||
|
h := sha256.Sum256([]byte(fmt.Sprintf("%s|%s|%d|%d", abs, quality, audioIndex, burnSubtitleIndex)))
|
||||||
|
return hex.EncodeToString(h[:8]) // 16 hex chars — collision-safe enough for per-host cache
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyForID derives a cache key from a caller-supplied stable identity instead
|
||||||
|
// of a filesystem path (hueco #2 / 2b). Used for debrid HLS-from-URL sessions:
|
||||||
|
// the debrid direct URL is re-resolved per play and would never cache-hit, so
|
||||||
|
// we key by the torrent info_hash — the same content always maps to the same
|
||||||
|
// key across plays. NOT run through filepath.Abs (an id/URL is not a path).
|
||||||
|
func (c *HLSCache) KeyForID(id, quality string, audioIndex, burnSubtitleIndex int) string {
|
||||||
|
h := sha256.Sum256([]byte(fmt.Sprintf("%s|%s|%d|%d", id, quality, audioIndex, burnSubtitleIndex)))
|
||||||
|
return hex.EncodeToString(h[:8])
|
||||||
|
}
|
||||||
|
|
||||||
|
// DirFor returns the on-disk directory for a cache key. Caller is responsible
|
||||||
|
// for creating it.
|
||||||
|
func (c *HLSCache) DirFor(key string) string {
|
||||||
|
return filepath.Join(c.root, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasComplete returns true when the .complete marker is present, meaning the
|
||||||
|
// directory holds a full set of segments from a successful encode.
|
||||||
|
func (c *HLSCache) HasComplete(key string) bool {
|
||||||
|
if _, err := os.Stat(filepath.Join(c.DirFor(key), hlsCacheCompleteMarker)); err == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkComplete writes the .complete marker. Call only after verifying ffmpeg
|
||||||
|
// exited cleanly AND every expected segment is on disk. The dir must already
|
||||||
|
// exist — StartHLSSession created it on the writer path.
|
||||||
|
func (c *HLSCache) MarkComplete(key string) error {
|
||||||
|
return os.WriteFile(filepath.Join(c.DirFor(key), hlsCacheCompleteMarker), nil, 0o644)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RecordHit increments the hit counter; called by StartHLSSession on a
|
||||||
|
// cache-HIT path.
|
||||||
|
func (c *HLSCache) RecordHit() { c.hits.Add(1) }
|
||||||
|
|
||||||
|
// RecordMiss increments the miss counter; called when a session has to
|
||||||
|
// encode from scratch (or fails an integrity check on a stale HIT).
|
||||||
|
func (c *HLSCache) RecordMiss() { c.misses.Add(1) }
|
||||||
|
|
||||||
|
// CacheStats is a snapshot of the cache's runtime counters + on-disk size.
|
||||||
|
// The size fields are best-effort (computed via dirSize) so callers paying
|
||||||
|
// for them should cache the result, not poll in a hot loop.
|
||||||
|
type CacheStats struct {
|
||||||
|
Hits uint64
|
||||||
|
Misses uint64
|
||||||
|
EntryCount int
|
||||||
|
TotalBytes int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stats returns a snapshot of the cache counters and size. Walks the root
|
||||||
|
// to total disk usage — O(N segments). Call at most every few minutes.
|
||||||
|
func (c *HLSCache) Stats() CacheStats {
|
||||||
|
s := CacheStats{
|
||||||
|
Hits: c.hits.Load(),
|
||||||
|
Misses: c.misses.Load(),
|
||||||
|
}
|
||||||
|
entries, err := os.ReadDir(c.root)
|
||||||
|
if err != nil {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
for _, e := range entries {
|
||||||
|
if !e.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
size, err := dirSize(filepath.Join(c.root, e.Name()))
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s.EntryCount++
|
||||||
|
s.TotalBytes += size
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// hitRatePercent returns the current hit/(hit+miss) percentage rounded to
|
||||||
|
// the nearest int; 0 when no calls have been recorded.
|
||||||
|
func (c *HLSCache) hitRatePercent() int {
|
||||||
|
h := c.hits.Load()
|
||||||
|
m := c.misses.Load()
|
||||||
|
total := h + m
|
||||||
|
if total == 0 {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return int((h*100 + total/2) / total)
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyComplete checks that the .complete marker is present AND the
|
||||||
|
// essential files (init.mp4 + last segment) exist with non-zero size. A
|
||||||
|
// dir that passes HasComplete but fails VerifyComplete is treated as
|
||||||
|
// corrupted — typically external `rm` or a partial-disk-failure scenario.
|
||||||
|
// When it returns false, callers should Invalidate and re-encode.
|
||||||
|
func (c *HLSCache) VerifyComplete(key string, segmentCount int) bool {
|
||||||
|
if !c.HasComplete(key) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
if fi, err := os.Stat(filepath.Join(dir, "video", "init.mp4")); err != nil || fi.Size() == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if segmentCount > 0 {
|
||||||
|
lastSeg := filepath.Join(dir, "video", fmt.Sprintf("seg-%d.m4s", segmentCount-1))
|
||||||
|
if fi, err := os.Stat(lastSeg); err != nil || fi.Size() == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pin increments the ref counter for a key. The sweeper checks this before
|
||||||
|
// evicting, so a pinned dir is safe even if its mtime is old.
|
||||||
|
func (c *HLSCache) Pin(key string) {
|
||||||
|
c.mu.Lock()
|
||||||
|
c.refs[key]++
|
||||||
|
c.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unpin decrements; safe to call on unknown keys (no-op).
|
||||||
|
func (c *HLSCache) Unpin(key string) {
|
||||||
|
c.mu.Lock()
|
||||||
|
if c.refs[key] > 0 {
|
||||||
|
c.refs[key]--
|
||||||
|
if c.refs[key] == 0 {
|
||||||
|
delete(c.refs, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *HLSCache) isPinned(key string) bool {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
return c.refs[key] > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Touch updates the directory mtime so LRU picks fresher entries as recently
|
||||||
|
// used. Called when a session starts reading from a cached dir.
|
||||||
|
func (c *HLSCache) Touch(key string) error {
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
now := time.Now()
|
||||||
|
return os.Chtimes(dir, now, now)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sweep enforces the size budget by deleting the least-recently-used cache
|
||||||
|
// dirs (ignoring pinned ones) until the total size is at or below maxBytes.
|
||||||
|
// Returns the number of bytes freed.
|
||||||
|
func (c *HLSCache) Sweep() (int64, error) {
|
||||||
|
entries, err := os.ReadDir(c.root)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("hls_cache: read root: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
type item struct {
|
||||||
|
key string
|
||||||
|
path string
|
||||||
|
size int64
|
||||||
|
mtime time.Time
|
||||||
|
}
|
||||||
|
items := make([]item, 0, len(entries))
|
||||||
|
var total, pinned int64
|
||||||
|
for _, e := range entries {
|
||||||
|
if !e.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
info, err := e.Info()
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
key := e.Name()
|
||||||
|
path := filepath.Join(c.root, key)
|
||||||
|
size, err := dirSize(path)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
items = append(items, item{key: key, path: path, size: size, mtime: info.ModTime()})
|
||||||
|
total += size
|
||||||
|
if c.isPinned(key) {
|
||||||
|
pinned += size
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if total <= c.maxBytes {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
if pinned >= c.maxBytes {
|
||||||
|
// Every pinned byte already exceeds the budget — even evicting
|
||||||
|
// every unpinned dir won't bring us under. Warn loudly so the
|
||||||
|
// operator knows to bump size_gb (or kill the long-running session).
|
||||||
|
log.Printf("[hls_cache] warn: pinned bytes (%.1f MB) exceed budget (%.1f MB) — cannot enforce limit until sessions release",
|
||||||
|
float64(pinned)/(1024*1024), float64(c.maxBytes)/(1024*1024))
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Oldest first.
|
||||||
|
sort.Slice(items, func(i, j int) bool {
|
||||||
|
return items[i].mtime.Before(items[j].mtime)
|
||||||
|
})
|
||||||
|
|
||||||
|
var freed int64
|
||||||
|
for _, it := range items {
|
||||||
|
if total-freed <= c.maxBytes {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if c.isPinned(it.key) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := os.RemoveAll(it.path); err != nil {
|
||||||
|
log.Printf("[hls_cache] evict %s failed: %v", it.key, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
log.Printf("[hls_cache] evicted %s (%.1f MB, age %s)",
|
||||||
|
it.key, float64(it.size)/(1024*1024), time.Since(it.mtime).Round(time.Second))
|
||||||
|
freed += it.size
|
||||||
|
}
|
||||||
|
return freed, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StartSweeper kicks off the LRU sweeper goroutine. Cancels on ctx done.
|
||||||
|
// In addition to enforcing the size budget, logs a daily summary of hit-rate
|
||||||
|
// + disk usage so operators can see the cache's value at a glance.
|
||||||
|
func (c *HLSCache) StartSweeper(ctx context.Context, interval time.Duration) {
|
||||||
|
if interval <= 0 {
|
||||||
|
interval = time.Hour
|
||||||
|
}
|
||||||
|
go func() {
|
||||||
|
t := time.NewTicker(interval)
|
||||||
|
defer t.Stop()
|
||||||
|
statsTick := time.NewTicker(24 * time.Hour)
|
||||||
|
defer statsTick.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
if _, err := c.Sweep(); err != nil {
|
||||||
|
log.Printf("[hls_cache] sweep error: %v", err)
|
||||||
|
}
|
||||||
|
case <-statsTick.C:
|
||||||
|
s := c.Stats()
|
||||||
|
log.Printf("[hls_cache] day-stats: hits=%d misses=%d ratio=%d%% entries=%d size=%.1fMB",
|
||||||
|
s.Hits, s.Misses, c.hitRatePercent(), s.EntryCount,
|
||||||
|
float64(s.TotalBytes)/(1024*1024))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invalidate removes a cache entry — used when ffmpeg fails to encode the
|
||||||
|
// source so we don't reuse a half-written dir next time.
|
||||||
|
func (c *HLSCache) Invalidate(key string) error {
|
||||||
|
return os.RemoveAll(c.DirFor(key))
|
||||||
|
}
|
||||||
134
internal/engine/hls_cache_smoke_test.go
Normal file
134
internal/engine/hls_cache_smoke_test.go
Normal file
|
|
@ -0,0 +1,134 @@
|
||||||
|
//go:build smoke
|
||||||
|
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHLSCacheSmoke exercises the end-to-end cache flow against real ffmpeg:
|
||||||
|
// - First session encodes a 5s test pattern; expect MISS, ffmpeg runs,
|
||||||
|
// .complete written, MarkComplete logs.
|
||||||
|
// - Second session for identical (source, quality, audio); expect HIT,
|
||||||
|
// no ffmpeg, instant Start.
|
||||||
|
//
|
||||||
|
// Build tag `smoke` keeps it out of the default `go test ./...` run because
|
||||||
|
// it depends on a working ffmpeg/ffprobe and takes ~5–10 s.
|
||||||
|
//
|
||||||
|
// go test -tags=smoke -run TestHLSCacheSmoke -v ./internal/engine/
|
||||||
|
func TestHLSCacheSmoke(t *testing.T) {
|
||||||
|
ffmpeg, err := exec.LookPath("ffmpeg")
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("ffmpeg not on PATH: %v", err)
|
||||||
|
}
|
||||||
|
ffprobe, err := exec.LookPath("ffprobe")
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("ffprobe not on PATH: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
tmp := t.TempDir()
|
||||||
|
source := filepath.Join(tmp, "source.mp4")
|
||||||
|
t.Logf("generating 5 s test pattern → %s", source)
|
||||||
|
if out, err := exec.Command(ffmpeg,
|
||||||
|
"-y", "-loglevel", "error",
|
||||||
|
"-f", "lavfi", "-i", "testsrc=duration=5:size=640x480:rate=30",
|
||||||
|
"-f", "lavfi", "-i", "sine=frequency=1000:duration=5",
|
||||||
|
"-c:v", "libx264", "-preset", "ultrafast", "-pix_fmt", "yuv420p",
|
||||||
|
"-c:a", "aac",
|
||||||
|
source,
|
||||||
|
).CombinedOutput(); err != nil {
|
||||||
|
t.Fatalf("ffmpeg generate: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
|
||||||
|
cacheRoot := filepath.Join(tmp, "cache")
|
||||||
|
cache, err := NewHLSCache(cacheRoot, 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewHLSCache: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "smoke1",
|
||||||
|
SourcePath: source,
|
||||||
|
FileName: "source.mp4",
|
||||||
|
Quality: "720p",
|
||||||
|
AudioIndex: 0,
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: ffmpeg,
|
||||||
|
FFprobePath: ffprobe,
|
||||||
|
Preset: "ultrafast",
|
||||||
|
},
|
||||||
|
Cache: cache,
|
||||||
|
}
|
||||||
|
|
||||||
|
// First run — expect MISS, ffmpeg runs.
|
||||||
|
t.Log("session 1: expect MISS")
|
||||||
|
t0 := time.Now()
|
||||||
|
s1, err := StartHLSSession(context.Background(), cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("StartHLSSession #1: %v", err)
|
||||||
|
}
|
||||||
|
if s1.fromCache {
|
||||||
|
t.Fatal("session 1 reported cache HIT on a fresh cache")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait for all segments to land. 5 s source @ 4 s segments → 2 segments.
|
||||||
|
deadline := time.Now().Add(60 * time.Second)
|
||||||
|
for {
|
||||||
|
s1.readyMu.Lock()
|
||||||
|
ready := s1.readyMax
|
||||||
|
exited := s1.exited
|
||||||
|
s1.readyMu.Unlock()
|
||||||
|
if ready >= s1.segmentCount-1 && exited {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
_ = s1.Close()
|
||||||
|
t.Fatalf("session 1 didn't finish in 60 s (readyMax=%d/%d, exited=%v)",
|
||||||
|
ready, s1.segmentCount-1, exited)
|
||||||
|
}
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
}
|
||||||
|
if err := s1.Close(); err != nil {
|
||||||
|
t.Fatalf("Close #1: %v", err)
|
||||||
|
}
|
||||||
|
encodeDur := time.Since(t0)
|
||||||
|
t.Logf("session 1: MISS completed in %s", encodeDur.Round(time.Millisecond))
|
||||||
|
|
||||||
|
key := cache.KeyFor(source, "720p", 0, -1)
|
||||||
|
if !cache.HasComplete(key) {
|
||||||
|
t.Fatalf("cache.HasComplete(%s) is false after successful encode", key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second run — expect HIT, no ffmpeg.
|
||||||
|
t.Log("session 2: expect HIT")
|
||||||
|
cfg.SessionID = "smoke2"
|
||||||
|
t1 := time.Now()
|
||||||
|
s2, err := StartHLSSession(context.Background(), cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("StartHLSSession #2: %v", err)
|
||||||
|
}
|
||||||
|
if !s2.fromCache {
|
||||||
|
t.Fatal("session 2 should have reported cache HIT")
|
||||||
|
}
|
||||||
|
if s2.cmd != nil {
|
||||||
|
t.Fatal("session 2 should not have spawned ffmpeg (s.cmd != nil)")
|
||||||
|
}
|
||||||
|
hitDur := time.Since(t1)
|
||||||
|
t.Logf("session 2: HIT in %s (%.1f× faster than MISS)",
|
||||||
|
hitDur.Round(time.Millisecond), float64(encodeDur)/float64(hitDur))
|
||||||
|
if hitDur > 500*time.Millisecond {
|
||||||
|
t.Errorf("HIT path too slow: %s — expected <500 ms", hitDur)
|
||||||
|
}
|
||||||
|
if err := s2.Close(); err != nil {
|
||||||
|
t.Fatalf("Close #2: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// After the HIT session closes, the cache dir + .complete must still exist.
|
||||||
|
if !cache.HasComplete(key) {
|
||||||
|
t.Fatal(".complete disappeared after HIT session closed")
|
||||||
|
}
|
||||||
|
}
|
||||||
364
internal/engine/hls_cache_test.go
Normal file
364
internal/engine/hls_cache_test.go
Normal file
|
|
@ -0,0 +1,364 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func newTestCache(t *testing.T, sizeGB int) *HLSCache {
|
||||||
|
t.Helper()
|
||||||
|
root := t.TempDir()
|
||||||
|
c, err := NewHLSCache(root, sizeGB)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewHLSCache: %v", err)
|
||||||
|
}
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestKeyForStable(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
k1 := c.KeyFor("/a/b/movie.mkv", "1080p", 0, -1)
|
||||||
|
k2 := c.KeyFor("/a/b/movie.mkv", "1080p", 0, -1)
|
||||||
|
if k1 != k2 {
|
||||||
|
t.Fatalf("expected stable keys, got %q vs %q", k1, k2)
|
||||||
|
}
|
||||||
|
if c.KeyFor("/a/b/movie.mkv", "720p", 0, -1) == k1 {
|
||||||
|
t.Fatal("quality should change key")
|
||||||
|
}
|
||||||
|
if c.KeyFor("/a/b/movie.mkv", "1080p", 1, -1) == k1 {
|
||||||
|
t.Fatal("audio index should change key")
|
||||||
|
}
|
||||||
|
if c.KeyFor("/a/b/movie.mkv", "1080p", 0, 2) == k1 {
|
||||||
|
t.Fatal("burn subtitle index should change key")
|
||||||
|
}
|
||||||
|
if c.KeyFor("/x/y/other.mkv", "1080p", 0, -1) == k1 {
|
||||||
|
t.Fatal("path should change key")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMarkCompleteAndHas(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
key := "abc123"
|
||||||
|
if c.HasComplete(key) {
|
||||||
|
t.Fatal("fresh cache should not report complete")
|
||||||
|
}
|
||||||
|
// Production callers create the dir during StartHLSSession; MarkComplete
|
||||||
|
// trusts that invariant and fails if the dir was wiped meanwhile.
|
||||||
|
if err := os.MkdirAll(c.DirFor(key), 0o755); err != nil {
|
||||||
|
t.Fatalf("mkdir: %v", err)
|
||||||
|
}
|
||||||
|
if err := c.MarkComplete(key); err != nil {
|
||||||
|
t.Fatalf("MarkComplete: %v", err)
|
||||||
|
}
|
||||||
|
if !c.HasComplete(key) {
|
||||||
|
t.Fatal("after MarkComplete, HasComplete must be true")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMarkCompleteFailsWithoutDir(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
if err := c.MarkComplete("never-created"); err == nil {
|
||||||
|
t.Fatal("MarkComplete should error when dir doesn't exist")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPinPreventsEviction(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1) // 1 GB budget, but min clamp keeps it usable
|
||||||
|
c.maxBytes = 1024 // squeeze budget for the test
|
||||||
|
|
||||||
|
// Write two entries past the budget.
|
||||||
|
for i, key := range []string{"old", "new"} {
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||||||
|
t.Fatalf("mkdir %s: %v", dir, err)
|
||||||
|
}
|
||||||
|
path := filepath.Join(dir, "seg.bin")
|
||||||
|
if err := os.WriteFile(path, make([]byte, 800), 0o644); err != nil {
|
||||||
|
t.Fatalf("write %s: %v", path, err)
|
||||||
|
}
|
||||||
|
now := time.Now().Add(time.Duration(i) * time.Hour) // "old" mtime < "new"
|
||||||
|
_ = os.Chtimes(dir, now, now)
|
||||||
|
}
|
||||||
|
|
||||||
|
c.Pin("old") // protect the older one
|
||||||
|
freed, err := c.Sweep()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Sweep: %v", err)
|
||||||
|
}
|
||||||
|
if freed == 0 {
|
||||||
|
t.Fatal("expected some eviction")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(c.DirFor("old")); err != nil {
|
||||||
|
t.Fatal("pinned 'old' was evicted")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(c.DirFor("new")); err == nil {
|
||||||
|
t.Fatal("'new' should have been evicted to make room")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweepNoOpUnderBudget(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
dir := c.DirFor("small")
|
||||||
|
_ = os.MkdirAll(dir, 0o755)
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "x"), []byte("tiny"), 0o644)
|
||||||
|
freed, err := c.Sweep()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Sweep: %v", err)
|
||||||
|
}
|
||||||
|
if freed != 0 {
|
||||||
|
t.Fatalf("expected 0 freed under budget, got %d", freed)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(dir); err != nil {
|
||||||
|
t.Fatal("under-budget entry was wrongly evicted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweepEmptyRoot(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
freed, err := c.Sweep()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Sweep empty: %v", err)
|
||||||
|
}
|
||||||
|
if freed != 0 {
|
||||||
|
t.Fatalf("freed=%d, want 0", freed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInvalidateRemovesDir(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
key := "drop"
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
_ = os.MkdirAll(dir, 0o755)
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "x"), []byte("y"), 0o644)
|
||||||
|
if err := c.Invalidate(key); err != nil {
|
||||||
|
t.Fatalf("Invalidate: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(dir); err == nil {
|
||||||
|
t.Fatal("dir still present after Invalidate")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouchUpdatesMtime(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
key := "touch"
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
_ = os.MkdirAll(dir, 0o755)
|
||||||
|
old := time.Now().Add(-2 * time.Hour)
|
||||||
|
_ = os.Chtimes(dir, old, old)
|
||||||
|
|
||||||
|
if err := c.Touch(key); err != nil {
|
||||||
|
t.Fatalf("Touch: %v", err)
|
||||||
|
}
|
||||||
|
info, err := os.Stat(dir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("stat: %v", err)
|
||||||
|
}
|
||||||
|
if !info.ModTime().After(old.Add(time.Minute)) {
|
||||||
|
t.Fatalf("mtime not refreshed: %v", info.ModTime())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPinUnpinSymmetry(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
c.Pin("k")
|
||||||
|
c.Pin("k")
|
||||||
|
if !c.isPinned("k") {
|
||||||
|
t.Fatal("Pin twice should leave pinned")
|
||||||
|
}
|
||||||
|
c.Unpin("k")
|
||||||
|
if !c.isPinned("k") {
|
||||||
|
t.Fatal("Unpin once should keep pinned (refs=1)")
|
||||||
|
}
|
||||||
|
c.Unpin("k")
|
||||||
|
if c.isPinned("k") {
|
||||||
|
t.Fatal("Unpin twice should drop pin")
|
||||||
|
}
|
||||||
|
c.Unpin("k") // safe no-op
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConcurrentPinUnpin(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for i := 0; i < 100; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
c.Pin("race")
|
||||||
|
time.Sleep(time.Microsecond)
|
||||||
|
c.Unpin("race")
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
if c.isPinned("race") {
|
||||||
|
t.Fatal("refs leaked")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweeperLoopExits(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
c.StartSweeper(ctx, 10*time.Millisecond)
|
||||||
|
time.Sleep(30 * time.Millisecond)
|
||||||
|
cancel()
|
||||||
|
// If StartSweeper doesn't exit on cancel the test would leak a goroutine;
|
||||||
|
// the leak detector in the test runner will surface it.
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMinBudgetClamp(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
c, err := NewHLSCache(root, 0) // below floor
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewHLSCache: %v", err)
|
||||||
|
}
|
||||||
|
if c.maxBytes != int64(hlsCacheMinBudgetGB)*1024*1024*1024 {
|
||||||
|
t.Fatalf("budget not clamped to min: got %d", c.maxBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTryAcquireWriterExclusive(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
if !c.TryAcquireWriter("k") {
|
||||||
|
t.Fatal("first acquire should succeed")
|
||||||
|
}
|
||||||
|
if c.TryAcquireWriter("k") {
|
||||||
|
t.Fatal("second acquire for same key must fail")
|
||||||
|
}
|
||||||
|
if !c.TryAcquireWriter("other") {
|
||||||
|
t.Fatal("different key should not conflict")
|
||||||
|
}
|
||||||
|
c.ReleaseWriter("k")
|
||||||
|
if !c.TryAcquireWriter("k") {
|
||||||
|
t.Fatal("acquire after release should succeed")
|
||||||
|
}
|
||||||
|
c.ReleaseWriter("k")
|
||||||
|
c.ReleaseWriter("k") // idempotent
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartupOrphanCleanup(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
|
||||||
|
// Pre-seed: one sealed dir + one orphan old enough + one orphan fresh.
|
||||||
|
sealed := filepath.Join(root, "sealed")
|
||||||
|
_ = os.MkdirAll(sealed, 0o755)
|
||||||
|
_ = os.WriteFile(filepath.Join(sealed, hlsCacheCompleteMarker), nil, 0o644)
|
||||||
|
|
||||||
|
staleOrphan := filepath.Join(root, "stale_orphan")
|
||||||
|
_ = os.MkdirAll(staleOrphan, 0o755)
|
||||||
|
old := time.Now().Add(-2 * hlsCacheStartupOrphanAge)
|
||||||
|
_ = os.Chtimes(staleOrphan, old, old)
|
||||||
|
|
||||||
|
freshOrphan := filepath.Join(root, "fresh_orphan")
|
||||||
|
_ = os.MkdirAll(freshOrphan, 0o755)
|
||||||
|
|
||||||
|
if _, err := NewHLSCache(root, 1); err != nil {
|
||||||
|
t.Fatalf("NewHLSCache: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := os.Stat(sealed); err != nil {
|
||||||
|
t.Fatal("sealed dir was wrongly removed")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(staleOrphan); err == nil {
|
||||||
|
t.Fatal("stale orphan should have been removed at startup")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(freshOrphan); err != nil {
|
||||||
|
t.Fatal("fresh orphan should be kept (might be a mid-restart encode)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHitMissCounters(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
if s := c.Stats(); s.Hits != 0 || s.Misses != 0 {
|
||||||
|
t.Fatalf("fresh cache stats not zero: %+v", s)
|
||||||
|
}
|
||||||
|
c.RecordHit()
|
||||||
|
c.RecordHit()
|
||||||
|
c.RecordMiss()
|
||||||
|
s := c.Stats()
|
||||||
|
if s.Hits != 2 || s.Misses != 1 {
|
||||||
|
t.Fatalf("counters wrong: %+v", s)
|
||||||
|
}
|
||||||
|
// 2/3 = 67%
|
||||||
|
if got := c.hitRatePercent(); got != 67 {
|
||||||
|
t.Fatalf("hitRatePercent=%d, want 67", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStatsEntryCount(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
for _, k := range []string{"a", "b", "c"} {
|
||||||
|
dir := c.DirFor(k)
|
||||||
|
_ = os.MkdirAll(dir, 0o755)
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "x"), []byte("hello"), 0o644)
|
||||||
|
}
|
||||||
|
s := c.Stats()
|
||||||
|
if s.EntryCount != 3 {
|
||||||
|
t.Fatalf("EntryCount=%d, want 3", s.EntryCount)
|
||||||
|
}
|
||||||
|
if s.TotalBytes != 15 {
|
||||||
|
t.Fatalf("TotalBytes=%d, want 15", s.TotalBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVerifyCompleteRejectsMissingFiles(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
key := "v"
|
||||||
|
dir := c.DirFor(key)
|
||||||
|
_ = os.MkdirAll(filepath.Join(dir, "video"), 0o755)
|
||||||
|
|
||||||
|
// No .complete yet → reject.
|
||||||
|
if c.VerifyComplete(key, 2) {
|
||||||
|
t.Fatal("VerifyComplete should reject without .complete")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mark complete but no files → reject.
|
||||||
|
if err := c.MarkComplete(key); err != nil {
|
||||||
|
t.Fatalf("MarkComplete: %v", err)
|
||||||
|
}
|
||||||
|
if c.VerifyComplete(key, 2) {
|
||||||
|
t.Fatal("VerifyComplete should reject when init.mp4 missing")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write init.mp4, last seg missing → reject.
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "video", "init.mp4"), []byte("..."), 0o644)
|
||||||
|
if c.VerifyComplete(key, 2) {
|
||||||
|
t.Fatal("VerifyComplete should reject when last segment missing")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write last seg → pass.
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "video", "seg-1.m4s"), []byte("..."), 0o644)
|
||||||
|
if !c.VerifyComplete(key, 2) {
|
||||||
|
t.Fatal("VerifyComplete should pass with all files present")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zero-size last seg → reject.
|
||||||
|
_ = os.WriteFile(filepath.Join(dir, "video", "seg-1.m4s"), nil, 0o644)
|
||||||
|
if c.VerifyComplete(key, 2) {
|
||||||
|
t.Fatal("VerifyComplete should reject zero-size last segment")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweepRespectsPinnedExceedsBudget(t *testing.T) {
|
||||||
|
c := newTestCache(t, 1)
|
||||||
|
c.maxBytes = 256 // squeeze
|
||||||
|
|
||||||
|
pinned := c.DirFor("pinned")
|
||||||
|
_ = os.MkdirAll(pinned, 0o755)
|
||||||
|
_ = os.WriteFile(filepath.Join(pinned, "x"), make([]byte, 1024), 0o644)
|
||||||
|
c.Pin("pinned")
|
||||||
|
|
||||||
|
freed, err := c.Sweep()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Sweep: %v", err)
|
||||||
|
}
|
||||||
|
if freed != 0 {
|
||||||
|
t.Fatalf("nothing should have been freed: got %d", freed)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(pinned); err != nil {
|
||||||
|
t.Fatal("pinned dir wrongly removed despite over-budget pin")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -7,15 +7,6 @@ import (
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestYnBool(t *testing.T) {
|
|
||||||
if got := ynBool(true); got != "YES" {
|
|
||||||
t.Errorf("ynBool(true) = %q, want YES", got)
|
|
||||||
}
|
|
||||||
if got := ynBool(false); got != "NO" {
|
|
||||||
t.Errorf("ynBool(false) = %q, want NO", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBitrateForQuality(t *testing.T) {
|
func TestBitrateForQuality(t *testing.T) {
|
||||||
cases := map[string]int{
|
cases := map[string]int{
|
||||||
"2160p": 25_000_000,
|
"2160p": 25_000_000,
|
||||||
|
|
@ -115,10 +106,11 @@ func TestRenderVideoPlaylist(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRenderVideoPlaylistShortFinalSegment(t *testing.T) {
|
func TestRenderVideoPlaylistShortFinalSegment(t *testing.T) {
|
||||||
// 9.5s total, 4s segments → 3 segs of 4/4/1.5
|
// 9.5s total, 2s segments → 5 segs of 2/2/2/2/1.5
|
||||||
out := renderVideoPlaylist(9.5, 3)
|
segCount := segmentCountForDuration(9.5)
|
||||||
|
out := renderVideoPlaylist(9.5, segCount)
|
||||||
if !strings.Contains(out, "#EXTINF:1.500,") {
|
if !strings.Contains(out, "#EXTINF:1.500,") {
|
||||||
t.Errorf("expected final segment 1.5s in playlist, got:\n%s", out)
|
t.Errorf("expected final segment 1.5s in playlist (segCount=%d), got:\n%s", segCount, out)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -143,17 +135,15 @@ func TestRenderMasterPlaylist(t *testing.T) {
|
||||||
if !strings.Contains(out, "RESOLUTION=1920x1080") {
|
if !strings.Contains(out, "RESOLUTION=1920x1080") {
|
||||||
t.Errorf("expected 1920x1080 resolution, got:\n%s", out)
|
t.Errorf("expected 1920x1080 resolution, got:\n%s", out)
|
||||||
}
|
}
|
||||||
if !strings.Contains(out, `SUBTITLES="subs"`) {
|
// Subtitles are NO LONGER embedded as HLS renditions — the web player
|
||||||
t.Errorf("expected subtitles group attached, got:\n%s", out)
|
// attaches them as external <track>s (served by /sub). The master playlist
|
||||||
|
// must therefore carry no SUBTITLES group, no EXT-X-MEDIA, and no SUBTITLES
|
||||||
|
// attribute on the video variant, even when the source has text subs.
|
||||||
|
if strings.Contains(out, "SUBTITLES") {
|
||||||
|
t.Errorf("subtitles must NOT be embedded in the manifest (served as external <track>), got:\n%s", out)
|
||||||
}
|
}
|
||||||
if !strings.Contains(out, `LANGUAGE="es"`) || !strings.Contains(out, `LANGUAGE="en"`) {
|
if strings.Contains(out, "EXT-X-MEDIA") {
|
||||||
t.Errorf("expected text subs included, got:\n%s", out)
|
t.Errorf("no EXT-X-MEDIA rendition expected, got:\n%s", out)
|
||||||
}
|
|
||||||
if strings.Contains(out, "hdmv_pgs") || strings.Contains(out, `LANGUAGE="ja"`) {
|
|
||||||
t.Errorf("bitmap subs should be excluded, got:\n%s", out)
|
|
||||||
}
|
|
||||||
if !strings.Contains(out, "(forced)") {
|
|
||||||
t.Errorf("expected forced suffix on English track, got:\n%s", out)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
230
internal/engine/hls_url_args_test.go
Normal file
230
internal/engine/hls_url_args_test.go
Normal file
|
|
@ -0,0 +1,230 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hueco #2 / 2b — buildHLSFFmpegArgsAt must feed a debrid URL straight to
|
||||||
|
// ffmpeg's -i with HTTP-resilience flags, and must NOT add those flags for a
|
||||||
|
// local file.
|
||||||
|
func TestBuildHLSFFmpegArgsFromURL(t *testing.T) {
|
||||||
|
const url = "https://cdn.debrid.it/dl/abc/Movie.mkv"
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourceURL: url,
|
||||||
|
CacheID: "deadbeef",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100}
|
||||||
|
args := buildHLSFFmpegArgsAt(cfg, probe, "/tmp/tmpdir", 0, 0)
|
||||||
|
got := strings.Join(args, " ")
|
||||||
|
|
||||||
|
for _, want := range []string{
|
||||||
|
"-reconnect 1",
|
||||||
|
"-reconnect_streamed 1",
|
||||||
|
"-reconnect_delay_max 5",
|
||||||
|
"-rw_timeout 30000000",
|
||||||
|
"-i " + url,
|
||||||
|
} {
|
||||||
|
if !strings.Contains(got, want) {
|
||||||
|
t.Errorf("URL argv missing %q\n%s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A seek (startSec>0) on a URL source must keep BOTH the -ss input seek AND the
|
||||||
|
// HTTP-resilience flags, so a seek-restart re-opens the URL with a Range request
|
||||||
|
// instead of re-downloading from zero. (-ss before -i = input seek.)
|
||||||
|
func TestBuildHLSFFmpegArgsFromURLWithSeek(t *testing.T) {
|
||||||
|
const url = "https://cdn.debrid.it/dl/abc/Movie.mkv"
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourceURL: url,
|
||||||
|
CacheID: "deadbeef",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100}
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/tmpdir", 5, 30), " ")
|
||||||
|
|
||||||
|
for _, want := range []string{
|
||||||
|
"-ss 30.000", // input seek before -i
|
||||||
|
"-reconnect 1", // resilience flags still present on a restart
|
||||||
|
"-rw_timeout 30000000",
|
||||||
|
"-i " + url,
|
||||||
|
"-output_ts_offset 30.000", // PTS shift so the manifest numbering holds
|
||||||
|
} {
|
||||||
|
if !strings.Contains(got, want) {
|
||||||
|
t.Errorf("seek+URL argv missing %q\n%s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// -ss must come before -i (fast input seek, not slow output seek).
|
||||||
|
if strings.Index(got, "-ss 30.000") > strings.Index(got, "-i "+url) {
|
||||||
|
t.Errorf("-ss must precede -i for input seek:\n%s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildHLSFFmpegArgsLocalNoNetworkFlags(t *testing.T) {
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/tmp/test.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100}
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/tmpdir", 0, 0), " ")
|
||||||
|
|
||||||
|
if strings.Contains(got, "-reconnect") || strings.Contains(got, "-rw_timeout") {
|
||||||
|
t.Errorf("local source must not carry HTTP-resilience flags: %s", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, "-i /tmp/test.mkv") {
|
||||||
|
t.Errorf("local argv missing -i /tmp/test.mkv: %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sourceRef + cache-key identity: a URL session keys by CacheID, a local one by
|
||||||
|
// path. Guards the "re-plays of the same debrid content hit cache despite the
|
||||||
|
// URL changing" invariant.
|
||||||
|
func TestHLSSourceRefAndCacheID(t *testing.T) {
|
||||||
|
urlCfg := HLSSessionConfig{SourceURL: "https://cdn/x.mkv", CacheID: "hash1"}
|
||||||
|
if urlCfg.sourceRef() != "https://cdn/x.mkv" {
|
||||||
|
t.Errorf("sourceRef = %q, want the URL", urlCfg.sourceRef())
|
||||||
|
}
|
||||||
|
localCfg := HLSSessionConfig{SourcePath: "/m/x.mkv"}
|
||||||
|
if localCfg.sourceRef() != "/m/x.mkv" {
|
||||||
|
t.Errorf("sourceRef = %q, want the path", localCfg.sourceRef())
|
||||||
|
}
|
||||||
|
|
||||||
|
c := &HLSCache{root: "/tmp/cache"}
|
||||||
|
// Same CacheID + quality + audio → same key regardless of the (volatile) URL.
|
||||||
|
k1 := c.KeyForID("hash1", "720p", -1, -1)
|
||||||
|
k2 := c.KeyForID("hash1", "720p", -1, -1)
|
||||||
|
if k1 != k2 {
|
||||||
|
t.Errorf("KeyForID not stable: %q != %q", k1, k2)
|
||||||
|
}
|
||||||
|
if c.KeyForID("hash2", "720p", -1, -1) == k1 {
|
||||||
|
t.Error("KeyForID collision across distinct ids")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Burn-in: a bitmap subtitle index routes the video through -filter_complex with
|
||||||
|
// scale2ref + overlay and maps [vout]; a nil / text / out-of-range index keeps
|
||||||
|
// the plain -vf path (text subs are served as WebVTT, never burned).
|
||||||
|
func TestBuildHLSFFmpegArgsBurnSubtitle(t *testing.T) {
|
||||||
|
idx := func(n int) *int { return &n }
|
||||||
|
base := func() HLSSessionConfig {
|
||||||
|
return HLSSessionConfig{
|
||||||
|
SessionID: "burn",
|
||||||
|
SourcePath: "/tmp/movie.mkv",
|
||||||
|
Quality: "1080p",
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{
|
||||||
|
Width: 1920, Height: 1080, DurationSec: 100,
|
||||||
|
SubtitleTracks: []ProbeSubtitleTrack{
|
||||||
|
{Index: 0, Codec: "subrip"}, // text → not burnable
|
||||||
|
{Index: 1, Codec: "hdmv_pgs_subtitle"}, // bitmap → burnable
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Run("nil = clean -vf path", func(t *testing.T) {
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(base(), probe, "/tmp/d", 0, 0), " ")
|
||||||
|
if strings.Contains(got, "-filter_complex") || strings.Contains(got, "overlay") {
|
||||||
|
t.Errorf("no-burn argv must not overlay: %s", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, "-map 0:v:0") || !strings.Contains(got, "-vf") {
|
||||||
|
t.Errorf("no-burn argv must -map 0:v:0 with -vf: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("bitmap index burns via filter_complex", func(t *testing.T) {
|
||||||
|
cfg := base()
|
||||||
|
cfg.BurnSubtitleIndex = idx(1)
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/d", 0, 0), " ")
|
||||||
|
for _, want := range []string{"-filter_complex", "[0:s:1]", "scale2ref", "overlay", "-map [vout]"} {
|
||||||
|
if !strings.Contains(got, want) {
|
||||||
|
t.Errorf("burn argv missing %q: %s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(got, "-map 0:v:0") {
|
||||||
|
t.Errorf("burn argv must map [vout], not 0:v:0: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("text index is ignored (served as WebVTT)", func(t *testing.T) {
|
||||||
|
cfg := base()
|
||||||
|
cfg.BurnSubtitleIndex = idx(0) // subrip → not a bitmap track
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/d", 0, 0), " ")
|
||||||
|
if strings.Contains(got, "overlay") || strings.Contains(got, "-filter_complex") {
|
||||||
|
t.Errorf("text-sub burn must fall back to clean encode: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("out-of-range index is ignored", func(t *testing.T) {
|
||||||
|
cfg := base()
|
||||||
|
cfg.BurnSubtitleIndex = idx(9)
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/d", 0, 0), " ")
|
||||||
|
if strings.Contains(got, "overlay") {
|
||||||
|
t.Errorf("out-of-range burn must fall back to clean encode: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Audio clamp (2026-06-03 no-sound regression): the web persists audioIndex
|
||||||
|
// globally, so a stale value from a multi-track file can arrive for a file with
|
||||||
|
// fewer tracks. buildHLSFFmpegArgsAt must clamp an out-of-range index to 0:a:0
|
||||||
|
// rather than emit `-map 0:a:N?` for a track that doesn't exist — the optional
|
||||||
|
// `?` would otherwise silently drop audio and yield a video-only stream.
|
||||||
|
func TestBuildHLSFFmpegArgsAudioClamp(t *testing.T) {
|
||||||
|
cfg := func(audioIdx int) HLSSessionConfig {
|
||||||
|
return HLSSessionConfig{
|
||||||
|
SessionID: "audio",
|
||||||
|
SourcePath: "/tmp/movie.mkv",
|
||||||
|
Quality: "1080p",
|
||||||
|
AudioIndex: audioIdx,
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
oneTrack := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100, AudioTracks: []ProbeAudioTrack{{}}}
|
||||||
|
|
||||||
|
t.Run("out-of-range index clamps to 0:a:0", func(t *testing.T) {
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg(2), oneTrack, "/tmp/d", 0, 0), " ")
|
||||||
|
if !strings.Contains(got, "-map 0:a:0?") {
|
||||||
|
t.Errorf("out-of-range audioIndex must clamp to 0:a:0?: %s", got)
|
||||||
|
}
|
||||||
|
if strings.Contains(got, "0:a:2?") {
|
||||||
|
t.Errorf("must not map the non-existent 0:a:2: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("in-range index is preserved", func(t *testing.T) {
|
||||||
|
twoTracks := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100, AudioTracks: []ProbeAudioTrack{{}, {}}}
|
||||||
|
got := strings.Join(buildHLSFFmpegArgsAt(cfg(1), twoTracks, "/tmp/d", 0, 0), " ")
|
||||||
|
if !strings.Contains(got, "-map 0:a:1?") {
|
||||||
|
t.Errorf("in-range audioIndex 1 must be preserved: %s", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
@ -86,6 +86,117 @@ func listFFmpegEncoders(ctx context.Context, ffmpegPath string) string {
|
||||||
return string(out)
|
return string(out)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// HWAccelDiagnostic bundles what we know about the host's ffmpeg + HW encode
|
||||||
|
// capabilities so the daemon can log a single coherent line at startup and the
|
||||||
|
// web side can surface "this agent is software-only" without re-running probes.
|
||||||
|
type HWAccelDiagnostic struct {
|
||||||
|
Pick HWAccel // backend selected by DetectHWAccel
|
||||||
|
FFmpegPath string // resolved ffmpeg binary
|
||||||
|
FFmpegVersion string // first line of `ffmpeg -version` (e.g. "ffmpeg version 6.1.1")
|
||||||
|
Encoders []string // HW + libsvtav1/libvpx9-class encoders found in -encoders output
|
||||||
|
Devices []string // device files / drivers detected at probe time
|
||||||
|
}
|
||||||
|
|
||||||
|
// DetectHWAccelDiagnostic returns the full diagnostic picture for the host's
|
||||||
|
// transcode pipeline. Unlike DetectHWAccel, this is NOT cached — callers pay
|
||||||
|
// for an ffmpeg subprocess on each call (one `-encoders`, one `-version`).
|
||||||
|
// Daemon startup is the natural caller; per-session lookups should keep using
|
||||||
|
// DetectHWAccel (cached) and only re-probe diagnostics if the user runs an
|
||||||
|
// explicit doctor command.
|
||||||
|
func DetectHWAccelDiagnostic(ctx context.Context, ffmpegPath string) HWAccelDiagnostic {
|
||||||
|
d := HWAccelDiagnostic{Pick: HWAccelNone, FFmpegPath: ffmpegPath}
|
||||||
|
if ffmpegPath == "" {
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
d.FFmpegVersion = ffmpegVersionLine(ctx, ffmpegPath)
|
||||||
|
encoders := listFFmpegEncoders(ctx, ffmpegPath)
|
||||||
|
for _, name := range hwEncoderNames {
|
||||||
|
if strings.Contains(encoders, name) {
|
||||||
|
d.Encoders = append(d.Encoders, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Device-file checks mirror the picks below so the log line tells the
|
||||||
|
// reader why a present encoder might still have been rejected (e.g. NVENC
|
||||||
|
// compiled in but /dev/nvidia0 missing inside a container).
|
||||||
|
if fileExists("/dev/nvidia0") {
|
||||||
|
d.Devices = append(d.Devices, "/dev/nvidia0")
|
||||||
|
}
|
||||||
|
if fileExists("/dev/dri/renderD128") {
|
||||||
|
d.Devices = append(d.Devices, "/dev/dri/renderD128")
|
||||||
|
}
|
||||||
|
if hasNvidiaDriver() {
|
||||||
|
d.Devices = append(d.Devices, "nvidia-smi")
|
||||||
|
}
|
||||||
|
d.Pick = DetectHWAccel(ctx, ffmpegPath)
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// LogLine returns a one-line human-readable summary of the diagnostic,
|
||||||
|
// suitable for daemon startup output. Format:
|
||||||
|
//
|
||||||
|
// "[transcode] ffmpeg 6.1.1 at /usr/bin/ffmpeg, HW=nvenc (h264_nvenc), devices=/dev/nvidia0,nvidia-smi"
|
||||||
|
// "[transcode] ffmpeg 6.1.1 at /home/linuxbrew/.../ffmpeg, HW=none (software libx264) — no HW encoders compiled in"
|
||||||
|
func (d HWAccelDiagnostic) LogLine() string {
|
||||||
|
var b strings.Builder
|
||||||
|
b.WriteString("[transcode] ")
|
||||||
|
if d.FFmpegVersion != "" {
|
||||||
|
b.WriteString(d.FFmpegVersion)
|
||||||
|
} else {
|
||||||
|
b.WriteString("ffmpeg")
|
||||||
|
}
|
||||||
|
if d.FFmpegPath != "" {
|
||||||
|
b.WriteString(" at ")
|
||||||
|
b.WriteString(d.FFmpegPath)
|
||||||
|
}
|
||||||
|
b.WriteString(", HW=")
|
||||||
|
b.WriteString(string(d.Pick))
|
||||||
|
if d.Pick == HWAccelNone {
|
||||||
|
if len(d.Encoders) == 0 {
|
||||||
|
b.WriteString(" (software libx264) — no HW encoders compiled in")
|
||||||
|
} else {
|
||||||
|
b.WriteString(" (software libx264) — encoders found but no matching device: ")
|
||||||
|
b.WriteString(strings.Join(d.Encoders, ","))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
b.WriteString(" (")
|
||||||
|
b.WriteString(d.Pick.FFmpegVideoCodec("h264"))
|
||||||
|
b.WriteString(")")
|
||||||
|
if len(d.Devices) > 0 {
|
||||||
|
b.WriteString(", devices=")
|
||||||
|
b.WriteString(strings.Join(d.Devices, ","))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// hwEncoderNames lists the HW-accelerated encoders we care about for the
|
||||||
|
// startup log. Kept in lookup order so the output reads predictably across
|
||||||
|
// hosts.
|
||||||
|
var hwEncoderNames = []string{
|
||||||
|
"h264_nvenc", "hevc_nvenc",
|
||||||
|
"h264_qsv", "hevc_qsv",
|
||||||
|
"h264_vaapi", "hevc_vaapi",
|
||||||
|
"h264_videotoolbox", "hevc_videotoolbox",
|
||||||
|
}
|
||||||
|
|
||||||
|
// ffmpegVersionLine extracts the "ffmpeg version X.Y.Z" prefix from
|
||||||
|
// `ffmpeg -version`. Bounded to avoid hanging the daemon on a misbehaving
|
||||||
|
// binary.
|
||||||
|
func ffmpegVersionLine(ctx context.Context, ffmpegPath string) string {
|
||||||
|
cmd := exec.CommandContext(ctx, ffmpegPath, "-hide_banner", "-version")
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
if err != nil || len(out) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
line, _, _ := strings.Cut(string(out), "\n")
|
||||||
|
// "ffmpeg version 6.1.1-some-build-suffix Copyright..." → keep up to first
|
||||||
|
// space after "version 6.x" to avoid spamming build flags into the log.
|
||||||
|
if idx := strings.Index(line, "Copyright"); idx > 0 {
|
||||||
|
line = strings.TrimSpace(line[:idx])
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(line)
|
||||||
|
}
|
||||||
|
|
||||||
func fileExists(path string) bool {
|
func fileExists(path string) bool {
|
||||||
_, err := os.Stat(path)
|
_, err := os.Stat(path)
|
||||||
return err == nil
|
return err == nil
|
||||||
|
|
@ -129,12 +240,13 @@ func (h HWAccel) FFmpegVideoCodec(target string) string {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// H264LevelForHeight returns the lowest H.264 profile level capable of encoding
|
// H264LevelForHeight returns the lowest H.264 profile level capable of
|
||||||
// a stream at the given output pixel height (assumes ~16:9, ≤30 fps). The
|
// encoding a stream at the given output pixel height. Each tier carries
|
||||||
// previous code used a fixed "4.0" which silently rejects anything above 1080p
|
// enough macroblock headroom to handle ANAMORPHIC content (up to ~2.4:1
|
||||||
// — libx264 logs "frame MB size > level limit" and emits a corrupt stream.
|
// cinemascope) at 30 fps — a fixed 16:9 assumption used to silently bust
|
||||||
// Returning a tighter level on smaller outputs keeps player compatibility on
|
// the level on a 720p movie shot in 2.4:1 (1728×720 = 4860 MBs > 3.1's
|
||||||
// older devices where the encoder can't auto-pick.
|
// 3600 limit; libx264 logs "frame MB size > level limit" and emits a
|
||||||
|
// corrupt stream).
|
||||||
func H264LevelForHeight(height int) string {
|
func H264LevelForHeight(height int) string {
|
||||||
switch {
|
switch {
|
||||||
case height <= 0:
|
case height <= 0:
|
||||||
|
|
@ -142,11 +254,14 @@ func H264LevelForHeight(height int) string {
|
||||||
// re-introduce the silent-failure mode that motivated this helper.
|
// re-introduce the silent-failure mode that motivated this helper.
|
||||||
return "5.1"
|
return "5.1"
|
||||||
case height <= 480:
|
case height <= 480:
|
||||||
return "3.0"
|
|
||||||
case height <= 720:
|
|
||||||
return "3.1"
|
return "3.1"
|
||||||
case height <= 1080:
|
case height <= 720:
|
||||||
|
// 4.0 instead of 3.1: covers 720p anamorphic (e.g. 1728×720) +
|
||||||
|
// MB rate up to 245k/s (3.1 caps at 108k/s — broken at 24 fps).
|
||||||
return "4.0"
|
return "4.0"
|
||||||
|
case height <= 1080:
|
||||||
|
// 4.1 instead of 4.0: covers 1080p anamorphic + 30 fps (~245k MBs/s).
|
||||||
|
return "4.1"
|
||||||
case height <= 1440:
|
case height <= 1440:
|
||||||
return "5.0"
|
return "5.0"
|
||||||
case height <= 2160:
|
case height <= 2160:
|
||||||
|
|
@ -156,3 +271,60 @@ func H264LevelForHeight(height int) string {
|
||||||
return "6.0"
|
return "6.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// h264LevelRank orders level strings so callers can pick the higher of two.
|
||||||
|
var h264LevelRank = map[string]int{
|
||||||
|
"3.0": 30, "3.1": 31, "3.2": 32,
|
||||||
|
"4.0": 40, "4.1": 41, "4.2": 42,
|
||||||
|
"5.0": 50, "5.1": 51, "6.0": 60,
|
||||||
|
}
|
||||||
|
|
||||||
|
// levelForMacroblocks returns the lowest H.264 level whose MaxFS (frame size in
|
||||||
|
// macroblocks) covers `mbs`. The height-based H264LevelForHeight tier is correct
|
||||||
|
// for 16:9, but anamorphic content (2.39:1 cinemascope) scaled to a given height
|
||||||
|
// has a much wider frame: a 2.39:1 source downscaled to 1080 height becomes
|
||||||
|
// ~2586×1080 = 11016 MBs, which busts level 4.1's 8192-MB MaxFS. ffmpeg then
|
||||||
|
// fails the encode — libx264 with "frame MB size > level limit", h264_nvenc with
|
||||||
|
// "InitializeEncoder failed: invalid param (8): Invalid Level" — and emits zero
|
||||||
|
// packets (the whole HLS session stalls at "preparando sesión"). MaxFS values
|
||||||
|
// from the H.264 spec, Table A-1.
|
||||||
|
func levelForMacroblocks(mbs int) string {
|
||||||
|
switch {
|
||||||
|
case mbs <= 1620:
|
||||||
|
return "3.0"
|
||||||
|
case mbs <= 3600:
|
||||||
|
return "3.1"
|
||||||
|
case mbs <= 5120:
|
||||||
|
return "3.2"
|
||||||
|
case mbs <= 8192: // levels 4.0 and 4.1 share MaxFS 8192; pick 4.1 for headroom
|
||||||
|
return "4.1"
|
||||||
|
case mbs <= 8704:
|
||||||
|
return "4.2"
|
||||||
|
case mbs <= 22080:
|
||||||
|
return "5.0"
|
||||||
|
case mbs <= 36864:
|
||||||
|
return "5.1"
|
||||||
|
default:
|
||||||
|
return "6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// H264LevelForFrame returns the lowest H.264 level that satisfies BOTH the
|
||||||
|
// height-derived tier (which carries macroblock-rate / fps headroom) and the
|
||||||
|
// actual frame's macroblock count (which catches anamorphic frames that are far
|
||||||
|
// wider than 16:9 at a given height). Use this instead of H264LevelForHeight
|
||||||
|
// wherever the output width is known — it never under-levels an ultra-wide
|
||||||
|
// frame, and for 16:9 content it returns exactly what H264LevelForHeight does.
|
||||||
|
func H264LevelForFrame(width, height int) string {
|
||||||
|
byHeight := H264LevelForHeight(height)
|
||||||
|
if width <= 0 || height <= 0 {
|
||||||
|
return byHeight
|
||||||
|
}
|
||||||
|
// Macroblocks are 16×16; partial blocks at the edge still count (ceil).
|
||||||
|
mbs := ((width + 15) / 16) * ((height + 15) / 16)
|
||||||
|
byMB := levelForMacroblocks(mbs)
|
||||||
|
if h264LevelRank[byMB] > h264LevelRank[byHeight] {
|
||||||
|
return byMB
|
||||||
|
}
|
||||||
|
return byHeight
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,9 @@
|
||||||
package engine
|
package engine
|
||||||
|
|
||||||
import "testing"
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
func TestHWAccelFFmpegVideoCodec(t *testing.T) {
|
func TestHWAccelFFmpegVideoCodec(t *testing.T) {
|
||||||
cases := []struct {
|
cases := []struct {
|
||||||
|
|
@ -32,3 +35,152 @@ func TestDetectHWAccelEmptyPathReturnsNone(t *testing.T) {
|
||||||
t.Errorf("got %s, want %s", got, HWAccelNone)
|
t.Errorf("got %s, want %s", got, HWAccelNone)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestResolveEncoderProfileDefaults(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
hw HWAccel
|
||||||
|
configured string
|
||||||
|
wantCodec string
|
||||||
|
wantPreset string
|
||||||
|
wantHint string
|
||||||
|
}{
|
||||||
|
// Empty configured preset → pick latency-biased default per backend.
|
||||||
|
// DecodeHwAccel matches the encoder family for HW encoders; libx264 +
|
||||||
|
// VideoToolbox have no demuxer hint.
|
||||||
|
{HWAccelNone, "", "libx264", "superfast", ""},
|
||||||
|
{HWAccelNVENC, "", "h264_nvenc", "p3", "cuda"},
|
||||||
|
{HWAccelQSV, "", "h264_qsv", "veryfast", "qsv"},
|
||||||
|
// VAAPI: decoder hint set, no preset, no `-hwaccel_output_format vaapi`
|
||||||
|
// (so the CPU filter chain can consume the decoded frames).
|
||||||
|
{HWAccelVAAPI, "", "h264_vaapi", "", "vaapi"},
|
||||||
|
// VideoToolbox has no preset knob — Preset should be "" regardless of input.
|
||||||
|
// VideoToolbox uses per-encoder flags, not a demuxer `-hwaccel` hint.
|
||||||
|
{HWAccelVideoToolbox, "p4", "h264_videotoolbox", "", ""},
|
||||||
|
{HWAccelVideoToolbox, "", "h264_videotoolbox", "", ""},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
got := ResolveEncoderProfile(tc.hw, tc.configured)
|
||||||
|
if got.Codec != tc.wantCodec || got.Preset != tc.wantPreset || got.DecodeHwAccel != tc.wantHint {
|
||||||
|
t.Errorf("ResolveEncoderProfile(%s, %q) = {codec=%s preset=%s hint=%s}, want {codec=%s preset=%s hint=%s}",
|
||||||
|
tc.hw, tc.configured,
|
||||||
|
got.Codec, got.Preset, got.DecodeHwAccel,
|
||||||
|
tc.wantCodec, tc.wantPreset, tc.wantHint)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveEncoderProfileHonoursConfiguredPreset(t *testing.T) {
|
||||||
|
// Only libx264 honours the configured preset — the libx264 vocabulary
|
||||||
|
// (ultrafast…veryslow) doesn't apply to vendor encoders. NVENC has its
|
||||||
|
// own p1-p7 scale; QSV uses a different subset; VideoToolbox has no
|
||||||
|
// preset knob. Passing a libx264 preset to them would have ffmpeg reject
|
||||||
|
// the argv, so ResolveEncoderProfile always falls back to the hardcoded
|
||||||
|
// vendor preset for non-libx264 codecs.
|
||||||
|
cases := []struct {
|
||||||
|
hw HWAccel
|
||||||
|
configured string
|
||||||
|
wantPreset string
|
||||||
|
}{
|
||||||
|
{HWAccelNone, "ultrafast", "ultrafast"}, // libx264 honours
|
||||||
|
{HWAccelNone, "medium", "medium"}, // libx264 honours
|
||||||
|
{HWAccelNVENC, "p1", "p3"}, // NVENC ignores, sticks to p3
|
||||||
|
{HWAccelNVENC, "veryfast", "p3"}, // NVENC ignores libx264 vocab
|
||||||
|
{HWAccelQSV, "veryslow", "veryfast"}, // QSV ignores, sticks to veryfast
|
||||||
|
{HWAccelVideoToolbox, "veryfast", ""}, // VideoToolbox has no preset
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
got := ResolveEncoderProfile(tc.hw, tc.configured)
|
||||||
|
if got.Preset != tc.wantPreset {
|
||||||
|
t.Errorf("ResolveEncoderProfile(%s, %q).Preset = %q, want %q",
|
||||||
|
tc.hw, tc.configured, got.Preset, tc.wantPreset)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHWAccelDiagnosticLogLineNone(t *testing.T) {
|
||||||
|
d := HWAccelDiagnostic{
|
||||||
|
Pick: HWAccelNone,
|
||||||
|
FFmpegPath: "/usr/local/bin/ffmpeg",
|
||||||
|
FFmpegVersion: "ffmpeg version 6.1.1",
|
||||||
|
Encoders: nil,
|
||||||
|
Devices: nil,
|
||||||
|
}
|
||||||
|
line := d.LogLine()
|
||||||
|
wantSubstrings := []string{
|
||||||
|
"ffmpeg version 6.1.1",
|
||||||
|
"/usr/local/bin/ffmpeg",
|
||||||
|
"HW=none",
|
||||||
|
"software libx264",
|
||||||
|
"no HW encoders compiled in",
|
||||||
|
}
|
||||||
|
for _, want := range wantSubstrings {
|
||||||
|
if !strings.Contains(line, want) {
|
||||||
|
t.Errorf("expected substring %q in log line; got %q", want, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHWAccelDiagnosticLogLineNVENCWithDevices(t *testing.T) {
|
||||||
|
d := HWAccelDiagnostic{
|
||||||
|
Pick: HWAccelNVENC,
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFmpegVersion: "ffmpeg version 6.0",
|
||||||
|
Encoders: []string{"h264_nvenc", "hevc_nvenc", "h264_qsv"},
|
||||||
|
Devices: []string{"/dev/nvidia0", "nvidia-smi"},
|
||||||
|
}
|
||||||
|
line := d.LogLine()
|
||||||
|
for _, want := range []string{"HW=nvenc", "h264_nvenc", "/dev/nvidia0", "nvidia-smi"} {
|
||||||
|
if !strings.Contains(line, want) {
|
||||||
|
t.Errorf("expected substring %q in log line; got %q", want, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHWAccelDiagnosticLogLineSoftwareButEncodersFound(t *testing.T) {
|
||||||
|
// Edge case: ffmpeg compiled WITH nvenc but no /dev/nvidia0 (container w/o GPU).
|
||||||
|
// LogLine should flag the encoders so the user knows where the gap is.
|
||||||
|
d := HWAccelDiagnostic{
|
||||||
|
Pick: HWAccelNone,
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFmpegVersion: "ffmpeg version 6.0",
|
||||||
|
Encoders: []string{"h264_nvenc"},
|
||||||
|
Devices: nil,
|
||||||
|
}
|
||||||
|
line := d.LogLine()
|
||||||
|
for _, want := range []string{"HW=none", "encoders found but no matching device", "h264_nvenc"} {
|
||||||
|
if !strings.Contains(line, want) {
|
||||||
|
t.Errorf("expected substring %q in log line; got %q", want, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestH264LevelForFrame(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
width, height int
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
// 16:9 must match the height-only helper exactly (no regression).
|
||||||
|
{"720p 16:9", 1280, 720, "4.0"},
|
||||||
|
{"1080p 16:9", 1920, 1080, "4.1"},
|
||||||
|
{"1440p 16:9", 2560, 1440, "5.0"},
|
||||||
|
{"2160p 16:9", 3840, 2160, "5.1"},
|
||||||
|
// Anamorphic 2.39:1 at 1080 height — the regression: ~2586×1080 = 11016
|
||||||
|
// MBs busts level 4.1 (8192 MaxFS); must bump to 5.0.
|
||||||
|
{"1080h anamorphic 2.39:1", 2586, 1080, "5.0"},
|
||||||
|
// Anamorphic 720 height (1728×720 = 4860 MBs) still fits the 4.0 the
|
||||||
|
// height floor already picks for fps headroom.
|
||||||
|
{"720h anamorphic 2.4:1", 1728, 720, "4.0"},
|
||||||
|
// Source 4K anamorphic (3840×1604) encoded at source: 24240 MBs → 5.1.
|
||||||
|
{"4K anamorphic source", 3840, 1604, "5.1"},
|
||||||
|
// Width unknown → fall back to the height-only tier.
|
||||||
|
{"width unknown", 0, 1080, "4.1"},
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
t.Run(c.name, func(t *testing.T) {
|
||||||
|
if got := H264LevelForFrame(c.width, c.height); got != c.want {
|
||||||
|
t.Errorf("H264LevelForFrame(%d,%d) = %q, want %q", c.width, c.height, got, c.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ import (
|
||||||
"context"
|
"context"
|
||||||
"log"
|
"log"
|
||||||
"sync"
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
"github.com/torrentclaw/unarr/internal/agent"
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
)
|
)
|
||||||
|
|
@ -33,12 +34,37 @@ type Manager struct {
|
||||||
// Used by the daemon to trigger an immediate sync.
|
// Used by the daemon to trigger an immediate sync.
|
||||||
OnTaskDone func()
|
OnTaskDone func()
|
||||||
|
|
||||||
|
// OnStateChange is called after EVERY successful task status transition
|
||||||
|
// (resolving → downloading → verifying → organizing → seeding → done/failed),
|
||||||
|
// wired by the daemon to trigger an immediate sync so the server sees state
|
||||||
|
// changes in near-realtime instead of on the next adaptive tick. Coalesced
|
||||||
|
// downstream (TriggerSync is a buffered-1 send), so bursts collapse safely.
|
||||||
|
OnStateChange func()
|
||||||
|
|
||||||
// recentlyFinished holds tasks that completed/failed since the last sync read.
|
// recentlyFinished holds tasks that completed/failed since the last sync read.
|
||||||
// The sync goroutine reads and clears this to include final states in the next sync.
|
// The sync goroutine reads and clears this to include final states in the next sync.
|
||||||
recentMu sync.Mutex
|
recentMu sync.Mutex
|
||||||
recentFinished []agent.TaskState
|
recentFinished []agent.TaskState
|
||||||
|
|
||||||
|
// taskStore persists in-flight download payloads so the daemon can re-submit
|
||||||
|
// them after a restart (the downloaders resume the partial data). nil = no
|
||||||
|
// persistence. shuttingDown gates removal: a task interrupted by a graceful
|
||||||
|
// shutdown keeps its store entry (so it resumes), unlike a genuine terminal.
|
||||||
|
taskStore taskPersister
|
||||||
|
shuttingDown atomic.Bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// taskPersister is the resume store the manager records in-flight downloads to.
|
||||||
|
// Satisfied by *agent.ActiveTaskStore; an interface so tests can inject a fake.
|
||||||
|
type taskPersister interface {
|
||||||
|
Add(agent.Task)
|
||||||
|
Remove(taskID string)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetTaskStore wires the resume store. Call once before Submit. Optional —
|
||||||
|
// without it, downloads are not persisted for cross-restart resume.
|
||||||
|
func (m *Manager) SetTaskStore(s taskPersister) { m.taskStore = s }
|
||||||
|
|
||||||
// NewManager creates a download manager.
|
// NewManager creates a download manager.
|
||||||
func NewManager(cfg ManagerConfig, reporter *ProgressReporter, downloaders ...Downloader) *Manager {
|
func NewManager(cfg ManagerConfig, reporter *ProgressReporter, downloaders ...Downloader) *Manager {
|
||||||
if cfg.MaxConcurrent <= 0 {
|
if cfg.MaxConcurrent <= 0 {
|
||||||
|
|
@ -63,15 +89,35 @@ func NewManager(cfg ManagerConfig, reporter *ProgressReporter, downloaders ...Do
|
||||||
// Submit queues a task for download. Non-blocking if capacity available.
|
// Submit queues a task for download. Non-blocking if capacity available.
|
||||||
func (m *Manager) Submit(ctx context.Context, at agent.Task) {
|
func (m *Manager) Submit(ctx context.Context, at agent.Task) {
|
||||||
task := NewTaskFromAgent(at)
|
task := NewTaskFromAgent(at)
|
||||||
|
// Event-driven uplink: push every status transition to the server immediately.
|
||||||
|
task.SetOnChange(m.OnStateChange)
|
||||||
|
|
||||||
// Per-task cancellable context so CancelTask can unblock the goroutine
|
// Per-task cancellable context so CancelTask can unblock the goroutine
|
||||||
taskCtx, taskCancel := context.WithCancel(ctx)
|
taskCtx, taskCancel := context.WithCancel(ctx)
|
||||||
|
|
||||||
m.activeMu.Lock()
|
m.activeMu.Lock()
|
||||||
|
// Dedup: a task can arrive twice — once when the daemon re-submits it from
|
||||||
|
// the resume store on startup, and again when the web re-dispatches it. The
|
||||||
|
// second arrival must NOT launch a parallel goroutine for the same files.
|
||||||
|
if _, exists := m.active[task.ID]; exists {
|
||||||
|
m.activeMu.Unlock()
|
||||||
|
taskCancel()
|
||||||
|
log.Printf("[%s] already active — ignoring duplicate submit", agent.ShortID(task.ID))
|
||||||
|
return
|
||||||
|
}
|
||||||
m.active[task.ID] = task
|
m.active[task.ID] = task
|
||||||
m.cancels[task.ID] = taskCancel
|
m.cancels[task.ID] = taskCancel
|
||||||
m.activeMu.Unlock()
|
m.activeMu.Unlock()
|
||||||
|
|
||||||
|
// Persist real downloads so a daemon restart can resume them (torrent via
|
||||||
|
// the piece-completion DB, debrid via Range, usenet via its tracker). Stream
|
||||||
|
// and seed-file tasks are transient — not resumed. Upgrade downloads
|
||||||
|
// (ReplacePath set) are excluded too: re-running one after an interrupted
|
||||||
|
// organize could double-download or replace the wrong target.
|
||||||
|
if m.taskStore != nil && (at.Mode == "" || at.Mode == "download") && at.ReplacePath == "" {
|
||||||
|
m.taskStore.Add(at)
|
||||||
|
}
|
||||||
|
|
||||||
m.reporter.Track(task)
|
m.reporter.Track(task)
|
||||||
|
|
||||||
// Force start: bypass semaphore (like Transmission's "Force Start")
|
// Force start: bypass semaphore (like Transmission's "Force Start")
|
||||||
|
|
@ -176,6 +222,13 @@ func (m *Manager) TaskStates() []agent.TaskState {
|
||||||
|
|
||||||
// recordFinished stores a completed/failed task for the next sync cycle.
|
// recordFinished stores a completed/failed task for the next sync cycle.
|
||||||
func (m *Manager) recordFinished(update agent.StatusUpdate) {
|
func (m *Manager) recordFinished(update agent.StatusUpdate) {
|
||||||
|
// Drop from the resume store on a genuine terminal state (completed / failed
|
||||||
|
// / user-cancelled). A shutdown-interrupted task is NOT removed — it stays so
|
||||||
|
// the daemon re-submits and resumes it on the next start.
|
||||||
|
if m.taskStore != nil && !m.shuttingDown.Load() {
|
||||||
|
m.taskStore.Remove(update.TaskID)
|
||||||
|
}
|
||||||
|
|
||||||
m.recentMu.Lock()
|
m.recentMu.Lock()
|
||||||
defer m.recentMu.Unlock()
|
defer m.recentMu.Unlock()
|
||||||
m.recentFinished = append(m.recentFinished, agent.TaskStateFromUpdate(update))
|
m.recentFinished = append(m.recentFinished, agent.TaskStateFromUpdate(update))
|
||||||
|
|
@ -271,6 +324,23 @@ func (m *Manager) Wait() {
|
||||||
|
|
||||||
// Shutdown stops accepting tasks and waits for active downloads to finish.
|
// Shutdown stops accepting tasks and waits for active downloads to finish.
|
||||||
func (m *Manager) Shutdown(ctx context.Context) {
|
func (m *Manager) Shutdown(ctx context.Context) {
|
||||||
|
// Flag shutdown BEFORE cancelling task contexts: tasks interrupted by the
|
||||||
|
// shutdown then keep their resume-store entry (recordFinished skips the
|
||||||
|
// removal) so the daemon re-submits and resumes them on the next start.
|
||||||
|
m.shuttingDown.Store(true)
|
||||||
|
|
||||||
|
// Cancel every task context NOW (before waiting). Downloads block on their
|
||||||
|
// context, so this is what actually unblocks them — and because shuttingDown
|
||||||
|
// is already set, their recordFinished keeps the resume entry. (Waiting first
|
||||||
|
// would just stall until the timeout, and relying on the daemon's outer ctx
|
||||||
|
// cancel would race ahead of shuttingDown and wipe the entries.)
|
||||||
|
m.activeMu.Lock()
|
||||||
|
for id, cancel := range m.cancels {
|
||||||
|
cancel()
|
||||||
|
delete(m.cancels, id)
|
||||||
|
}
|
||||||
|
m.activeMu.Unlock()
|
||||||
|
|
||||||
// Wait for goroutines with timeout
|
// Wait for goroutines with timeout
|
||||||
done := make(chan struct{})
|
done := make(chan struct{})
|
||||||
go func() {
|
go func() {
|
||||||
|
|
@ -281,7 +351,7 @@ func (m *Manager) Shutdown(ctx context.Context) {
|
||||||
select {
|
select {
|
||||||
case <-done:
|
case <-done:
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
log.Println("shutdown timeout, cancelling active downloads")
|
log.Println("shutdown timeout, abandoning active downloads")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Shutdown all downloaders
|
// Shutdown all downloaders
|
||||||
|
|
@ -291,12 +361,7 @@ func (m *Manager) Shutdown(ctx context.Context) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clean active map and cancel functions
|
|
||||||
m.activeMu.Lock()
|
m.activeMu.Lock()
|
||||||
for id, cancel := range m.cancels {
|
|
||||||
cancel()
|
|
||||||
delete(m.cancels, id)
|
|
||||||
}
|
|
||||||
m.active = make(map[string]*Task)
|
m.active = make(map[string]*Task)
|
||||||
m.activeMu.Unlock()
|
m.activeMu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
@ -344,6 +409,12 @@ func (m *Manager) processTask(ctx context.Context, task *Task) {
|
||||||
close(progressCh)
|
close(progressCh)
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
// A full disk is terminal — another source would fill the same disk, so
|
||||||
|
// skip the fallback and surface the clear message immediately.
|
||||||
|
if IsInsufficientDisk(err) {
|
||||||
|
m.fail(ctx, task, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
// Try fallback
|
// Try fallback
|
||||||
if tryFallback(task, m.downloaders) {
|
if tryFallback(task, m.downloaders) {
|
||||||
log.Printf("[%s] %s failed, trying fallback: %v", agent.ShortID(task.ID), method, err)
|
log.Printf("[%s] %s failed, trying fallback: %v", agent.ShortID(task.ID), method, err)
|
||||||
|
|
@ -386,6 +457,8 @@ func (m *Manager) processTaskRetry(ctx context.Context, task *Task) {
|
||||||
close(progressCh)
|
close(progressCh)
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
// No further fallback here — same disk, same outcome — so an
|
||||||
|
// InsufficientDiskError on the fallback surfaces its message directly.
|
||||||
m.fail(ctx, task, err.Error())
|
m.fail(ctx, task, err.Error())
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
|
||||||
123
internal/engine/manager_resume_test.go
Normal file
123
internal/engine/manager_resume_test.go
Normal file
|
|
@ -0,0 +1,123 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakePersister is an in-memory taskPersister for asserting manager↔store calls
|
||||||
|
// without touching disk.
|
||||||
|
type fakePersister struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
tasks map[string]bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFakePersister() *fakePersister { return &fakePersister{tasks: map[string]bool{}} }
|
||||||
|
func (f *fakePersister) Add(t agent.Task) { f.mu.Lock(); f.tasks[t.ID] = true; f.mu.Unlock() }
|
||||||
|
func (f *fakePersister) Remove(id string) { f.mu.Lock(); delete(f.tasks, id); f.mu.Unlock() }
|
||||||
|
func (f *fakePersister) has(id string) bool { f.mu.Lock(); defer f.mu.Unlock(); return f.tasks[id] }
|
||||||
|
|
||||||
|
func newResumeManager(t *testing.T, p taskPersister) (*Manager, context.Context, context.CancelFunc) {
|
||||||
|
t.Helper()
|
||||||
|
reporter := NewProgressReporter(agent.NewClient("http://localhost", "test", "test"), time.Hour)
|
||||||
|
mgr := NewManager(
|
||||||
|
ManagerConfig{MaxConcurrent: 2, OutputDir: t.TempDir()},
|
||||||
|
reporter,
|
||||||
|
&slowMockDownloader{method: MethodTorrent},
|
||||||
|
)
|
||||||
|
mgr.SetTaskStore(p)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
go reporter.Run(ctx)
|
||||||
|
return mgr, ctx, cancel
|
||||||
|
}
|
||||||
|
|
||||||
|
// dlTask builds a download task. IDs mirror production (UUID-length); the engine
|
||||||
|
// logs task.ID[:8] in several places, so sub-8-char ids would panic — not a real
|
||||||
|
// case since the web always sends UUIDs.
|
||||||
|
func dlTask(id string) agent.Task {
|
||||||
|
return agent.Task{
|
||||||
|
ID: "task-uuid-" + id, // ≥ 8 chars like a real dispatch id
|
||||||
|
InfoHash: "abc123def456abc123def456abc123def456abc1",
|
||||||
|
Title: "Resume " + id,
|
||||||
|
PreferredMethod: "torrent",
|
||||||
|
Mode: "download",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_SubmitDedupes(t *testing.T) {
|
||||||
|
mgr, ctx, cancel := newResumeManager(t, newFakePersister())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
task := dlTask("dup-1")
|
||||||
|
mgr.Submit(ctx, task)
|
||||||
|
mgr.Submit(ctx, task) // duplicate id — must not launch a second download
|
||||||
|
|
||||||
|
if n := mgr.ActiveCount(); n != 1 {
|
||||||
|
t.Errorf("ActiveCount = %d after duplicate submit, want 1", n)
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
|
mgr.Wait()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_PersistsDownloadAndRemovesOnTerminal(t *testing.T) {
|
||||||
|
p := newFakePersister()
|
||||||
|
mgr, ctx, cancel := newResumeManager(t, p)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
task := dlTask("t1")
|
||||||
|
mgr.Submit(ctx, task)
|
||||||
|
if !p.has(task.ID) {
|
||||||
|
t.Fatal("download not persisted to the resume store on submit")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A genuine terminal (user cancel, not shutdown) must remove it.
|
||||||
|
mgr.CancelTask(task.ID)
|
||||||
|
mgr.Wait()
|
||||||
|
if p.has(task.ID) {
|
||||||
|
t.Error("task still in resume store after a genuine terminal — should be removed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_KeepsStoreEntryOnShutdown(t *testing.T) {
|
||||||
|
p := newFakePersister()
|
||||||
|
mgr, ctx, cancel := newResumeManager(t, p)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
task := dlTask("s1")
|
||||||
|
mgr.Submit(ctx, task)
|
||||||
|
if !p.has(task.ID) {
|
||||||
|
t.Fatal("download not persisted on submit")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shutdown interrupts the in-flight download — the entry must SURVIVE so the
|
||||||
|
// daemon re-submits and resumes it next start.
|
||||||
|
// Shutdown cancels the task contexts itself then waits, so once it returns
|
||||||
|
// the interrupted task's recordFinished has run (and must have skipped the
|
||||||
|
// removal because shuttingDown is set) — no sleep/poll needed.
|
||||||
|
shutCtx, sc := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer sc()
|
||||||
|
mgr.Shutdown(shutCtx)
|
||||||
|
|
||||||
|
if !p.has(task.ID) {
|
||||||
|
t.Error("task removed from resume store on shutdown — it would not resume")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_DoesNotPersistStreamTasks(t *testing.T) {
|
||||||
|
p := newFakePersister()
|
||||||
|
mgr, ctx, cancel := newResumeManager(t, p)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
task := dlTask("stream-1")
|
||||||
|
task.Mode = "stream"
|
||||||
|
mgr.Submit(ctx, task)
|
||||||
|
if p.has(task.ID) {
|
||||||
|
t.Error("stream task persisted to resume store — only downloads should be")
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
|
mgr.Wait()
|
||||||
|
}
|
||||||
|
|
@ -61,7 +61,7 @@ type ProbeSubtitleTrack struct {
|
||||||
// without re-rendering. Bitmap subs (PGS, DVB) need burn-in.
|
// without re-rendering. Bitmap subs (PGS, DVB) need burn-in.
|
||||||
func (s ProbeSubtitleTrack) IsTextSubtitle() bool {
|
func (s ProbeSubtitleTrack) IsTextSubtitle() bool {
|
||||||
switch s.Codec {
|
switch s.Codec {
|
||||||
case "subrip", "srt", "ass", "ssa", "webvtt", "mov_text":
|
case "subrip", "srt", "ass", "ssa", "webvtt", "mov_text", "text":
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
return false
|
return false
|
||||||
|
|
@ -88,7 +88,15 @@ const (
|
||||||
)
|
)
|
||||||
|
|
||||||
// ProbeFile runs ffprobe and returns a StreamProbe view of the file.
|
// ProbeFile runs ffprobe and returns a StreamProbe view of the file.
|
||||||
|
//
|
||||||
|
// Result is memoised by (path, mtime, size) for probeCacheTTL — repeat plays
|
||||||
|
// of the same file at the same quality (the HLS cache HIT path) skip ffprobe
|
||||||
|
// entirely. ffprobe on a 50 GB MKV can cost 1-3 s; first-segment latency
|
||||||
|
// shrinks by the same amount on the second play.
|
||||||
func ProbeFile(ctx context.Context, ffprobePath, filePath string) (*StreamProbe, error) {
|
func ProbeFile(ctx context.Context, ffprobePath, filePath string) (*StreamProbe, error) {
|
||||||
|
if cached, ok := lookupProbeCache(filePath); ok {
|
||||||
|
return cached, nil
|
||||||
|
}
|
||||||
mi, err := mediainfo.ExtractMediaInfo(ctx, ffprobePath, filePath)
|
mi, err := mediainfo.ExtractMediaInfo(ctx, ffprobePath, filePath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("probe: %w", err)
|
return nil, fmt.Errorf("probe: %w", err)
|
||||||
|
|
@ -136,6 +144,7 @@ func ProbeFile(ctx context.Context, ffprobePath, filePath string) (*StreamProbe,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
storeProbeCache(filePath, probe)
|
||||||
return probe, nil
|
return probe, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
141
internal/engine/probe_cache.go
Normal file
141
internal/engine/probe_cache.go
Normal file
|
|
@ -0,0 +1,141 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// probeCacheTTL is how long a cached probe stays usable. The cache key
|
||||||
|
// already incorporates mtime + size, so the TTL is a defense against
|
||||||
|
// runaway memory growth from stale paths, not a freshness guarantee — a
|
||||||
|
// rename + recreate at the same inode (rare) would still be caught by the
|
||||||
|
// mtime delta.
|
||||||
|
const probeCacheTTL = 30 * time.Minute
|
||||||
|
|
||||||
|
// probeCacheJanitorInterval is how often the background sweeper wakes to
|
||||||
|
// drop expired entries. Lookup-time eviction handles hot paths, but a
|
||||||
|
// user who browses 5k files and then stops would leak entries until each
|
||||||
|
// is individually re-touched. 5 min ≈ 6 sweeps per TTL window — enough
|
||||||
|
// to keep memory bounded without burning CPU.
|
||||||
|
const probeCacheJanitorInterval = 5 * time.Minute
|
||||||
|
|
||||||
|
type probeCacheEntry struct {
|
||||||
|
probe *StreamProbe
|
||||||
|
expires time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type probeCacheKey struct {
|
||||||
|
path string
|
||||||
|
mtime int64 // ModTime().UnixNano()
|
||||||
|
size int64
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
probeCacheMu sync.RWMutex
|
||||||
|
probeCache = make(map[probeCacheKey]probeCacheEntry)
|
||||||
|
probeCacheJanitor sync.Once
|
||||||
|
)
|
||||||
|
|
||||||
|
// startProbeCacheJanitor launches the background sweeper exactly once per
|
||||||
|
// process. Lazy — fired on first storeProbeCache. Drops expired entries
|
||||||
|
// every probeCacheJanitorInterval. Idempotent (sync.Once).
|
||||||
|
func startProbeCacheJanitor() {
|
||||||
|
probeCacheJanitor.Do(func() {
|
||||||
|
go func() {
|
||||||
|
ticker := time.NewTicker(probeCacheJanitorInterval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for range ticker.C {
|
||||||
|
sweepProbeCache(time.Now())
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepProbeCache removes every entry whose expiry is at or before `now`.
|
||||||
|
// Exposed for tests; production code calls it indirectly via the janitor
|
||||||
|
// goroutine.
|
||||||
|
func sweepProbeCache(now time.Time) int {
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
defer probeCacheMu.Unlock()
|
||||||
|
removed := 0
|
||||||
|
for k, e := range probeCache {
|
||||||
|
if !now.Before(e.expires) {
|
||||||
|
delete(probeCache, k)
|
||||||
|
removed++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return removed
|
||||||
|
}
|
||||||
|
|
||||||
|
// lookupProbeCache returns the cached StreamProbe for the given path if its
|
||||||
|
// mtime + size still match the value recorded at insert time, AND the cache
|
||||||
|
// entry hasn't expired. Any stat failure / mismatch returns (nil, false) so
|
||||||
|
// the caller falls through to a fresh ffprobe run.
|
||||||
|
func lookupProbeCache(path string) (*StreamProbe, bool) {
|
||||||
|
fi, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
key := probeCacheKey{
|
||||||
|
path: path,
|
||||||
|
mtime: fi.ModTime().UnixNano(),
|
||||||
|
size: fi.Size(),
|
||||||
|
}
|
||||||
|
probeCacheMu.RLock()
|
||||||
|
entry, ok := probeCache[key]
|
||||||
|
probeCacheMu.RUnlock()
|
||||||
|
if !ok {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
if time.Now().After(entry.expires) {
|
||||||
|
// Re-check under the write lock so a concurrent re-insert (same key,
|
||||||
|
// fresh expiry) isn't accidentally evicted.
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
if cur, stillThere := probeCache[key]; stillThere && time.Now().After(cur.expires) {
|
||||||
|
delete(probeCache, key)
|
||||||
|
}
|
||||||
|
probeCacheMu.Unlock()
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return entry.probe, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// storeProbeCache stashes a fresh probe result under the (path, mtime, size)
|
||||||
|
// key. A subsequent ffprobe-skipping HIT requires the file to still have the
|
||||||
|
// same mtime + size — anything else (re-encoded, renamed+recreated at the
|
||||||
|
// same path, truncated) misses and triggers a re-probe.
|
||||||
|
func storeProbeCache(path string, probe *StreamProbe) {
|
||||||
|
fi, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
key := probeCacheKey{
|
||||||
|
path: path,
|
||||||
|
mtime: fi.ModTime().UnixNano(),
|
||||||
|
size: fi.Size(),
|
||||||
|
}
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
probeCache[key] = probeCacheEntry{
|
||||||
|
probe: probe,
|
||||||
|
expires: time.Now().Add(probeCacheTTL),
|
||||||
|
}
|
||||||
|
probeCacheMu.Unlock()
|
||||||
|
// Lazy janitor — fires once per process. No-op after first call.
|
||||||
|
startProbeCacheJanitor()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResetProbeCache clears the in-memory probe cache. Test-only.
|
||||||
|
func ResetProbeCache() {
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
probeCache = make(map[probeCacheKey]probeCacheEntry)
|
||||||
|
probeCacheMu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProbeCacheSize returns the number of entries currently cached. Exposed
|
||||||
|
// for diagnostics + tests.
|
||||||
|
func ProbeCacheSize() int {
|
||||||
|
probeCacheMu.RLock()
|
||||||
|
defer probeCacheMu.RUnlock()
|
||||||
|
return len(probeCache)
|
||||||
|
}
|
||||||
202
internal/engine/probe_cache_test.go
Normal file
202
internal/engine/probe_cache_test.go
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestProbeCache_LookupMissNonexistent(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
if _, ok := lookupProbeCache("/path/that/does/not/exist"); ok {
|
||||||
|
t.Fatal("expected MISS for non-existent path")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_StoreThenLookupHit(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("fake content"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write tmp file: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
probe := &StreamProbe{VideoCodec: "h264", Width: 1920, Height: 1080, DurationSec: 5400}
|
||||||
|
storeProbeCache(path, probe)
|
||||||
|
|
||||||
|
got, ok := lookupProbeCache(path)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected HIT after store")
|
||||||
|
}
|
||||||
|
if got != probe {
|
||||||
|
t.Fatalf("expected pointer-identical probe; got different")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_MtimeChangeInvalidates(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("original"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
probe := &StreamProbe{VideoCodec: "h264", DurationSec: 100}
|
||||||
|
storeProbeCache(path, probe)
|
||||||
|
|
||||||
|
// Force mtime change. WriteFile doesn't guarantee a different mtime if
|
||||||
|
// the filesystem timestamp resolution is coarse, so set it explicitly
|
||||||
|
// to a value 1 hour in the future.
|
||||||
|
future := time.Now().Add(1 * time.Hour)
|
||||||
|
if err := os.Chtimes(path, future, future); err != nil {
|
||||||
|
t.Fatalf("chtimes: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := lookupProbeCache(path); ok {
|
||||||
|
t.Fatal("expected MISS after mtime change")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_SizeChangeInvalidates(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("aaaaa"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write: %v", err)
|
||||||
|
}
|
||||||
|
originalMtime := time.Now().Add(-1 * time.Hour) // stable, in the past
|
||||||
|
if err := os.Chtimes(path, originalMtime, originalMtime); err != nil {
|
||||||
|
t.Fatalf("chtimes original: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
probe := &StreamProbe{VideoCodec: "h264", DurationSec: 100}
|
||||||
|
storeProbeCache(path, probe)
|
||||||
|
|
||||||
|
// Truncate to a different size, then reset mtime to the original so
|
||||||
|
// only `size` differs between store and lookup keys — isolates the
|
||||||
|
// size-check path. Without the Chtimes, WriteFile bumps mtime and the
|
||||||
|
// test would pass via mtime invalidation regardless of size logic.
|
||||||
|
if err := os.WriteFile(path, []byte("a"), 0o644); err != nil {
|
||||||
|
t.Fatalf("rewrite: %v", err)
|
||||||
|
}
|
||||||
|
if err := os.Chtimes(path, originalMtime, originalMtime); err != nil {
|
||||||
|
t.Fatalf("chtimes restore: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := lookupProbeCache(path); ok {
|
||||||
|
t.Fatal("expected MISS after size change")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_ExpiryDropsEntry(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("content"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stash an entry whose expires is already in the past — simulates TTL
|
||||||
|
// having elapsed without sleeping for 30 min.
|
||||||
|
fi, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("stat: %v", err)
|
||||||
|
}
|
||||||
|
key := probeCacheKey{path: path, mtime: fi.ModTime().UnixNano(), size: fi.Size()}
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
probeCache[key] = probeCacheEntry{
|
||||||
|
probe: &StreamProbe{VideoCodec: "h264"},
|
||||||
|
expires: time.Now().Add(-1 * time.Minute),
|
||||||
|
}
|
||||||
|
probeCacheMu.Unlock()
|
||||||
|
|
||||||
|
if _, ok := lookupProbeCache(path); ok {
|
||||||
|
t.Fatal("expected MISS for expired entry")
|
||||||
|
}
|
||||||
|
// Side-effect: lookup should have evicted the stale entry.
|
||||||
|
if ProbeCacheSize() != 0 {
|
||||||
|
t.Fatalf("expected cache size 0 after expiry eviction; got %d", ProbeCacheSize())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_ResetClears(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("x"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
storeProbeCache(path, &StreamProbe{VideoCodec: "h264"})
|
||||||
|
if ProbeCacheSize() != 1 {
|
||||||
|
t.Fatalf("expected size 1 after store; got %d", ProbeCacheSize())
|
||||||
|
}
|
||||||
|
|
||||||
|
ResetProbeCache()
|
||||||
|
if ProbeCacheSize() != 0 {
|
||||||
|
t.Fatalf("expected size 0 after reset; got %d", ProbeCacheSize())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_StoreNonexistentNoOp(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
// Store on a non-existent path should silently do nothing (stat fails),
|
||||||
|
// not panic, and not poison the cache with a zero key.
|
||||||
|
storeProbeCache("/nope/never/exists.mkv", &StreamProbe{VideoCodec: "h264"})
|
||||||
|
if ProbeCacheSize() != 0 {
|
||||||
|
t.Fatalf("expected 0 entries; got %d", ProbeCacheSize())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProbeCache_SweepDropsExpired(t *testing.T) {
|
||||||
|
ResetProbeCache()
|
||||||
|
t.Cleanup(ResetProbeCache)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
// Two entries: one expired, one fresh.
|
||||||
|
expiredPath := filepath.Join(dir, "old.mkv")
|
||||||
|
freshPath := filepath.Join(dir, "new.mkv")
|
||||||
|
if err := os.WriteFile(expiredPath, []byte("a"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write expired: %v", err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(freshPath, []byte("b"), 0o644); err != nil {
|
||||||
|
t.Fatalf("write fresh: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
fiExp, _ := os.Stat(expiredPath)
|
||||||
|
fiFresh, _ := os.Stat(freshPath)
|
||||||
|
|
||||||
|
probeCacheMu.Lock()
|
||||||
|
probeCache[probeCacheKey{path: expiredPath, mtime: fiExp.ModTime().UnixNano(), size: fiExp.Size()}] = probeCacheEntry{
|
||||||
|
probe: &StreamProbe{VideoCodec: "h264"},
|
||||||
|
expires: now.Add(-1 * time.Minute), // expired
|
||||||
|
}
|
||||||
|
probeCache[probeCacheKey{path: freshPath, mtime: fiFresh.ModTime().UnixNano(), size: fiFresh.Size()}] = probeCacheEntry{
|
||||||
|
probe: &StreamProbe{VideoCodec: "h264"},
|
||||||
|
expires: now.Add(10 * time.Minute), // fresh
|
||||||
|
}
|
||||||
|
probeCacheMu.Unlock()
|
||||||
|
|
||||||
|
removed := sweepProbeCache(now)
|
||||||
|
if removed != 1 {
|
||||||
|
t.Fatalf("expected 1 expired entry removed; got %d", removed)
|
||||||
|
}
|
||||||
|
if ProbeCacheSize() != 1 {
|
||||||
|
t.Fatalf("expected 1 fresh entry kept; got %d", ProbeCacheSize())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -45,10 +45,19 @@ type ProgressReporter struct {
|
||||||
lastCheckAt time.Time // last time we reported for control-signal polling
|
lastCheckAt time.Time // last time we reported for control-signal polling
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewProgressReporter creates a reporter that flushes every interval.
|
// NewProgressReporter creates a reporter that flushes every interval. A nil
|
||||||
|
// client yields a local-only reporter that tracks progress for terminal output
|
||||||
|
// but never calls the API — used by one-shot `unarr download`, which has no
|
||||||
|
// server-side task to report against (its synthetic "oneshot-" id is not a UUID
|
||||||
|
// and the /api/internal/agent/status endpoint 400s it). Passing the typed nil
|
||||||
|
// straight into the interface field would make it non-nil, so guard explicitly.
|
||||||
func NewProgressReporter(ac *agent.Client, interval time.Duration) *ProgressReporter {
|
func NewProgressReporter(ac *agent.Client, interval time.Duration) *ProgressReporter {
|
||||||
|
var rep StatusReporter
|
||||||
|
if ac != nil {
|
||||||
|
rep = ac
|
||||||
|
}
|
||||||
return &ProgressReporter{
|
return &ProgressReporter{
|
||||||
reporter: ac,
|
reporter: rep,
|
||||||
interval: interval,
|
interval: interval,
|
||||||
latest: make(map[string]*Task),
|
latest: make(map[string]*Task),
|
||||||
lastReported: make(map[string]TaskStatus),
|
lastReported: make(map[string]TaskStatus),
|
||||||
|
|
@ -108,6 +117,9 @@ func (r *ProgressReporter) Run(ctx context.Context) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *ProgressReporter) flush(ctx context.Context) {
|
func (r *ProgressReporter) flush(ctx context.Context) {
|
||||||
|
if r.reporter == nil {
|
||||||
|
return // local-only reporter (one-shot): nothing to send
|
||||||
|
}
|
||||||
r.mu.Lock()
|
r.mu.Lock()
|
||||||
tasks := make([]*Task, 0, len(r.latest))
|
tasks := make([]*Task, 0, len(r.latest))
|
||||||
for _, t := range r.latest {
|
for _, t := range r.latest {
|
||||||
|
|
@ -239,6 +251,10 @@ func (r *ProgressReporter) handleResponse(task *Task, resp *agent.StatusResponse
|
||||||
|
|
||||||
// ReportFinal sends a final status update for a completed/failed task.
|
// ReportFinal sends a final status update for a completed/failed task.
|
||||||
func (r *ProgressReporter) ReportFinal(ctx context.Context, task *Task) {
|
func (r *ProgressReporter) ReportFinal(ctx context.Context, task *Task) {
|
||||||
|
if r.reporter == nil {
|
||||||
|
r.Untrack(task.ID)
|
||||||
|
return // local-only reporter (one-shot)
|
||||||
|
}
|
||||||
update := task.ToStatusUpdate()
|
update := task.ToStatusUpdate()
|
||||||
if _, err := r.reporter.ReportStatus(ctx, update); err != nil {
|
if _, err := r.reporter.ReportStatus(ctx, update); err != nil {
|
||||||
log.Printf("[%s] final report failed: %v", task.ID[:8], err)
|
log.Printf("[%s] final report failed: %v", task.ID[:8], err)
|
||||||
|
|
|
||||||
32
internal/engine/readahead.go
Normal file
32
internal/engine/readahead.go
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
// Torrent stream readahead sizing.
|
||||||
|
//
|
||||||
|
// anacrolix's Reader (SetResponsive + SetReadahead) already prioritises the
|
||||||
|
// pieces in a window ahead of the read position and re-prioritises on Seek —
|
||||||
|
// so the playhead→piece-priority feedback is built in. The problem was the
|
||||||
|
// window: a static 5 MiB is only ~1.6s of a 25 Mbps 4K stream, so playback
|
||||||
|
// outran the download and stalled. Sizing the window by bitrate (~30s of video)
|
||||||
|
// keeps a real buffer ahead of the playhead.
|
||||||
|
const (
|
||||||
|
readaheadSeconds = 30
|
||||||
|
minReadahead = 8 << 20 // 8 MiB
|
||||||
|
maxReadahead = 96 << 20 // 96 MiB — cap so a seek doesn't waste a huge fetch
|
||||||
|
defaultReadahead = 24 << 20 // 24 MiB — when bitrate is unknown (still ~5x the old 5 MiB)
|
||||||
|
)
|
||||||
|
|
||||||
|
// dynamicReadahead returns the bytes-ahead window for a torrent reader given the
|
||||||
|
// stream's bitrate (bits/sec). Unknown/zero bitrate → a generous default.
|
||||||
|
func dynamicReadahead(bitrateBps int64) int64 {
|
||||||
|
if bitrateBps <= 0 {
|
||||||
|
return defaultReadahead
|
||||||
|
}
|
||||||
|
ra := bitrateBps / 8 * readaheadSeconds
|
||||||
|
if ra < minReadahead {
|
||||||
|
return minReadahead
|
||||||
|
}
|
||||||
|
if ra > maxReadahead {
|
||||||
|
return maxReadahead
|
||||||
|
}
|
||||||
|
return ra
|
||||||
|
}
|
||||||
43
internal/engine/readahead_test.go
Normal file
43
internal/engine/readahead_test.go
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestDynamicReadahead(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
bitrateBps int64
|
||||||
|
want int64
|
||||||
|
}{
|
||||||
|
{"unknown bitrate → default", 0, defaultReadahead},
|
||||||
|
{"negative → default", -1, defaultReadahead},
|
||||||
|
{"low bitrate clamps to min", 1_000_000, minReadahead}, // 1 Mbps → ~3.75 MiB < 8 MiB
|
||||||
|
{"mid bitrate scales", 5_000_000, 5_000_000 / 8 * readaheadSeconds}, // 5 Mbps → ~18.75 MiB
|
||||||
|
{"high bitrate within range", 25_000_000, 25_000_000 / 8 * readaheadSeconds}, // 4K ~25 Mbps → ~93.75 MiB
|
||||||
|
{"very high clamps to max", 80_000_000, maxReadahead}, // 80 Mbps → 300 MiB > cap
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
t.Run(c.name, func(t *testing.T) {
|
||||||
|
got := dynamicReadahead(c.bitrateBps)
|
||||||
|
if got != c.want {
|
||||||
|
t.Errorf("dynamicReadahead(%d) = %d, want %d", c.bitrateBps, got, c.want)
|
||||||
|
}
|
||||||
|
if got < minReadahead && c.bitrateBps > 0 {
|
||||||
|
t.Errorf("result %d below min %d", got, minReadahead)
|
||||||
|
}
|
||||||
|
if got > maxReadahead {
|
||||||
|
t.Errorf("result %d above max %d", got, maxReadahead)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDynamicReadahead_BeatsOldStatic(t *testing.T) {
|
||||||
|
// The whole point: every result is bigger than the old static 5 MiB that
|
||||||
|
// stalled HD/4K.
|
||||||
|
const oldStatic = 5 * 1024 * 1024
|
||||||
|
for _, b := range []int64{0, 1_000_000, 8_000_000, 25_000_000, 100_000_000} {
|
||||||
|
if got := dynamicReadahead(b); got <= oldStatic {
|
||||||
|
t.Errorf("dynamicReadahead(%d) = %d, not bigger than the old 5 MiB", b, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
118
internal/engine/seed_lifecycle_smoke_test.go
Normal file
118
internal/engine/seed_lifecycle_smoke_test.go
Normal file
|
|
@ -0,0 +1,118 @@
|
||||||
|
//go:build smoke
|
||||||
|
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/anacrolix/torrent"
|
||||||
|
"github.com/anacrolix/torrent/bencode"
|
||||||
|
"github.com/anacrolix/torrent/metainfo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestSeedLifecycleSmoke spins up a real loopback BitTorrent swarm: a seeder
|
||||||
|
// client serving a small file, and our TorrentDownloader's client leeching it.
|
||||||
|
// Once the leecher completes, the torrent is handed to seedAndDrop with a short
|
||||||
|
// SeedTime; the test asserts the lifecycle fires and the handle is dropped
|
||||||
|
// (removed from d.active). Exercises the real anacrolix Stats/Drop/ticker path,
|
||||||
|
// not mocks. Run with: go test -tags smoke -run TestSeedLifecycleSmoke ./internal/engine/
|
||||||
|
func TestSeedLifecycleSmoke(t *testing.T) {
|
||||||
|
// --- seeder: a real client serving a 4 MiB file over loopback ---
|
||||||
|
seedDir := t.TempDir()
|
||||||
|
payload := make([]byte, 4<<20)
|
||||||
|
for i := range payload {
|
||||||
|
payload[i] = byte(i)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(seedDir, "movie.bin"), payload, 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var info metainfo.Info
|
||||||
|
info.PieceLength = 256 << 10
|
||||||
|
if err := info.BuildFromFilePath(filepath.Join(seedDir, "movie.bin")); err != nil {
|
||||||
|
t.Fatalf("build info: %v", err)
|
||||||
|
}
|
||||||
|
var mi metainfo.MetaInfo
|
||||||
|
var err error
|
||||||
|
if mi.InfoBytes, err = bencode.Marshal(info); err != nil {
|
||||||
|
t.Fatalf("marshal info: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
scfg := torrent.NewDefaultClientConfig()
|
||||||
|
scfg.DataDir = seedDir
|
||||||
|
scfg.Seed = true
|
||||||
|
scfg.NoDHT = true
|
||||||
|
scfg.DisableTrackers = true
|
||||||
|
scfg.ListenPort = 0 // random — never collides with the leecher's 42069
|
||||||
|
seeder, err := torrent.NewClient(scfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("seeder client: %v", err)
|
||||||
|
}
|
||||||
|
defer seeder.Close()
|
||||||
|
st, err := seeder.AddTorrent(&mi)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("seeder add: %v", err)
|
||||||
|
}
|
||||||
|
<-st.GotInfo()
|
||||||
|
st.DownloadAll() // verifies the existing pieces so the seeder is "complete"
|
||||||
|
|
||||||
|
// --- leecher: our downloader, seeding enabled, very short seed time ---
|
||||||
|
leechDir := t.TempDir()
|
||||||
|
dl, err := NewTorrentDownloader(TorrentConfig{
|
||||||
|
DataDir: leechDir,
|
||||||
|
SeedEnabled: true,
|
||||||
|
SeedTime: 1 * time.Second, // time target fires fast (no peers pull from us, so ratio stays 0)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("downloader: %v", err)
|
||||||
|
}
|
||||||
|
dl.seedCheckInterval = 200 * time.Millisecond // poll fast so the 1s target is noticed promptly
|
||||||
|
defer dl.Shutdown(context.Background())
|
||||||
|
|
||||||
|
lt, err := dl.client.AddTorrent(&mi)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("leecher add: %v", err)
|
||||||
|
}
|
||||||
|
<-lt.GotInfo()
|
||||||
|
lt.AddClientPeer(seeder) // loopback peer — no DHT/tracker needed
|
||||||
|
lt.DownloadAll()
|
||||||
|
|
||||||
|
deadline := time.After(30 * time.Second)
|
||||||
|
for lt.BytesMissing() > 0 {
|
||||||
|
select {
|
||||||
|
case <-deadline:
|
||||||
|
t.Fatalf("download did not complete (missing %d bytes)", lt.BytesMissing())
|
||||||
|
case <-time.After(100 * time.Millisecond):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Logf("leecher completed %d bytes", lt.BytesCompleted())
|
||||||
|
|
||||||
|
// Track it as the daemon would for a seeding torrent, then run the lifecycle.
|
||||||
|
const taskID = "smoke-seed-task-0001"
|
||||||
|
dl.activeMu.Lock()
|
||||||
|
dl.active[taskID] = lt
|
||||||
|
dl.activeMu.Unlock()
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
dl.seedAndDrop(taskID, lt, info.Length)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(10 * time.Second):
|
||||||
|
t.Fatal("seedAndDrop did not return within 10s")
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.activeMu.Lock()
|
||||||
|
_, stillTracked := dl.active[taskID]
|
||||||
|
dl.activeMu.Unlock()
|
||||||
|
if stillTracked {
|
||||||
|
t.Error("torrent still tracked after seedAndDrop — lifecycle did not drop it")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -235,7 +235,9 @@ func (s *StreamEngine) WaitBuffer(ctx context.Context, progressFn func(buffered,
|
||||||
func (s *StreamEngine) NewFileReader(ctx context.Context) io.ReadSeekCloser {
|
func (s *StreamEngine) NewFileReader(ctx context.Context) io.ReadSeekCloser {
|
||||||
reader := s.file.NewReader()
|
reader := s.file.NewReader()
|
||||||
reader.SetResponsive()
|
reader.SetResponsive()
|
||||||
reader.SetReadahead(5 * 1024 * 1024) // 5MB readahead
|
// Generous default window (vs the old static 5 MiB that stalled HD/4K). This
|
||||||
|
// CLI path has no bitrate probe, so dynamicReadahead(0) returns the default.
|
||||||
|
reader.SetReadahead(dynamicReadahead(0))
|
||||||
reader.SetContext(ctx)
|
reader.SetContext(ctx)
|
||||||
return reader
|
return reader
|
||||||
}
|
}
|
||||||
|
|
|
||||||
197
internal/engine/stream_growing_test.go
Normal file
197
internal/engine/stream_growing_test.go
Normal file
|
|
@ -0,0 +1,197 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeGrowing is a GrowingSource backed by a fixed byte slice. When final is
|
||||||
|
// true it behaves like a completed remux (ReadAt returns io.EOF at the end);
|
||||||
|
// est overrides the advertised estimate (0 = use len(data)).
|
||||||
|
type fakeGrowing struct {
|
||||||
|
data []byte
|
||||||
|
final bool
|
||||||
|
est int64
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeGrowing) ReadAt(p []byte, off int64) (int, error) {
|
||||||
|
if off < 0 || off >= int64(len(f.data)) {
|
||||||
|
return 0, io.EOF
|
||||||
|
}
|
||||||
|
n := copy(p, f.data[off:])
|
||||||
|
if int(off)+n >= len(f.data) {
|
||||||
|
return n, io.EOF
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
func (f *fakeGrowing) Size() int64 { return int64(len(f.data)) }
|
||||||
|
func (f *fakeGrowing) Final() bool { return f.final }
|
||||||
|
func (f *fakeGrowing) EstimatedSize() int64 {
|
||||||
|
if f.est > 0 {
|
||||||
|
return f.est
|
||||||
|
}
|
||||||
|
return int64(len(f.data))
|
||||||
|
}
|
||||||
|
func (f *fakeGrowing) FileName() string { return "movie.mp4" }
|
||||||
|
func (f *fakeGrowing) Close() error { return nil }
|
||||||
|
|
||||||
|
func TestParseByteRange(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
in string
|
||||||
|
start, end int64
|
||||||
|
}{
|
||||||
|
{"", 0, -1},
|
||||||
|
{"bytes=0-", 0, -1},
|
||||||
|
{"bytes=100-", 100, -1},
|
||||||
|
{"bytes=5-9", 5, 9},
|
||||||
|
{"bytes=0-0", 0, 0},
|
||||||
|
{"bytes=10-19,40-49", 10, 19}, // first range only
|
||||||
|
{"bytes=-500", 0, -1}, // suffix unsupported → open from 0
|
||||||
|
{"garbage", 0, -1},
|
||||||
|
{"bytes=", 0, -1},
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
s, e := parseByteRange(c.in)
|
||||||
|
if s != c.start || e != c.end {
|
||||||
|
t.Errorf("parseByteRange(%q) = (%d,%d), want (%d,%d)", c.in, s, e, c.start, c.end)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_FinalFullRequest(t *testing.T) {
|
||||||
|
data := []byte("0123456789abcdef")
|
||||||
|
src := &fakeGrowing{data: data, final: true}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/stream", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
res := rec.Result()
|
||||||
|
if res.StatusCode != http.StatusPartialContent {
|
||||||
|
t.Fatalf("status = %d, want 206", res.StatusCode)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Range"); got != "bytes 0-15/16" {
|
||||||
|
t.Errorf("Content-Range = %q, want bytes 0-15/16", got)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Accept-Ranges"); got != "bytes" {
|
||||||
|
t.Errorf("Accept-Ranges = %q, want bytes", got)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Type"); got != "video/mp4" {
|
||||||
|
t.Errorf("Content-Type = %q, want video/mp4", got)
|
||||||
|
}
|
||||||
|
// Final + open-ended → exact Content-Length.
|
||||||
|
if got := res.Header.Get("Content-Length"); got != "16" {
|
||||||
|
t.Errorf("Content-Length = %q, want 16", got)
|
||||||
|
}
|
||||||
|
if body := rec.Body.String(); body != string(data) {
|
||||||
|
t.Errorf("body = %q, want %q", body, string(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_OffsetRange(t *testing.T) {
|
||||||
|
data := []byte("0123456789abcdef")
|
||||||
|
src := &fakeGrowing{data: data, final: true}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/stream", nil)
|
||||||
|
req.Header.Set("Range", "bytes=10-")
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
res := rec.Result()
|
||||||
|
if res.StatusCode != http.StatusPartialContent {
|
||||||
|
t.Fatalf("status = %d, want 206", res.StatusCode)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Range"); got != "bytes 10-15/16" {
|
||||||
|
t.Errorf("Content-Range = %q, want bytes 10-15/16", got)
|
||||||
|
}
|
||||||
|
if body := rec.Body.String(); body != "abcdef" {
|
||||||
|
t.Errorf("body = %q, want abcdef", body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_BoundedRange(t *testing.T) {
|
||||||
|
data := []byte("0123456789abcdef")
|
||||||
|
src := &fakeGrowing{data: data, final: true}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/stream", nil)
|
||||||
|
req.Header.Set("Range", "bytes=5-9")
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
res := rec.Result()
|
||||||
|
if res.StatusCode != http.StatusPartialContent {
|
||||||
|
t.Fatalf("status = %d, want 206", res.StatusCode)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Range"); got != "bytes 5-9/16" {
|
||||||
|
t.Errorf("Content-Range = %q, want bytes 5-9/16", got)
|
||||||
|
}
|
||||||
|
if body := rec.Body.String(); body != "56789" {
|
||||||
|
t.Errorf("body = %q, want 56789 (exactly the requested 5 bytes)", body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_EstimateUsedWhileNotFinal(t *testing.T) {
|
||||||
|
// Not final: only 8 bytes produced, but estimate says 100. The advertised
|
||||||
|
// total is the estimate (scrubber timeline); body is what exists so far.
|
||||||
|
src := &fakeGrowing{data: []byte("01234567"), final: false, est: 100}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/stream", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
res := rec.Result()
|
||||||
|
if res.StatusCode != http.StatusPartialContent {
|
||||||
|
t.Fatalf("status = %d, want 206", res.StatusCode)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Range"); got != "bytes 0-99/100" {
|
||||||
|
t.Errorf("Content-Range = %q, want bytes 0-99/100 (estimate)", got)
|
||||||
|
}
|
||||||
|
// Not final → no exact Content-Length (chunked) so we never promise bytes
|
||||||
|
// a still-running remux might not produce.
|
||||||
|
if got := res.Header.Get("Content-Length"); got != "" {
|
||||||
|
t.Errorf("Content-Length = %q, want empty (chunked) while not final", got)
|
||||||
|
}
|
||||||
|
if body := rec.Body.String(); body != "01234567" {
|
||||||
|
t.Errorf("body = %q, want 01234567 (bytes produced so far)", body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_HeadProbe(t *testing.T) {
|
||||||
|
src := &fakeGrowing{data: make([]byte, 0), final: false, est: 4242}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodHead, "/stream", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
res := rec.Result()
|
||||||
|
if res.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("HEAD status = %d, want 200", res.StatusCode)
|
||||||
|
}
|
||||||
|
if got := res.Header.Get("Content-Length"); got != "4242" {
|
||||||
|
t.Errorf("HEAD Content-Length = %q, want 4242", got)
|
||||||
|
}
|
||||||
|
if rec.Body.Len() != 0 {
|
||||||
|
t.Errorf("HEAD body = %d bytes, want 0", rec.Body.Len())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestServeGrowing_RangeBeyondTotal(t *testing.T) {
|
||||||
|
src := &fakeGrowing{data: []byte("0123456789"), final: true}
|
||||||
|
ss := &StreamServer{}
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/stream", nil)
|
||||||
|
req.Header.Set("Range", "bytes=999-")
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
ss.serveGrowing(rec, req, src)
|
||||||
|
|
||||||
|
if rec.Result().StatusCode != http.StatusRequestedRangeNotSatisfiable {
|
||||||
|
t.Errorf("status = %d, want 416", rec.Result().StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load diff
151
internal/engine/stream_server_tls_test.go
Normal file
151
internal/engine/stream_server_tls_test.go
Normal file
|
|
@ -0,0 +1,151 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"crypto/x509/pkix"
|
||||||
|
"fmt"
|
||||||
|
"math/big"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// genSelfSignedCert builds an in-memory self-signed cert valid for 127.0.0.1,
|
||||||
|
// used to exercise the agent's HTTPS listener without any CA/ACME plumbing.
|
||||||
|
func genSelfSignedCert(t *testing.T) (tls.Certificate, *x509.Certificate) {
|
||||||
|
t.Helper()
|
||||||
|
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("genkey: %v", err)
|
||||||
|
}
|
||||||
|
tmpl := &x509.Certificate{
|
||||||
|
SerialNumber: big.NewInt(1),
|
||||||
|
Subject: pkix.Name{CommonName: "unarr-test"},
|
||||||
|
NotBefore: time.Now().Add(-time.Hour),
|
||||||
|
NotAfter: time.Now().Add(time.Hour),
|
||||||
|
KeyUsage: x509.KeyUsageDigitalSignature,
|
||||||
|
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
|
||||||
|
IPAddresses: []net.IP{net.ParseIP("127.0.0.1")},
|
||||||
|
DNSNames: []string{"localhost"},
|
||||||
|
}
|
||||||
|
der, err := x509.CreateCertificate(rand.Reader, tmpl, tmpl, &key.PublicKey, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("create cert: %v", err)
|
||||||
|
}
|
||||||
|
leaf, err := x509.ParseCertificate(der)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("parse cert: %v", err)
|
||||||
|
}
|
||||||
|
return tls.Certificate{Certificate: [][]byte{der}, PrivateKey: key, Leaf: leaf}, leaf
|
||||||
|
}
|
||||||
|
|
||||||
|
// freePort grabs an ephemeral TCP port and releases it, so the caller can hand
|
||||||
|
// a concrete port number to EnableTLS (which treats 0 as "disabled").
|
||||||
|
func freePort(t *testing.T) int {
|
||||||
|
t.Helper()
|
||||||
|
l, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("freePort: %v", err)
|
||||||
|
}
|
||||||
|
p := l.Addr().(*net.TCPAddr).Port
|
||||||
|
l.Close()
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestStreamServerTLS_HotInstall verifies the HTTPS listener: it starts even
|
||||||
|
// with no certificate (handshake fails), and a certificate installed *after*
|
||||||
|
// Listen applies live via the GetCertificate path — no restart, which is what
|
||||||
|
// the future ACME broker relies on.
|
||||||
|
func TestStreamServerTLS_HotInstall(t *testing.T) {
|
||||||
|
cert, leaf := genSelfSignedCert(t)
|
||||||
|
|
||||||
|
ss := NewStreamServer(0) // HTTP on a random free port
|
||||||
|
ss.EnableTLS(freePort(t))
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if err := ss.Listen(ctx); err != nil {
|
||||||
|
t.Fatalf("Listen: %v", err)
|
||||||
|
}
|
||||||
|
defer ss.Shutdown(context.Background())
|
||||||
|
|
||||||
|
if ss.HTTPSPort() == 0 {
|
||||||
|
t.Fatal("HTTPSPort() = 0, want the armed HTTPS port")
|
||||||
|
}
|
||||||
|
if ss.HasTLSCertificate() {
|
||||||
|
t.Fatal("no certificate should be installed yet")
|
||||||
|
}
|
||||||
|
|
||||||
|
pool := x509.NewCertPool()
|
||||||
|
pool.AddCert(leaf)
|
||||||
|
client := &http.Client{
|
||||||
|
Timeout: 3 * time.Second,
|
||||||
|
Transport: &http.Transport{TLSClientConfig: &tls.Config{RootCAs: pool}},
|
||||||
|
}
|
||||||
|
url := fmt.Sprintf("https://127.0.0.1:%d/health", ss.HTTPSPort())
|
||||||
|
|
||||||
|
// Before a cert is installed, the handshake must fail.
|
||||||
|
if resp, err := client.Get(url); err == nil {
|
||||||
|
resp.Body.Close()
|
||||||
|
t.Fatal("GET succeeded before a certificate was installed; want handshake failure")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Install the cert — the listener stays up and the next handshake succeeds.
|
||||||
|
ss.SetTLSCertificate(&cert)
|
||||||
|
if !ss.HasTLSCertificate() {
|
||||||
|
t.Fatal("HasTLSCertificate() = false after install")
|
||||||
|
}
|
||||||
|
|
||||||
|
var lastErr error
|
||||||
|
for attempt := 0; attempt < 20; attempt++ {
|
||||||
|
resp, err := client.Get(url)
|
||||||
|
if err != nil {
|
||||||
|
lastErr = err
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("GET %s = %d, want 200", url, resp.StatusCode)
|
||||||
|
}
|
||||||
|
return // success
|
||||||
|
}
|
||||||
|
t.Fatalf("GET %s never succeeded after cert install: %v", url, lastErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestStreamServerTLS_Disabled verifies that with TLS not armed, no HTTPS port
|
||||||
|
// is opened and the HTTP listener is unaffected.
|
||||||
|
func TestStreamServerTLS_Disabled(t *testing.T) {
|
||||||
|
ss := NewStreamServer(0)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if err := ss.Listen(ctx); err != nil {
|
||||||
|
t.Fatalf("Listen: %v", err)
|
||||||
|
}
|
||||||
|
defer ss.Shutdown(context.Background())
|
||||||
|
|
||||||
|
if ss.HTTPSPort() != 0 {
|
||||||
|
t.Errorf("HTTPSPort() = %d, want 0 (TLS disabled)", ss.HTTPSPort())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLoadTLSCertificateFromFiles_Missing verifies the loader reports an error
|
||||||
|
// (not a panic) when the cert pair is absent — the daemon treats this as
|
||||||
|
// "TLS off, HTTP keeps serving".
|
||||||
|
func TestLoadTLSCertificateFromFiles_Missing(t *testing.T) {
|
||||||
|
ss := NewStreamServer(0)
|
||||||
|
err := ss.LoadTLSCertificateFromFiles(
|
||||||
|
t.TempDir()+"/nope.crt", t.TempDir()+"/nope.key")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error loading a missing cert pair")
|
||||||
|
}
|
||||||
|
if ss.HasTLSCertificate() {
|
||||||
|
t.Error("no certificate should be installed after a failed load")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -5,6 +5,7 @@ import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
@ -125,7 +126,20 @@ func newTranscodeSource(
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
estimate := estimateOutputSize(probe, opts)
|
// Size estimate for the scrubber timeline. A copy remux (video not
|
||||||
|
// re-encoded) lands within container overhead of the source file, so the
|
||||||
|
// source size is a far better estimate than bitrate×duration — use it.
|
||||||
|
// A real transcode re-encodes, so fall back to the bitrate×duration model.
|
||||||
|
var estimate int64
|
||||||
|
switch action {
|
||||||
|
case ActionPassthrough, ActionRemux, ActionRemuxAudio:
|
||||||
|
if fi, statErr := os.Stat(srcPath); statErr == nil {
|
||||||
|
estimate = fi.Size()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if estimate <= 0 {
|
||||||
|
estimate = estimateOutputSize(probe, opts)
|
||||||
|
}
|
||||||
|
|
||||||
t := &transcodeSource{
|
t := &transcodeSource{
|
||||||
tmpPath: tmpPath,
|
tmpPath: tmpPath,
|
||||||
|
|
@ -151,6 +165,31 @@ func newTranscodeSource(
|
||||||
return t, nil
|
return t, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewRemuxSource starts an ffmpeg `-c copy` remux of srcPath into a growing
|
||||||
|
// fragmented-MP4 temp file and returns it as a GrowingSource for /stream
|
||||||
|
// (hueco #3 / 3b). The video + audio are copied (never re-encoded), so this is
|
||||||
|
// only valid when the codecs are already browser-native (h264 + aac) and only
|
||||||
|
// the container needs changing — the web's decidePlayMethod enforces that
|
||||||
|
// before sending PlayMethod="remux". The browser plays the result progressively
|
||||||
|
// via byte-range. Caller MUST Close() it (kills ffmpeg + removes the temp file).
|
||||||
|
func NewRemuxSource(ctx context.Context, srcPath string, probe *StreamProbe, ffmpegPath, displayName string) (GrowingSource, error) {
|
||||||
|
// Audio: copy when already AAC; otherwise transcode to AAC (ActionRemuxAudio).
|
||||||
|
// Either way the VIDEO is copied — the expensive part is never re-encoded.
|
||||||
|
// This lets remux cover the very common h264+AC3/DTS mkv case (hueco #3 / 3c),
|
||||||
|
// not just h264+AAC.
|
||||||
|
action := ActionRemux
|
||||||
|
if probe != nil && probe.AudioCodec != "" && probe.AudioCodec != "aac" {
|
||||||
|
action = ActionRemuxAudio
|
||||||
|
}
|
||||||
|
opts := TranscodeOpts{Action: action, FFmpegPath: ffmpegPath}
|
||||||
|
// HEVC muxed into MP4 must carry the hvc1 tag or Apple/Safari won't decode
|
||||||
|
// it (hueco #3 / 3c). h264 (avc1) needs no override.
|
||||||
|
if probe != nil && probe.VideoCodec == "hevc" {
|
||||||
|
opts.VideoTag = "hvc1"
|
||||||
|
}
|
||||||
|
return newTranscodeSource(ctx, srcPath, probe, action, opts, displayName)
|
||||||
|
}
|
||||||
|
|
||||||
// signalNotify wakes any goroutine blocked in ReadAt. Non-blocking: if a
|
// signalNotify wakes any goroutine blocked in ReadAt. Non-blocking: if a
|
||||||
// notification is already pending the new event is folded into it (callers
|
// notification is already pending the new event is folded into it (callers
|
||||||
// always re-check size + final after waking, so a coalesced signal still
|
// always re-check size + final after waking, so a coalesced signal still
|
||||||
|
|
@ -184,6 +223,13 @@ func (t *transcodeSource) watchSize(ctx context.Context) {
|
||||||
}
|
}
|
||||||
current := stat.Size()
|
current := stat.Size()
|
||||||
if current > t.size.Load() {
|
if current > t.size.Load() {
|
||||||
|
if t.size.Load() == 0 && current > 0 {
|
||||||
|
// TTFF diagnosis: how long from ffmpeg spawn to the first
|
||||||
|
// fMP4 bytes (init + first fragment) landing — the floor on
|
||||||
|
// when /stream can serve anything playable.
|
||||||
|
log.Printf("[stream] %s first fMP4 bytes after %v (%d KB)",
|
||||||
|
t.name, time.Since(t.startedAt).Round(time.Millisecond), current/1024)
|
||||||
|
}
|
||||||
t.size.Store(current)
|
t.size.Store(current)
|
||||||
t.signalNotify()
|
t.signalNotify()
|
||||||
}
|
}
|
||||||
|
|
|
||||||
340
internal/engine/stream_source_debrid.go
Normal file
340
internal/engine/stream_source_debrid.go
Normal file
|
|
@ -0,0 +1,340 @@
|
||||||
|
// Package engine — stream_source_debrid.go implements a FileProvider that
|
||||||
|
// serves a /stream session straight from a debrid HTTPS direct URL (hueco #2 /
|
||||||
|
// 2a). No local file is involved: the browser's Range requests are translated
|
||||||
|
// into ranged GETs against the debrid link, so a cache-confirmed torrent plays
|
||||||
|
// instantly without ever hitting the swarm or touching disk.
|
||||||
|
//
|
||||||
|
// The web resolves the DirectURL server-side (resolveDebridDirectUrl) and only
|
||||||
|
// sends it when the hash is debrid-cached and the container is browser-native
|
||||||
|
// (mp4/m4v), so this provider stays a pure pass-through — same role as
|
||||||
|
// diskFileProvider/torrentFileProvider, just backed by HTTP Range instead of a
|
||||||
|
// file handle. http.ServeContent drives it exactly like a local file: it Seeks
|
||||||
|
// to discover size + the range start (no network), then Reads (lazy GET).
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"path"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// debridHTTPClient is used for ranged debrid reads. Separate from the download
|
||||||
|
// httpClient so a slow streaming read can't starve a concurrent download's
|
||||||
|
// header-timeout budget, and vice versa. No overall timeout: a paused player
|
||||||
|
// can legitimately hold a body open for minutes; ResponseHeaderTimeout bounds
|
||||||
|
// the part that actually matters (a hung server before first byte).
|
||||||
|
var debridHTTPClient = &http.Client{
|
||||||
|
Transport: &http.Transport{
|
||||||
|
ResponseHeaderTimeout: 30 * time.Second,
|
||||||
|
// debrid CDNs are remote; a generous idle-conn pool avoids a fresh TLS
|
||||||
|
// handshake on every seek-driven reopen.
|
||||||
|
MaxIdleConns: 4,
|
||||||
|
IdleConnTimeout: 90 * time.Second,
|
||||||
|
TLSHandshakeTimeout: 15 * time.Second,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDebridFileProvider builds a FileProvider backed by a debrid HTTPS URL.
|
||||||
|
// It performs a single HEAD up front to learn the exact file size (the torrent
|
||||||
|
// size the web knows can differ from the resolved file's size). If the HEAD
|
||||||
|
// fails or omits Content-Length, fallbackSize (from the StreamSession) is used.
|
||||||
|
// Returns an error only when neither a HEAD size nor a fallback is available —
|
||||||
|
// http.ServeContent needs a real size to range-serve, and serving size 0 would
|
||||||
|
// hand the browser an empty file.
|
||||||
|
// refresh, when non-nil, re-resolves a fresh debrid URL for the same content
|
||||||
|
// (hueco #2 / 2c) — called when the current link expires mid-stream. nil keeps
|
||||||
|
// 2a behaviour (an expired link is a hard error, no recovery).
|
||||||
|
func NewDebridFileProvider(ctx context.Context, directURL, fileName string, fallbackSize int64, refresh func(context.Context) (string, error)) (FileProvider, error) {
|
||||||
|
if directURL == "" {
|
||||||
|
return nil, errors.New("debrid provider: empty direct URL")
|
||||||
|
}
|
||||||
|
size := fallbackSize
|
||||||
|
if headSize, ok := debridHeadSize(ctx, directURL); ok {
|
||||||
|
size = headSize
|
||||||
|
}
|
||||||
|
if size <= 0 {
|
||||||
|
return nil, fmt.Errorf("debrid provider: unknown file size (HEAD gave nothing, no fallback)")
|
||||||
|
}
|
||||||
|
// The name drives the served Content-Type (mimeTypeFromExt on FileName).
|
||||||
|
// The web may pass a torrent title with no extension (its file-name
|
||||||
|
// fallback), which would yield application/octet-stream and break <video>
|
||||||
|
// on strict clients (Safari). The debrid URL reliably ends in the real
|
||||||
|
// file name *with* its extension, so derive from it whenever the passed
|
||||||
|
// name lacks one.
|
||||||
|
name := fileName
|
||||||
|
if name == "" || path.Ext(name) == "" {
|
||||||
|
name = debridNameFromURL(directURL)
|
||||||
|
}
|
||||||
|
return &debridFileProvider{
|
||||||
|
url: directURL,
|
||||||
|
name: name,
|
||||||
|
size: size,
|
||||||
|
refresh: refresh,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// debridFileProvider serves a file from a debrid HTTPS URL via ranged GETs. The
|
||||||
|
// URL is mutable: when it expires mid-stream, refreshURL swaps in a fresh one
|
||||||
|
// (shared across all readers this provider hands out) so the next range request
|
||||||
|
// uses the live link.
|
||||||
|
type debridFileProvider struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
url string
|
||||||
|
lastRefreshAt time.Time
|
||||||
|
inflight *refreshCall // non-nil while a refresh is running; coalesces concurrent callers
|
||||||
|
refresh func(context.Context) (string, error)
|
||||||
|
|
||||||
|
name string
|
||||||
|
size int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// refreshCall is a single in-flight refresh whose result is shared by every
|
||||||
|
// reader that piles up behind it (singleflight). done is closed on completion.
|
||||||
|
type refreshCall struct {
|
||||||
|
done chan struct{}
|
||||||
|
url string
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// currentURL returns the live debrid URL (mutated by refreshURL on expiry).
|
||||||
|
func (p *debridFileProvider) currentURL() string {
|
||||||
|
p.mu.Lock()
|
||||||
|
defer p.mu.Unlock()
|
||||||
|
return p.url
|
||||||
|
}
|
||||||
|
|
||||||
|
// refreshURL re-resolves a fresh debrid link and stores it. A browser's <video>
|
||||||
|
// opens several concurrent range connections, so when a link expires N readers
|
||||||
|
// hit it at once — they must NOT each fire a (multi-second) re-resolution.
|
||||||
|
// Coalescing is two-layer: (1) a result refreshed in the last few seconds is
|
||||||
|
// reused without any call; (2) while a refresh is in flight, late callers wait
|
||||||
|
// on it and share its result (singleflight) rather than starting their own.
|
||||||
|
func (p *debridFileProvider) refreshURL(ctx context.Context) (string, error) {
|
||||||
|
if p.refresh == nil {
|
||||||
|
return "", errors.New("debrid provider: no URL refresher (refresh disabled)")
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
if time.Since(p.lastRefreshAt) < 5*time.Second && p.url != "" {
|
||||||
|
u := p.url
|
||||||
|
p.mu.Unlock()
|
||||||
|
return u, nil // refreshed very recently — reuse it
|
||||||
|
}
|
||||||
|
if call := p.inflight; call != nil {
|
||||||
|
p.mu.Unlock()
|
||||||
|
select {
|
||||||
|
case <-call.done:
|
||||||
|
return call.url, call.err // shared result from the in-flight refresh
|
||||||
|
case <-ctx.Done():
|
||||||
|
return "", ctx.Err()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
call := &refreshCall{done: make(chan struct{})}
|
||||||
|
p.inflight = call
|
||||||
|
p.mu.Unlock()
|
||||||
|
|
||||||
|
u, err := p.refresh(ctx)
|
||||||
|
|
||||||
|
p.mu.Lock()
|
||||||
|
if err == nil {
|
||||||
|
p.url = u
|
||||||
|
p.lastRefreshAt = time.Now()
|
||||||
|
}
|
||||||
|
call.url, call.err = u, err
|
||||||
|
p.inflight = nil
|
||||||
|
close(call.done)
|
||||||
|
p.mu.Unlock()
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
log.Printf("[stream] debrid URL refreshed (expired mid-stream)")
|
||||||
|
return u, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *debridFileProvider) NewFileReader(ctx context.Context) io.ReadSeekCloser {
|
||||||
|
return &debridRangeReader{
|
||||||
|
ctx: ctx,
|
||||||
|
prov: p,
|
||||||
|
size: p.size,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *debridFileProvider) FileName() string { return p.name }
|
||||||
|
func (p *debridFileProvider) FileSize() int64 { return p.size }
|
||||||
|
|
||||||
|
// debridRangeReader is an io.ReadSeekCloser over an HTTP resource that supports
|
||||||
|
// Range. Seek is network-free: it only moves the logical position. Read opens
|
||||||
|
// (or reuses) a GET starting at the current position and streams the body; a
|
||||||
|
// Seek that moves away from the open body's cursor forces a reopen on the next
|
||||||
|
// Read. This matches how http.ServeContent works — Seek(0, SeekEnd) for size,
|
||||||
|
// Seek to the range start, then sequential Reads — so seeks the user makes in
|
||||||
|
// the player become a single reopened GET, never a full re-download.
|
||||||
|
type debridRangeReader struct {
|
||||||
|
ctx context.Context
|
||||||
|
prov *debridFileProvider
|
||||||
|
size int64
|
||||||
|
|
||||||
|
pos int64 // logical position (moved by Seek, advanced by Read)
|
||||||
|
body io.ReadCloser // current open response body, or nil
|
||||||
|
bodyAt int64 // position the open body's next byte maps to
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *debridRangeReader) Read(p []byte) (int, error) {
|
||||||
|
if r.size > 0 && r.pos >= r.size {
|
||||||
|
return 0, io.EOF
|
||||||
|
}
|
||||||
|
// (Re)open when no body is held or a Seek moved us off the open body.
|
||||||
|
if r.body == nil || r.pos != r.bodyAt {
|
||||||
|
if err := r.reopen(); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
n, err := r.body.Read(p)
|
||||||
|
r.pos += int64(n)
|
||||||
|
r.bodyAt = r.pos
|
||||||
|
if err == io.EOF {
|
||||||
|
// Body drained. Drop it so the next Read reopens (covers a server that
|
||||||
|
// closed the connection before the logical EOF). Surface EOF to the
|
||||||
|
// caller only when we've actually reached end-of-file; otherwise hand
|
||||||
|
// back the bytes read with no error and let the caller Read again.
|
||||||
|
_ = r.body.Close()
|
||||||
|
r.body = nil
|
||||||
|
if r.size > 0 && r.pos < r.size {
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *debridRangeReader) Seek(offset int64, whence int) (int64, error) {
|
||||||
|
var abs int64
|
||||||
|
switch whence {
|
||||||
|
case io.SeekStart:
|
||||||
|
abs = offset
|
||||||
|
case io.SeekCurrent:
|
||||||
|
abs = r.pos + offset
|
||||||
|
case io.SeekEnd:
|
||||||
|
abs = r.size + offset
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("debrid reader: invalid whence %d", whence)
|
||||||
|
}
|
||||||
|
if abs < 0 {
|
||||||
|
return 0, errors.New("debrid reader: negative position")
|
||||||
|
}
|
||||||
|
r.pos = abs
|
||||||
|
return abs, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *debridRangeReader) Close() error {
|
||||||
|
if r.body != nil {
|
||||||
|
err := r.body.Close()
|
||||||
|
r.body = nil
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// reopen issues a fresh ranged GET from the current logical position. Closes
|
||||||
|
// any previously held body first. On an expired-link status (401/403/404/410)
|
||||||
|
// it re-resolves a fresh debrid URL via the provider and retries — bounded, so
|
||||||
|
// a permanently-dead link surfaces an error instead of looping (hueco #2 / 2c).
|
||||||
|
func (r *debridRangeReader) reopen() error {
|
||||||
|
if r.body != nil {
|
||||||
|
_ = r.body.Close()
|
||||||
|
r.body = nil
|
||||||
|
}
|
||||||
|
// Attempts: 1 initial + 1 after a URL refresh. One fresh link is enough for
|
||||||
|
// an expiry; if the refreshed link ALSO fails the content is genuinely gone,
|
||||||
|
// so surface the error rather than burning more multi-second resolutions.
|
||||||
|
const maxAttempts = 2
|
||||||
|
for attempt := 0; attempt < maxAttempts; attempt++ {
|
||||||
|
req, err := http.NewRequestWithContext(r.ctx, http.MethodGet, r.prov.currentURL(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("debrid reader: build request: %w", err)
|
||||||
|
}
|
||||||
|
// Always send a Range so a seek to 0 still gets a 206 (and so partial
|
||||||
|
// reopens after a mid-file seek work). An open-ended range runs to EOF.
|
||||||
|
req.Header.Set("Range", fmt.Sprintf("bytes=%d-", r.pos))
|
||||||
|
resp, err := debridHTTPClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("debrid reader: GET: %w", err)
|
||||||
|
}
|
||||||
|
switch resp.StatusCode {
|
||||||
|
case http.StatusPartialContent:
|
||||||
|
r.body = resp.Body
|
||||||
|
r.bodyAt = r.pos
|
||||||
|
return nil
|
||||||
|
case http.StatusOK:
|
||||||
|
// Server ignored Range and is sending the whole file from 0. Only
|
||||||
|
// valid when we asked from 0; otherwise bytes wouldn't line up.
|
||||||
|
if r.pos != 0 {
|
||||||
|
resp.Body.Close()
|
||||||
|
return fmt.Errorf("debrid reader: server ignored Range at offset %d (got 200)", r.pos)
|
||||||
|
}
|
||||||
|
r.body = resp.Body
|
||||||
|
r.bodyAt = r.pos
|
||||||
|
return nil
|
||||||
|
case http.StatusRequestedRangeNotSatisfiable:
|
||||||
|
resp.Body.Close()
|
||||||
|
return io.EOF // seeked past end — treat as EOF, not a hard error
|
||||||
|
case http.StatusUnauthorized, http.StatusForbidden, http.StatusNotFound, http.StatusGone:
|
||||||
|
// Expired/dead debrid link — re-resolve and retry with the fresh URL.
|
||||||
|
resp.Body.Close()
|
||||||
|
if _, rerr := r.prov.refreshURL(r.ctx); rerr != nil {
|
||||||
|
return fmt.Errorf("debrid reader: link expired (%d) and refresh failed: %w", resp.StatusCode, rerr)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
default:
|
||||||
|
resp.Body.Close()
|
||||||
|
return fmt.Errorf("debrid reader: unexpected status %d %s", resp.StatusCode, resp.Status)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("debrid reader: link still failing after %d refresh attempts", maxAttempts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// debridHeadSize issues a HEAD and returns the Content-Length when present.
|
||||||
|
// Best-effort: any failure returns (0, false) so the caller falls back to the
|
||||||
|
// size the web reported. A short timeout keeps a slow/HEAD-hostile CDN from
|
||||||
|
// stalling session setup — the fallback size is good enough to start.
|
||||||
|
func debridHeadSize(ctx context.Context, url string) (int64, bool) {
|
||||||
|
// 15s (not 10s): the transport's TLS handshake budget alone is 15s, so a
|
||||||
|
// slow debrid CDN could trip the old 10s timeout before headers arrived,
|
||||||
|
// needlessly falling back to a guessed size.
|
||||||
|
hctx, cancel := context.WithTimeout(ctx, 15*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
req, err := http.NewRequestWithContext(hctx, http.MethodHead, url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
resp, err := debridHTTPClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[stream] debrid HEAD failed (using fallback size): %v", err)
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK || resp.ContentLength <= 0 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
return resp.ContentLength, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// debridNameFromURL extracts a filename from a URL path as a last resort when
|
||||||
|
// the server didn't send one. Strips query/fragment via path.Base on the path.
|
||||||
|
func debridNameFromURL(rawURL string) string {
|
||||||
|
u := rawURL
|
||||||
|
if i := strings.IndexAny(u, "?#"); i >= 0 {
|
||||||
|
u = u[:i]
|
||||||
|
}
|
||||||
|
base := path.Base(u)
|
||||||
|
if base == "" || base == "." || base == "/" {
|
||||||
|
return "video.mp4"
|
||||||
|
}
|
||||||
|
return base
|
||||||
|
}
|
||||||
368
internal/engine/stream_source_debrid_test.go
Normal file
368
internal/engine/stream_source_debrid_test.go
Normal file
|
|
@ -0,0 +1,368 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// rangeServer serves a fixed byte slice with full HTTP Range support via
|
||||||
|
// http.ServeContent (the same machinery a real debrid CDN exposes). Records
|
||||||
|
// the number of GETs so a test can assert that a seek triggers exactly one
|
||||||
|
// reopen rather than a full re-download.
|
||||||
|
func rangeServer(data []byte) (*httptest.Server, *int) {
|
||||||
|
gets := 0
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method == http.MethodGet {
|
||||||
|
gets++
|
||||||
|
}
|
||||||
|
http.ServeContent(w, r, "movie.mp4", time.Time{}, bytes.NewReader(data))
|
||||||
|
}))
|
||||||
|
return srv, &gets
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeData(n int) []byte {
|
||||||
|
b := make([]byte, n)
|
||||||
|
for i := range b {
|
||||||
|
b[i] = byte(i % 251) // non-trivial, deterministic pattern
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridProviderHeadSize(t *testing.T) {
|
||||||
|
data := makeData(4096)
|
||||||
|
srv, _ := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
// HEAD reports the real size; fallback is ignored when HEAD succeeds.
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 999, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewDebridFileProvider: %v", err)
|
||||||
|
}
|
||||||
|
if got := p.FileSize(); got != int64(len(data)) {
|
||||||
|
t.Fatalf("FileSize from HEAD = %d, want %d", got, len(data))
|
||||||
|
}
|
||||||
|
if p.FileName() != "movie.mp4" {
|
||||||
|
t.Fatalf("FileName = %q, want movie.mp4", p.FileName())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridProviderNameFromURLWhenNoExtension(t *testing.T) {
|
||||||
|
// The web may pass a torrent title with no extension (its file-name
|
||||||
|
// fallback). The provider must derive the name from the URL so the served
|
||||||
|
// Content-Type is video/mp4, not application/octet-stream.
|
||||||
|
data := makeData(1024)
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
http.ServeContent(w, r, "x", time.Time{}, bytes.NewReader(data))
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), srv.URL+"/Movie.2026.1080p.mp4?token=abc", "Project Hail Mary (2026) 1080p web", 0, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provider: %v", err)
|
||||||
|
}
|
||||||
|
if got := p.FileName(); got != "Movie.2026.1080p.mp4" {
|
||||||
|
t.Fatalf("FileName = %q, want Movie.2026.1080p.mp4 (derived from URL)", got)
|
||||||
|
}
|
||||||
|
// A passed name WITH an extension is kept as-is.
|
||||||
|
p2, _ := NewDebridFileProvider(context.Background(), srv.URL+"/whatever.mp4", "Nice Title.mp4", 0, nil)
|
||||||
|
if got := p2.FileName(); got != "Nice Title.mp4" {
|
||||||
|
t.Fatalf("FileName = %q, want Nice Title.mp4 (kept)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridProviderFallbackSizeWhenNoHead(t *testing.T) {
|
||||||
|
// Server that refuses HEAD (405) but serves GET — provider must fall back
|
||||||
|
// to the size the web reported.
|
||||||
|
data := makeData(2048)
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method == http.MethodHead {
|
||||||
|
w.WriteHeader(http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
http.ServeContent(w, r, "movie.mp4", time.Time{}, bytes.NewReader(data))
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", int64(len(data)), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewDebridFileProvider: %v", err)
|
||||||
|
}
|
||||||
|
if got := p.FileSize(); got != int64(len(data)) {
|
||||||
|
t.Fatalf("FileSize fallback = %d, want %d", got, len(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridProviderNoSizeFails(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusMethodNotAllowed) // no HEAD, no usable GET
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
// No HEAD size and fallback 0 → must error (ServeContent can't range-serve
|
||||||
|
// size 0 without handing the browser an empty file).
|
||||||
|
if _, err := NewDebridFileProvider(context.Background(), srv.URL, "", 0, nil); err == nil {
|
||||||
|
t.Fatal("expected error when size is unknown, got nil")
|
||||||
|
}
|
||||||
|
if _, err := NewDebridFileProvider(context.Background(), "", "movie.mp4", 100, nil); err == nil {
|
||||||
|
t.Fatal("expected error for empty URL, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderSequentialRead(t *testing.T) {
|
||||||
|
data := makeData(100_000)
|
||||||
|
srv, gets := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 0, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provider: %v", err)
|
||||||
|
}
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
got, err := io.ReadAll(rd)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadAll: %v", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(got, data) {
|
||||||
|
t.Fatalf("sequential read mismatch: got %d bytes, want %d", len(got), len(data))
|
||||||
|
}
|
||||||
|
// A pure sequential read holds a single body to EOF → exactly one GET.
|
||||||
|
if *gets != 1 {
|
||||||
|
t.Fatalf("sequential read issued %d GETs, want 1", *gets)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderSeekEndReportsSize(t *testing.T) {
|
||||||
|
data := makeData(5000)
|
||||||
|
srv, _ := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 0, nil)
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
// http.ServeContent calls Seek(0, SeekEnd) to learn the size — must be
|
||||||
|
// network-free and return the total.
|
||||||
|
size, err := rd.Seek(0, io.SeekEnd)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Seek end: %v", err)
|
||||||
|
}
|
||||||
|
if size != int64(len(data)) {
|
||||||
|
t.Fatalf("SeekEnd = %d, want %d", size, len(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderSeekThenRead(t *testing.T) {
|
||||||
|
data := makeData(50_000)
|
||||||
|
srv, gets := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 0, nil)
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
const off = 12_345
|
||||||
|
if _, err := rd.Seek(off, io.SeekStart); err != nil {
|
||||||
|
t.Fatalf("seek: %v", err)
|
||||||
|
}
|
||||||
|
got, err := io.ReadAll(rd)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadAll after seek: %v", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(got, data[off:]) {
|
||||||
|
t.Fatalf("tail mismatch: got %d bytes, want %d", len(got), len(data)-off)
|
||||||
|
}
|
||||||
|
// Seek is network-free; the read after it is the only GET.
|
||||||
|
if *gets != 1 {
|
||||||
|
t.Fatalf("seek+read issued %d GETs, want 1", *gets)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderServeContentRoundTrip(t *testing.T) {
|
||||||
|
// Drive the reader exactly like StreamServer does: hand it to
|
||||||
|
// http.ServeContent and issue a ranged request. Verifies the reader is a
|
||||||
|
// correct io.ReadSeeker for the production serving path.
|
||||||
|
data := makeData(80_000)
|
||||||
|
srv, _ := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 0, nil)
|
||||||
|
|
||||||
|
front := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
rd := p.NewFileReader(r.Context())
|
||||||
|
defer rd.Close()
|
||||||
|
http.ServeContent(w, r, p.FileName(), time.Time{}, rd)
|
||||||
|
}))
|
||||||
|
defer front.Close()
|
||||||
|
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, front.URL, nil)
|
||||||
|
req.Header.Set("Range", "bytes=10000-19999")
|
||||||
|
resp, err := http.DefaultClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ranged GET: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusPartialContent {
|
||||||
|
t.Fatalf("status = %d, want 206", resp.StatusCode)
|
||||||
|
}
|
||||||
|
body, _ := io.ReadAll(resp.Body)
|
||||||
|
want := data[10000:20000]
|
||||||
|
if !bytes.Equal(body, want) {
|
||||||
|
t.Fatalf("ranged body mismatch: got %d bytes", len(body))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderSeekPastEnd(t *testing.T) {
|
||||||
|
data := makeData(1000)
|
||||||
|
srv, _ := rangeServer(data)
|
||||||
|
defer srv.Close()
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", 0, nil)
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
// Seeking at/past size then reading yields EOF, no error, no bytes.
|
||||||
|
if _, err := rd.Seek(int64(len(data)), io.SeekStart); err != nil {
|
||||||
|
t.Fatalf("seek: %v", err)
|
||||||
|
}
|
||||||
|
n, err := rd.Read(make([]byte, 16))
|
||||||
|
if n != 0 || err != io.EOF {
|
||||||
|
t.Fatalf("read past end = (%d, %v), want (0, EOF)", n, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// hueco #2 / 2c — an expired link (401) is recovered by re-resolving a fresh
|
||||||
|
// URL via the refresh callback and retrying, transparent to the reader.
|
||||||
|
func TestDebridReaderRefreshOnExpiry(t *testing.T) {
|
||||||
|
data := makeData(20_000)
|
||||||
|
live, _ := rangeServer(data)
|
||||||
|
defer live.Close()
|
||||||
|
expired := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusUnauthorized) // link expired
|
||||||
|
}))
|
||||||
|
defer expired.Close()
|
||||||
|
|
||||||
|
refreshed := 0
|
||||||
|
refresh := func(_ context.Context) (string, error) {
|
||||||
|
refreshed++
|
||||||
|
return live.URL, nil
|
||||||
|
}
|
||||||
|
// HEAD on the expired URL 401s → falls back to the provided size.
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), expired.URL, "movie.mp4", int64(len(data)), refresh)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provider: %v", err)
|
||||||
|
}
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
got, err := io.ReadAll(rd)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadAll after expiry+refresh: %v", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(got, data) {
|
||||||
|
t.Fatalf("post-refresh read mismatch: got %d bytes, want %d", len(got), len(data))
|
||||||
|
}
|
||||||
|
if refreshed == 0 {
|
||||||
|
t.Fatal("expected the reader to refresh the expired URL")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Coalescing: when N readers hit an expired link at once, only ONE refresh
|
||||||
|
// runs (singleflight) and they all share its result — not N re-resolutions
|
||||||
|
// hammering the web (hueco #2 / 2c).
|
||||||
|
func TestDebridProviderRefreshCoalesces(t *testing.T) {
|
||||||
|
data := makeData(8000)
|
||||||
|
live, _ := rangeServer(data)
|
||||||
|
defer live.Close()
|
||||||
|
|
||||||
|
var refreshCalls int64
|
||||||
|
refresh := func(_ context.Context) (string, error) {
|
||||||
|
atomic.AddInt64(&refreshCalls, 1)
|
||||||
|
time.Sleep(80 * time.Millisecond) // simulate a slow re-resolution
|
||||||
|
return live.URL, nil
|
||||||
|
}
|
||||||
|
p := &debridFileProvider{url: "https://expired.invalid/x.mp4", refresh: refresh}
|
||||||
|
|
||||||
|
const N = 8
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
errs := make([]error, N)
|
||||||
|
for i := 0; i < N; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(i int) {
|
||||||
|
defer wg.Done()
|
||||||
|
_, errs[i] = p.refreshURL(context.Background())
|
||||||
|
}(i)
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
for i, err := range errs {
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("reader %d refresh failed: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if got := atomic.LoadInt64(&refreshCalls); got != 1 {
|
||||||
|
t.Fatalf("expected 1 coalesced refresh for %d concurrent readers, got %d", N, got)
|
||||||
|
}
|
||||||
|
if p.currentURL() != live.URL {
|
||||||
|
t.Fatalf("provider URL = %q, want the refreshed live URL", p.currentURL())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderRefreshFailsSurfacesError(t *testing.T) {
|
||||||
|
expired := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusForbidden)
|
||||||
|
}))
|
||||||
|
defer expired.Close()
|
||||||
|
refresh := func(_ context.Context) (string, error) {
|
||||||
|
return "", errors.New("debrid gone")
|
||||||
|
}
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), expired.URL, "movie.mp4", 1000, refresh)
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
if _, err := rd.Read(make([]byte, 16)); err == nil {
|
||||||
|
t.Fatal("expected an error when refresh fails, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderNoRefresherExpiryIsHardError(t *testing.T) {
|
||||||
|
// refresh == nil (2a behaviour): an expired link is a hard error, no retry.
|
||||||
|
expired := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusGone)
|
||||||
|
}))
|
||||||
|
defer expired.Close()
|
||||||
|
p, _ := NewDebridFileProvider(context.Background(), expired.URL, "movie.mp4", 1000, nil)
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
if _, err := rd.Read(make([]byte, 16)); err == nil {
|
||||||
|
t.Fatal("expected a hard error with no refresher, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDebridReaderRejectsServerIgnoringRange(t *testing.T) {
|
||||||
|
// A server that always returns 200 (ignores Range) is only safe at pos 0.
|
||||||
|
// A reopen at a non-zero offset (after a seek) must error rather than serve
|
||||||
|
// misaligned bytes.
|
||||||
|
data := makeData(4000)
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set("Content-Length", "4000")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.Write(data)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
p, err := NewDebridFileProvider(context.Background(), srv.URL, "movie.mp4", int64(len(data)), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provider: %v", err)
|
||||||
|
}
|
||||||
|
rd := p.NewFileReader(context.Background())
|
||||||
|
defer rd.Close()
|
||||||
|
|
||||||
|
if _, err := rd.Seek(1000, io.SeekStart); err != nil {
|
||||||
|
t.Fatalf("seek: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := rd.Read(make([]byte, 16)); err == nil {
|
||||||
|
t.Fatal("expected error when server ignores Range at non-zero offset, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
116
internal/engine/stream_token.go
Normal file
116
internal/engine/stream_token.go
Normal file
|
|
@ -0,0 +1,116 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/hex"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Stream authentication.
|
||||||
|
//
|
||||||
|
// /stream and /hls have no header-based auth: a <video src> cannot attach an
|
||||||
|
// Authorization header, and media-tag/segment requests are issued by the
|
||||||
|
// browser, not our JS. So we bind a short-lived, unforgeable token to each
|
||||||
|
// stream URL the daemon hands out and verify it on every request.
|
||||||
|
//
|
||||||
|
// The token is HMAC-signed by the daemon's own in-memory secret — there is no
|
||||||
|
// server-side token store and no DB column. The web is a pure pass-through: it
|
||||||
|
// stores and serves whatever tokenised URL the agent reports.
|
||||||
|
//
|
||||||
|
// - /stream (+ VLC playlist): token rides as a `?t=` query parameter.
|
||||||
|
// - /hls: token rides as a PATH segment — /hls/<sessionID>/<token>/<resource>
|
||||||
|
// — so the relative child URIs inside the playlists (video/index.m3u8,
|
||||||
|
// seg-N.m4s, subs/…) resolve under the same prefix and carry the token
|
||||||
|
// automatically, with zero playlist rewriting.
|
||||||
|
//
|
||||||
|
// There is NO loopback exemption: the Cloudflare funnel proxies public traffic
|
||||||
|
// to the daemon over localhost (cloudflared --url http://localhost:<port>), so
|
||||||
|
// a loopback source address is NOT a trust signal — exempting it would leave the
|
||||||
|
// funnel (the headline public path) wide open. Every URL the agent/web hands a
|
||||||
|
// player is already tokenised (URL(), URLsJSON, buildHlsUrls), so enforcing the
|
||||||
|
// token unconditionally breaks no legitimate client. /health stays ungated (a
|
||||||
|
// reachability probe that leaks nothing sensitive).
|
||||||
|
|
||||||
|
const (
|
||||||
|
// streamTokenTTL is how long a minted token stays valid. Long enough for a
|
||||||
|
// movie plus pauses; short enough that a leaked URL stops working same-day.
|
||||||
|
streamTokenTTL = 6 * time.Hour
|
||||||
|
|
||||||
|
// streamScopeStream is the token scope for the single-file /stream endpoint.
|
||||||
|
streamScopeStream = "stream"
|
||||||
|
)
|
||||||
|
|
||||||
|
// streamScopeHLS is the token scope for an HLS session. Binding to the session
|
||||||
|
// id means a token minted for one session never validates another.
|
||||||
|
func streamScopeHLS(sessionID string) string { return "hls:" + sessionID }
|
||||||
|
|
||||||
|
// streamScopeThumb is the token scope for a single-frame thumbnail of a
|
||||||
|
// specific file (the web's "file characteristics" panel). Binding the file
|
||||||
|
// path's SHA-256 into the scope means a token minted for one file never
|
||||||
|
// validates a thumbnail request for another — a leaked thumbnail URL exposes
|
||||||
|
// only the one frame-source it was signed for. The web mints the matching
|
||||||
|
// scope in src/lib/stream-token.ts (streamScopeThumb), byte-for-byte.
|
||||||
|
func streamScopeThumb(filePath string) string {
|
||||||
|
sum := sha256.Sum256([]byte(filePath))
|
||||||
|
return "thumb:" + hex.EncodeToString(sum[:])
|
||||||
|
}
|
||||||
|
|
||||||
|
// streamScopeSub is the token scope for on-demand WebVTT extraction of one text
|
||||||
|
// subtitle stream from a specific file (the /sub endpoint, used identically by
|
||||||
|
// direct-play and HLS so subtitles are consistent across both). Binds the file
|
||||||
|
// path's SHA-256 + the subtitle stream index, so a leaked URL exposes only that
|
||||||
|
// one track of that one file. The web mints the matching scope in
|
||||||
|
// src/lib/stream-token.ts (streamScopeSub), byte-for-byte.
|
||||||
|
func streamScopeSub(filePath string, index int) string {
|
||||||
|
sum := sha256.Sum256([]byte(filePath))
|
||||||
|
return "sub:" + hex.EncodeToString(sum[:]) + ":" + strconv.Itoa(index)
|
||||||
|
}
|
||||||
|
|
||||||
|
// newStreamSecret returns 32 cryptographically-random bytes used to sign stream
|
||||||
|
// tokens for the lifetime of the daemon. Regenerated each start, so tokens from
|
||||||
|
// a previous run stop validating (the web re-resolves the URL on demand).
|
||||||
|
func newStreamSecret() []byte {
|
||||||
|
b := make([]byte, 32)
|
||||||
|
if _, err := rand.Read(b); err != nil {
|
||||||
|
// crypto/rand.Read does not fail on supported platforms. If it ever
|
||||||
|
// does, fail hard rather than fall back to a predictable key while still
|
||||||
|
// claiming to enforce auth — a guessable key is worse than no streaming.
|
||||||
|
panic("unarr: crypto/rand unavailable, cannot generate stream secret: " + err.Error())
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// mintStreamToken issues `<expUnix>.<hexHMAC>` binding scope to an expiry.
|
||||||
|
// Verification needs only the same secret + scope.
|
||||||
|
func mintStreamToken(secret []byte, scope string, now time.Time) string {
|
||||||
|
expStr := strconv.FormatInt(now.Add(streamTokenTTL).Unix(), 10)
|
||||||
|
return expStr + "." + streamTokenMAC(secret, scope, expStr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func streamTokenMAC(secret []byte, scope, expStr string) string {
|
||||||
|
m := hmac.New(sha256.New, secret)
|
||||||
|
m.Write([]byte(scope + ":" + expStr))
|
||||||
|
return hex.EncodeToString(m.Sum(nil))
|
||||||
|
}
|
||||||
|
|
||||||
|
// verifyStreamToken reports whether token is a valid, unexpired signature for
|
||||||
|
// scope under secret. Cheap rejects (format, expiry) happen before the
|
||||||
|
// constant-time MAC compare since they don't depend on the secret.
|
||||||
|
func verifyStreamToken(secret []byte, scope, token string, now time.Time) bool {
|
||||||
|
dot := strings.IndexByte(token, '.')
|
||||||
|
if dot <= 0 || dot >= len(token)-1 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
expStr, gotMAC := token[:dot], token[dot+1:]
|
||||||
|
exp, err := strconv.ParseInt(expStr, 10, 64)
|
||||||
|
if err != nil || now.Unix() > exp {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
wantMAC := streamTokenMAC(secret, scope, expStr)
|
||||||
|
return subtle.ConstantTimeCompare([]byte(gotMAC), []byte(wantMAC)) == 1
|
||||||
|
}
|
||||||
224
internal/engine/stream_token_test.go
Normal file
224
internal/engine/stream_token_test.go
Normal file
|
|
@ -0,0 +1,224 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestStreamToken_RoundTrip(t *testing.T) {
|
||||||
|
secret := newStreamSecret()
|
||||||
|
now := time.Now()
|
||||||
|
tok := mintStreamToken(secret, streamScopeStream, now)
|
||||||
|
if !verifyStreamToken(secret, streamScopeStream, tok, now) {
|
||||||
|
t.Fatalf("freshly minted token failed to verify: %q", tok)
|
||||||
|
}
|
||||||
|
// Still valid just before expiry.
|
||||||
|
if !verifyStreamToken(secret, streamScopeStream, tok, now.Add(streamTokenTTL-time.Minute)) {
|
||||||
|
t.Error("token rejected before its TTL elapsed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamToken_Expired(t *testing.T) {
|
||||||
|
secret := newStreamSecret()
|
||||||
|
now := time.Now()
|
||||||
|
tok := mintStreamToken(secret, streamScopeStream, now)
|
||||||
|
if verifyStreamToken(secret, streamScopeStream, tok, now.Add(streamTokenTTL+time.Second)) {
|
||||||
|
t.Error("expired token verified as valid")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamToken_WrongScope(t *testing.T) {
|
||||||
|
secret := newStreamSecret()
|
||||||
|
now := time.Now()
|
||||||
|
tok := mintStreamToken(secret, streamScopeHLS("abc"), now)
|
||||||
|
if verifyStreamToken(secret, streamScopeStream, tok, now) {
|
||||||
|
t.Error("token for one scope verified under another")
|
||||||
|
}
|
||||||
|
if verifyStreamToken(secret, streamScopeHLS("xyz"), tok, now) {
|
||||||
|
t.Error("hls token verified for a different session id")
|
||||||
|
}
|
||||||
|
if !verifyStreamToken(secret, streamScopeHLS("abc"), tok, now) {
|
||||||
|
t.Error("hls token failed to verify under its own session id")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamToken_WrongSecret(t *testing.T) {
|
||||||
|
now := time.Now()
|
||||||
|
tok := mintStreamToken(newStreamSecret(), streamScopeStream, now)
|
||||||
|
if verifyStreamToken(newStreamSecret(), streamScopeStream, tok, now) {
|
||||||
|
t.Error("token verified under a different secret")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamToken_Tampered(t *testing.T) {
|
||||||
|
secret := newStreamSecret()
|
||||||
|
now := time.Now()
|
||||||
|
tok := mintStreamToken(secret, streamScopeStream, now)
|
||||||
|
// Flip the last hex char of the MAC.
|
||||||
|
last := tok[len(tok)-1]
|
||||||
|
flip := byte('0')
|
||||||
|
if last == '0' {
|
||||||
|
flip = '1'
|
||||||
|
}
|
||||||
|
tampered := tok[:len(tok)-1] + string(flip)
|
||||||
|
if verifyStreamToken(secret, streamScopeStream, tampered, now) {
|
||||||
|
t.Error("tampered MAC verified as valid")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamToken_Malformed(t *testing.T) {
|
||||||
|
secret := newStreamSecret()
|
||||||
|
now := time.Now()
|
||||||
|
for _, bad := range []string{
|
||||||
|
"",
|
||||||
|
"nodot",
|
||||||
|
"123.", // empty MAC
|
||||||
|
".deadbeef", // empty exp
|
||||||
|
"notanint.abc", // non-numeric exp
|
||||||
|
".",
|
||||||
|
} {
|
||||||
|
if verifyStreamToken(secret, streamScopeStream, bad, now) {
|
||||||
|
t.Errorf("malformed token %q verified as valid", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestVerifyStreamToken_CrossLangVector pins the wire format against the web's
|
||||||
|
// TypeScript minter (tests/unit/stream-token.test.ts asserts the same vector).
|
||||||
|
// A token the web mints MUST verify here or remote HLS playback 404s.
|
||||||
|
func TestVerifyStreamToken_CrossLangVector(t *testing.T) {
|
||||||
|
secret := make([]byte, 32)
|
||||||
|
for i := range secret {
|
||||||
|
secret[i] = 0xab // matches secretHex "ab"*32 on the web side
|
||||||
|
}
|
||||||
|
const (
|
||||||
|
sessionID = "sess-1"
|
||||||
|
token = "1900000000.3ee840ccf2c2a42b784d7cef68458db1d3cea5ecdcab41061504de32eb52fbc2"
|
||||||
|
)
|
||||||
|
before := time.Unix(1899978400, 0) // before exp 1900000000
|
||||||
|
if !verifyStreamToken(secret, streamScopeHLS(sessionID), token, before) {
|
||||||
|
t.Fatal("web-minted parity token failed to verify in the daemon")
|
||||||
|
}
|
||||||
|
after := time.Unix(1900000001, 0) // past exp
|
||||||
|
if verifyStreamToken(secret, streamScopeHLS(sessionID), token, after) {
|
||||||
|
t.Error("parity token verified past its expiry")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewStreamSecret_LengthAndUniqueness(t *testing.T) {
|
||||||
|
a, b := newStreamSecret(), newStreamSecret()
|
||||||
|
if len(a) != 32 {
|
||||||
|
t.Errorf("secret length = %d, want 32", len(a))
|
||||||
|
}
|
||||||
|
if string(a) == string(b) {
|
||||||
|
t.Error("two secrets were identical — not random")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /stream handler enforcement ---------------------------------------------
|
||||||
|
|
||||||
|
func streamReq(remoteAddr, query string) *http.Request {
|
||||||
|
r := httptest.NewRequest(http.MethodGet, "http://stream.test/stream"+query, nil)
|
||||||
|
r.RemoteAddr = remoteAddr
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func newServedServer(t *testing.T) *StreamServer {
|
||||||
|
t.Helper()
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
srv.SetFile(newFakeProvider("movie.mkv", []byte("fake video bytes")), "task-1")
|
||||||
|
return srv
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_RemoteWithoutToken_404(t *testing.T) {
|
||||||
|
srv := newServedServer(t)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("198.51.100.7:40000", ""))
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("remote request without token: status = %d, want 404", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_RemoteValidToken_200(t *testing.T) {
|
||||||
|
srv := newServedServer(t)
|
||||||
|
tok := mintStreamToken(srv.streamSecret, streamScopeStream, time.Now())
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("198.51.100.7:40000", "?t="+tok))
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Errorf("remote request with valid token: status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_RemoteBadToken_404(t *testing.T) {
|
||||||
|
srv := newServedServer(t)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("198.51.100.7:40000", "?t=deadbeef.0000"))
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("remote request with bad token: status = %d, want 404", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_LoopbackWithoutToken_404(t *testing.T) {
|
||||||
|
// No loopback exemption: cloudflared relays public funnel traffic over
|
||||||
|
// localhost, so loopback must still present a valid token.
|
||||||
|
srv := newServedServer(t)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("127.0.0.1:55555", ""))
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("loopback request without token: status = %d, want 404 (no exemption)", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_LoopbackWithValidToken_200(t *testing.T) {
|
||||||
|
srv := newServedServer(t)
|
||||||
|
tok := mintStreamToken(srv.streamSecret, streamScopeStream, time.Now())
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("127.0.0.1:55555", "?t="+tok))
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Errorf("loopback request with valid token: status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamHandler_EnforcementOff_NoToken_200(t *testing.T) {
|
||||||
|
srv := newServedServer(t)
|
||||||
|
srv.SetRequireStreamToken(false)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.handler(rec, streamReq("198.51.100.7:40000", ""))
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Errorf("enforcement off: status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /hls handler enforcement ------------------------------------------------
|
||||||
|
|
||||||
|
func TestHLSHandler_RemoteBadToken_404(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
// A syntactically valid session id (UUID-ish) with a bogus token segment.
|
||||||
|
const sess = "11111111-1111-4111-8111-111111111111"
|
||||||
|
r := httptest.NewRequest(http.MethodGet, "http://stream.test/hls/"+sess+"/badtoken/master.m3u8", nil)
|
||||||
|
r.RemoteAddr = "198.51.100.7:40000"
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.hlsHandler(rec, r)
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("remote hls with bad token: status = %d, want 404", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHLSBaseURLs_CarryTokenSegment(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
srv.urls.LAN = "http://192.168.1.2:11818/stream"
|
||||||
|
const sess = "22222222-2222-4222-8222-222222222222"
|
||||||
|
urls := srv.hlsBaseURLs(sess)
|
||||||
|
prefix := "http://192.168.1.2:11818/hls/" + sess + "/"
|
||||||
|
if !strings.HasPrefix(urls.LAN, prefix) || len(urls.LAN) <= len(prefix) {
|
||||||
|
t.Errorf("hls LAN url = %q, want token segment after %q", urls.LAN, prefix)
|
||||||
|
}
|
||||||
|
// The trailing segment must be a verifiable hls-scoped token.
|
||||||
|
tok := strings.TrimPrefix(urls.LAN, prefix)
|
||||||
|
if !verifyStreamToken(srv.streamSecret, streamScopeHLS(sess), tok, time.Now()) {
|
||||||
|
t.Errorf("token segment %q does not verify for session %s", tok, sess)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -78,6 +78,12 @@ type Task struct {
|
||||||
ClaimedAt time.Time
|
ClaimedAt time.Time
|
||||||
StartedAt time.Time
|
StartedAt time.Time
|
||||||
CompletedAt time.Time
|
CompletedAt time.Time
|
||||||
|
|
||||||
|
// onChange, when set, is called after every successful status Transition so
|
||||||
|
// the daemon can push the new state to the server immediately (event-driven
|
||||||
|
// uplink) instead of waiting for the next sync tick. Must be non-blocking —
|
||||||
|
// it's a coalescing TriggerSync. Set by the Manager at submit time.
|
||||||
|
onChange func()
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTaskFromAgent creates a Task from a server-claimed agent.Task.
|
// NewTaskFromAgent creates a Task from a server-claimed agent.Task.
|
||||||
|
|
@ -111,13 +117,15 @@ func NewTaskFromAgent(at agent.Task) *Task {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Transition validates and performs a state transition.
|
// Transition validates and performs a state transition. On success it invokes
|
||||||
|
// the onChange hook (outside the lock) so the daemon can push the new state to
|
||||||
|
// the server immediately rather than waiting for the next sync tick.
|
||||||
func (t *Task) Transition(to TaskStatus) error {
|
func (t *Task) Transition(to TaskStatus) error {
|
||||||
t.mu.Lock()
|
t.mu.Lock()
|
||||||
defer t.mu.Unlock()
|
|
||||||
|
|
||||||
allowed, ok := validTransitions[t.Status]
|
allowed, ok := validTransitions[t.Status]
|
||||||
if !ok {
|
if !ok {
|
||||||
|
t.mu.Unlock()
|
||||||
return fmt.Errorf("no transitions from %s", t.Status)
|
return fmt.Errorf("no transitions from %s", t.Status)
|
||||||
}
|
}
|
||||||
for _, a := range allowed {
|
for _, a := range allowed {
|
||||||
|
|
@ -129,12 +137,28 @@ func (t *Task) Transition(to TaskStatus) error {
|
||||||
if to == StatusCompleted || to == StatusFailed {
|
if to == StatusCompleted || to == StatusFailed {
|
||||||
t.CompletedAt = time.Now()
|
t.CompletedAt = time.Now()
|
||||||
}
|
}
|
||||||
|
cb := t.onChange
|
||||||
|
t.mu.Unlock()
|
||||||
|
// Fire the event-driven uplink AFTER releasing the lock so a future
|
||||||
|
// heavier hook can't deadlock on the task mutex.
|
||||||
|
if cb != nil {
|
||||||
|
cb()
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
t.mu.Unlock()
|
||||||
return fmt.Errorf("invalid transition: %s -> %s", t.Status, to)
|
return fmt.Errorf("invalid transition: %s -> %s", t.Status, to)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetOnChange wires the post-transition hook. Call before the task starts
|
||||||
|
// transitioning (the Manager sets it at submit time).
|
||||||
|
func (t *Task) SetOnChange(fn func()) {
|
||||||
|
t.mu.Lock()
|
||||||
|
t.onChange = fn
|
||||||
|
t.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
// GetStatus returns current status thread-safely.
|
// GetStatus returns current status thread-safely.
|
||||||
func (t *Task) GetStatus() TaskStatus {
|
func (t *Task) GetStatus() TaskStatus {
|
||||||
t.mu.RLock()
|
t.mu.RLock()
|
||||||
|
|
|
||||||
|
|
@ -216,3 +216,41 @@ func TestHasUntried(t *testing.T) {
|
||||||
t.Error("all methods tried")
|
t.Error("all methods tried")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTransitionFiresOnChange(t *testing.T) {
|
||||||
|
task := NewTaskFromAgent(agent.Task{ID: "t1"}) // StatusClaimed
|
||||||
|
|
||||||
|
var fired int
|
||||||
|
task.SetOnChange(func() { fired++ })
|
||||||
|
|
||||||
|
// Valid transition fires the hook.
|
||||||
|
if err := task.Transition(StatusResolving); err != nil {
|
||||||
|
t.Fatalf("Transition: %v", err)
|
||||||
|
}
|
||||||
|
if fired != 1 {
|
||||||
|
t.Errorf("onChange fired %d times, want 1 after a valid transition", fired)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Another valid transition fires again (event-driven, every transition).
|
||||||
|
if err := task.Transition(StatusDownloading); err != nil {
|
||||||
|
t.Fatalf("Transition: %v", err)
|
||||||
|
}
|
||||||
|
if fired != 2 {
|
||||||
|
t.Errorf("onChange fired %d times, want 2", fired)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invalid transition must NOT fire the hook.
|
||||||
|
if err := task.Transition(StatusClaimed); err == nil {
|
||||||
|
t.Error("expected error on invalid transition downloading→claimed")
|
||||||
|
}
|
||||||
|
if fired != 2 {
|
||||||
|
t.Errorf("onChange fired %d times, want still 2 (no fire on invalid transition)", fired)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransitionNilOnChangeNoPanic(t *testing.T) {
|
||||||
|
task := NewTaskFromAgent(agent.Task{ID: "t2"}) // no onChange set
|
||||||
|
if err := task.Transition(StatusResolving); err != nil {
|
||||||
|
t.Fatalf("Transition with nil onChange must not error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
199
internal/engine/thumbnail_test.go
Normal file
199
internal/engine/thumbnail_test.go
Normal file
|
|
@ -0,0 +1,199 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func thumbReq(remoteAddr, query string) *http.Request {
|
||||||
|
r := httptest.NewRequest(http.MethodGet, "http://stream.test/thumbnail"+query, nil)
|
||||||
|
r.RemoteAddr = remoteAddr
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func indexOfArg(ss []string, target string) int {
|
||||||
|
for i, s := range ss {
|
||||||
|
if s == target {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestStreamScopeThumb_Vector pins the scope string against the web's
|
||||||
|
// TypeScript minter (tests/unit/stream-token.test.ts asserts the same vector).
|
||||||
|
// A token the web mints for a file MUST reduce to the same scope here or the
|
||||||
|
// thumbnail 404s.
|
||||||
|
func TestStreamScopeThumb_Vector(t *testing.T) {
|
||||||
|
got := streamScopeThumb("/movies/Example (2020)/Example.mkv")
|
||||||
|
const want = "thumb:d3f919154ea48832a0b52e4b4ca3e81185ea5f4e2b9e5fece32c6651908cbdd8"
|
||||||
|
if got != want {
|
||||||
|
t.Fatalf("streamScopeThumb mismatch (web parity broken!): got %q want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStreamScopeThumb_DistinctPerPath(t *testing.T) {
|
||||||
|
a := streamScopeThumb("/a.mkv")
|
||||||
|
b := streamScopeThumb("/b.mkv")
|
||||||
|
if a == b {
|
||||||
|
t.Error("distinct paths produced the same thumb scope")
|
||||||
|
}
|
||||||
|
if streamScopeThumb("/a.mkv") != a {
|
||||||
|
t.Error("same path produced a different thumb scope (not deterministic)")
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(a, "thumb:") || len(a) != len("thumb:")+64 {
|
||||||
|
t.Errorf("scope %q is not thumb:<64 hex>", a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildThumbnailArgs(t *testing.T) {
|
||||||
|
args := buildThumbnailArgs("/x/movie.mkv", 123.5, 320)
|
||||||
|
joined := strings.Join(args, " ")
|
||||||
|
|
||||||
|
ssIdx, iIdx := indexOfArg(args, "-ss"), indexOfArg(args, "-i")
|
||||||
|
if ssIdx < 0 || iIdx < 0 || ssIdx > iIdx {
|
||||||
|
t.Errorf("-ss must precede -i (fast input seek): %v", args)
|
||||||
|
}
|
||||||
|
if args[ssIdx+1] != "123.500" {
|
||||||
|
t.Errorf("pos arg = %q, want 123.500", args[ssIdx+1])
|
||||||
|
}
|
||||||
|
if args[iIdx+1] != "/x/movie.mkv" {
|
||||||
|
t.Errorf("input arg = %q, want the path", args[iIdx+1])
|
||||||
|
}
|
||||||
|
for _, want := range []string{"-frames:v 1", "scale=320:-2", "-f mjpeg", "pipe:1", "-an", "-sn"} {
|
||||||
|
if !strings.Contains(joined, want) {
|
||||||
|
t.Errorf("args missing %q: %v", want, args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildThumbnailArgsAccurate is the robust fallback used when the fast input
|
||||||
|
// seek fails on a file with a corrupt/imprecise seek index (2026-06-03
|
||||||
|
// broken-thumbnail bug on anime MKVs). It must use OUTPUT seek (-ss AFTER -i)
|
||||||
|
// so it decodes from the start, plus -err_detect ignore_err to tolerate minor
|
||||||
|
// stream corruption — the opposite of the fast buildThumbnailArgs.
|
||||||
|
func TestBuildThumbnailArgsAccurate(t *testing.T) {
|
||||||
|
args := buildThumbnailArgsAccurate("/x/movie.mkv", 123.5, 320)
|
||||||
|
joined := strings.Join(args, " ")
|
||||||
|
|
||||||
|
ssIdx, iIdx := indexOfArg(args, "-ss"), indexOfArg(args, "-i")
|
||||||
|
if ssIdx < 0 || iIdx < 0 || ssIdx <= iIdx {
|
||||||
|
t.Errorf("-ss must come AFTER -i (output seek, robust fallback): %v", args)
|
||||||
|
}
|
||||||
|
if !strings.Contains(joined, "-err_detect ignore_err") {
|
||||||
|
t.Errorf("accurate args must tolerate stream errors (-err_detect ignore_err): %v", args)
|
||||||
|
}
|
||||||
|
if args[ssIdx+1] != "123.500" {
|
||||||
|
t.Errorf("pos arg = %q, want 123.500", args[ssIdx+1])
|
||||||
|
}
|
||||||
|
if args[iIdx+1] != "/x/movie.mkv" {
|
||||||
|
t.Errorf("input arg = %q, want the path", args[iIdx+1])
|
||||||
|
}
|
||||||
|
for _, want := range []string{"-frames:v 1", "scale=320:-2", "-f mjpeg", "pipe:1", "-an", "-sn"} {
|
||||||
|
if !strings.Contains(joined, want) {
|
||||||
|
t.Errorf("args missing %q: %v", want, args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseThumbPos(t *testing.T) {
|
||||||
|
cases := map[string]float64{"": 0, "abc": 0, "-5": 0, "0": 0, "12.5": 12.5, "600": 600}
|
||||||
|
for in, want := range cases {
|
||||||
|
if got := parseThumbPos(in); got != want {
|
||||||
|
t.Errorf("parseThumbPos(%q) = %v, want %v", in, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseThumbWidth(t *testing.T) {
|
||||||
|
cases := map[string]int{"": 320, "abc": 320, "10": 80, "5000": 640, "200": 200, "640": 640, "80": 80}
|
||||||
|
for in, want := range cases {
|
||||||
|
if got := parseThumbWidth(in); got != want {
|
||||||
|
t.Errorf("parseThumbWidth(%q) = %v, want %v", in, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThumbnailHandler_MissingPath_400(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.thumbnailHandler(rec, thumbReq("198.51.100.7:40000", ""))
|
||||||
|
if rec.Code != http.StatusBadRequest {
|
||||||
|
t.Errorf("missing path: status = %d, want 400", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThumbnailHandler_BadToken_404(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
// Path present (so we pass the 400 gate) but a bogus token → 404, no oracle.
|
||||||
|
srv.thumbnailHandler(rec, thumbReq("198.51.100.7:40000", "?p="+url.QueryEscape("/tmp/x.mkv")+"&t=deadbeef.0000"))
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("bad token: status = %d, want 404", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThumbnailHandler_ValidToken_NonexistentFile_404(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
path := "/nonexistent/never-here.mkv"
|
||||||
|
tok := mintStreamToken(srv.streamSecret, streamScopeThumb(path), time.Now())
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.thumbnailHandler(rec, thumbReq("198.51.100.7:40000", "?p="+url.QueryEscape(path)+"&t="+tok))
|
||||||
|
if rec.Code != http.StatusNotFound {
|
||||||
|
t.Errorf("valid token but missing file: status = %d, want 404 (regular-file clamp)", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThumbnailHandler_NoFFmpeg_503(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0) // ffmpegPath left empty
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("not really a video"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
tok := mintStreamToken(srv.streamSecret, streamScopeThumb(path), time.Now())
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.thumbnailHandler(rec, thumbReq("198.51.100.7:40000", "?p="+url.QueryEscape(path)+"&t="+tok))
|
||||||
|
if rec.Code != http.StatusServiceUnavailable {
|
||||||
|
t.Errorf("no ffmpeg configured: status = %d, want 503", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestThumbnailHandler_Success exercises the full success branch with a stub
|
||||||
|
// "ffmpeg" that writes JPEG magic bytes to stdout — no real ffmpeg/video
|
||||||
|
// needed. Validates 200 + image/jpeg + the body is passed through verbatim.
|
||||||
|
func TestThumbnailHandler_Success(t *testing.T) {
|
||||||
|
srv := NewStreamServer(0)
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(path, []byte("x"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
stub := filepath.Join(dir, "ffmpeg.sh")
|
||||||
|
// JPEG SOI marker (FF D8 FF) + filler, regardless of args.
|
||||||
|
if err := os.WriteFile(stub, []byte("#!/bin/sh\nprintf '\\377\\330\\377stub'\n"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
srv.SetFFmpegPath(stub)
|
||||||
|
|
||||||
|
tok := mintStreamToken(srv.streamSecret, streamScopeThumb(path), time.Now())
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.thumbnailHandler(rec, thumbReq("198.51.100.7:40000",
|
||||||
|
"?p="+url.QueryEscape(path)+"&t="+tok+"&pos=10&w=200"))
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("stub ffmpeg: status = %d, want 200 (body=%q)", rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
if ct := rec.Header().Get("Content-Type"); ct != "image/jpeg" {
|
||||||
|
t.Errorf("Content-Type = %q, want image/jpeg", ct)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(rec.Body.String(), "\xff\xd8\xff") {
|
||||||
|
t.Errorf("body missing JPEG magic bytes: %q", rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
160
internal/engine/tonemap.go
Normal file
160
internal/engine/tonemap.go
Normal file
|
|
@ -0,0 +1,160 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hdrTonemapChain is the ffmpeg filter segment that maps an HDR source
|
||||||
|
// (HDR10/HLG, or a Dolby Vision base layer) down to SDR BT.709: linearise the
|
||||||
|
// PQ/HLG signal, tonemap the highlights (hable), then re-encode to BT.709
|
||||||
|
// transfer/matrix/primaries in limited range. Without it an HDR source
|
||||||
|
// transcoded to an SDR encode keeps wide-gamut/PQ data the SDR player can't
|
||||||
|
// interpret, so colour looks washed-out / desaturated.
|
||||||
|
//
|
||||||
|
// Requires the zscale filter (libzimg) in the ffmpeg build — gate on
|
||||||
|
// FFmpegSupportsZscale. Trailing comma so it slots in front of the chain's
|
||||||
|
// `format=` stage. CPU filter: valid for every encoder here because the decode
|
||||||
|
// hwaccel intentionally leaves frames in system memory (see buildHLSFFmpegArgsAt).
|
||||||
|
//
|
||||||
|
// Tuned for HDR10/PQ (npl=100) and the common DV+HDR10 case. HLG and bare-DV
|
||||||
|
// (Profile 5, no PQ signalling) get an approximate mapping — zscale linearises
|
||||||
|
// from whatever transfer the stream declares — but the result is still clearly
|
||||||
|
// better than the untonemapped washed-out baseline. A per-transfer chain is a
|
||||||
|
// possible follow-up if HLG/DV-only sources become common.
|
||||||
|
const hdrTonemapChain = "zscale=t=linear:npl=100,format=gbrpf32le,zscale=p=bt709,tonemap=tonemap=hable:desat=0,zscale=t=bt709:m=bt709:r=tv,"
|
||||||
|
|
||||||
|
// libplaceboTonemapFilter maps an HDR source to SDR BT.709 in a SINGLE GPU pass
|
||||||
|
// (Vulkan): tone-map the HDR curve, convert primaries/transfer/matrix to BT.709
|
||||||
|
// limited range, and output 8-bit yuv420p — so it REPLACES the zscale chain AND
|
||||||
|
// the trailing `format=yuv420p,setparams=bt709` (it does both). Higher quality
|
||||||
|
// and far cheaper than the CPU zscale chain, and the agent's ffmpeg has it where
|
||||||
|
// zscale is missing. It does NOT scale here — the CPU scale chain runs first
|
||||||
|
// (it owns the even-dimension rounding libx264/nvenc require). No trailing comma:
|
||||||
|
// it's the last filter in the chain.
|
||||||
|
const libplaceboTonemapFilter = "libplacebo=colorspace=bt709:color_primaries=bt709:color_trc=bt709:range=tv:format=yuv420p:tonemapping=bt.2390"
|
||||||
|
|
||||||
|
var (
|
||||||
|
zscaleCacheMu sync.Mutex
|
||||||
|
zscaleCache = map[string]bool{}
|
||||||
|
|
||||||
|
libplaceboCacheMu sync.Mutex
|
||||||
|
libplaceboCache = map[string]bool{}
|
||||||
|
)
|
||||||
|
|
||||||
|
// FFmpegSupportsLibplacebo reports whether this host can ACTUALLY run the
|
||||||
|
// libplacebo filter — not merely whether it is compiled in. libplacebo is a
|
||||||
|
// Vulkan filter, so it needs a working Vulkan device + ICD at runtime, which a
|
||||||
|
// presence check (`ffmpeg -filters`) does NOT prove: the prod agent image
|
||||||
|
// ships a BtbN GPL ffmpeg with libplacebo built in but no Vulkan runtime
|
||||||
|
// (debian-slim, no libvulkan1 / mesa-vulkan-drivers / nvidia ICD), so a
|
||||||
|
// presence check would flip this on and break HDR playback that previously
|
||||||
|
// tonemapped fine via zscale.
|
||||||
|
//
|
||||||
|
// So we run the real filter on one synthetic frame and require a clean exit:
|
||||||
|
// that forces Vulkan device creation + filtergraph negotiation (libplacebo
|
||||||
|
// auto-inserts the hwupload/hwdownload around itself). Pass → libplacebo works
|
||||||
|
// here; fail → fall back to the zscale chain. Cached per path — EXCEPT a
|
||||||
|
// context timeout, which is transient (a busy box during the startup warm) and
|
||||||
|
// must not pin HDR to zscale for the whole process. The probe is bounded so a
|
||||||
|
// wedged ffmpeg can't stall the first session.
|
||||||
|
func FFmpegSupportsLibplacebo(ffmpegPath string) bool {
|
||||||
|
if ffmpegPath == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
libplaceboCacheMu.Lock()
|
||||||
|
if v, ok := libplaceboCache[ffmpegPath]; ok {
|
||||||
|
libplaceboCacheMu.Unlock()
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
libplaceboCacheMu.Unlock()
|
||||||
|
|
||||||
|
// 10 s: first-run Vulkan device creation alone can take ~1 s ("Spent
|
||||||
|
// ~1150ms creating vulkan device"), plus codec/filter init.
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
// Run the EXACT filter we'd use, on a 1-frame synthetic source, discarding
|
||||||
|
// output. testsrc2 is SDR so the tonemap is near-passthrough — the point is
|
||||||
|
// to exercise Vulkan device init + the filter, not the mapping quality.
|
||||||
|
out, err := exec.CommandContext(ctx, ffmpegPath,
|
||||||
|
"-hide_banner", "-loglevel", "error", "-nostats",
|
||||||
|
"-f", "lavfi", "-i", "testsrc2=size=128x128:rate=1:duration=1",
|
||||||
|
"-vf", libplaceboTonemapFilter, "-frames:v", "1", "-f", "null", "-",
|
||||||
|
).CombinedOutput()
|
||||||
|
supported := err == nil
|
||||||
|
|
||||||
|
// Cache the result — but NOT a timeout. A clean non-zero exit (filter
|
||||||
|
// absent, no Vulkan ICD) is a stable "no" worth remembering; a deadline is
|
||||||
|
// transient (the box was busy, e.g. the startup warm racing the encode
|
||||||
|
// benchmark) and caching it would force HDR onto the zscale CPU chain until
|
||||||
|
// restart. Worst case a perpetually-loaded box re-probes per session — rare,
|
||||||
|
// and it fails closed to zscale each time.
|
||||||
|
if supported || ctx.Err() != context.DeadlineExceeded {
|
||||||
|
libplaceboCacheMu.Lock()
|
||||||
|
libplaceboCache[ffmpegPath] = supported
|
||||||
|
libplaceboCacheMu.Unlock()
|
||||||
|
}
|
||||||
|
if supported {
|
||||||
|
log.Printf("[tonemap] ffmpeg libplacebo works (Vulkan OK) — HDR sources tonemapped on the GPU (preferred)")
|
||||||
|
} else {
|
||||||
|
// On an exec/timeout failure the stderr tail is empty — surface err
|
||||||
|
// itself so the log distinguishes "no Vulkan" from "ffmpeg never ran".
|
||||||
|
detail := strings.TrimSpace(lastLine(out))
|
||||||
|
if detail == "" {
|
||||||
|
detail = err.Error()
|
||||||
|
}
|
||||||
|
log.Printf("[tonemap] ffmpeg libplacebo unavailable (no Vulkan runtime or filter absent) — HDR falls back to zscale/none: %v", detail)
|
||||||
|
}
|
||||||
|
return supported
|
||||||
|
}
|
||||||
|
|
||||||
|
// lastLine returns the last non-empty line of ffmpeg output — the actual error
|
||||||
|
// (e.g. "No VK_ICD..." / "Device creation failed") rather than the whole log.
|
||||||
|
func lastLine(b []byte) string {
|
||||||
|
lines := strings.Split(strings.TrimRight(string(b), "\n"), "\n")
|
||||||
|
for i := len(lines) - 1; i >= 0; i-- {
|
||||||
|
if strings.TrimSpace(lines[i]) != "" {
|
||||||
|
return lines[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// FFmpegSupportsZscale reports whether the ffmpeg binary at path was built with
|
||||||
|
// the zscale filter (libzimg), required for HDR→SDR tonemapping. Cached per
|
||||||
|
// path. A detection failure (binary missing, exec error) is treated as "no" so
|
||||||
|
// tonemapping is simply skipped — the source still plays, just without it.
|
||||||
|
func FFmpegSupportsZscale(ffmpegPath string) bool {
|
||||||
|
if ffmpegPath == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
zscaleCacheMu.Lock()
|
||||||
|
if v, ok := zscaleCache[ffmpegPath]; ok {
|
||||||
|
zscaleCacheMu.Unlock()
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
zscaleCacheMu.Unlock()
|
||||||
|
|
||||||
|
// Probe OUTSIDE the lock: `ffmpeg -filters` can take a beat, and holding the
|
||||||
|
// mutex across it would stall a concurrent session start. Worst case two
|
||||||
|
// cold callers probe the same binary at once — both write the same bool.
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
out, err := exec.CommandContext(ctx, ffmpegPath, "-hide_banner", "-filters").Output()
|
||||||
|
supported := err == nil && bytes.Contains(out, []byte("zscale"))
|
||||||
|
|
||||||
|
zscaleCacheMu.Lock()
|
||||||
|
zscaleCache[ffmpegPath] = supported
|
||||||
|
zscaleCacheMu.Unlock()
|
||||||
|
if supported {
|
||||||
|
log.Printf("[tonemap] ffmpeg has zscale — HDR sources will be tonemapped to SDR")
|
||||||
|
} else {
|
||||||
|
log.Printf("[tonemap] ffmpeg %q lacks zscale — HDR sources play without tonemapping (desaturated)", ffmpegPath)
|
||||||
|
}
|
||||||
|
return supported
|
||||||
|
}
|
||||||
176
internal/engine/tonemap_test.go
Normal file
176
internal/engine/tonemap_test.go
Normal file
|
|
@ -0,0 +1,176 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func hlsArgsFor(hdr string, tonemap bool, hw HWAccel) string {
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/movies/x.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: hw,
|
||||||
|
TonemapHDR: tonemap,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 3840, Height: 2160, BitDepth: 10, HDR: hdr, DurationSec: 100}
|
||||||
|
return strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/t", 0, 0), " ")
|
||||||
|
}
|
||||||
|
|
||||||
|
func vfChain(joined string) string {
|
||||||
|
parts := strings.Split(joined, " ")
|
||||||
|
for i, p := range parts {
|
||||||
|
if p == "-vf" && i+1 < len(parts) {
|
||||||
|
return parts[i+1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_AppliedForHDRWhenSupported(t *testing.T) {
|
||||||
|
vf := vfChain(hlsArgsFor("HDR10", true, HWAccelNone))
|
||||||
|
if !strings.Contains(vf, "zscale=t=linear") || !strings.Contains(vf, "tonemap=tonemap=hable") {
|
||||||
|
t.Fatalf("HDR + zscale-capable: expected tonemap in -vf, got %q", vf)
|
||||||
|
}
|
||||||
|
// Order: a scale filter, then tonemap (zscale), then format=.
|
||||||
|
scaleIdx := strings.Index(vf, "scale=")
|
||||||
|
zIdx := strings.Index(vf, "zscale=t=linear")
|
||||||
|
fmtIdx := strings.Index(vf, "format=")
|
||||||
|
if !(scaleIdx >= 0 && scaleIdx < zIdx && zIdx < fmtIdx) {
|
||||||
|
t.Errorf("filter order wrong (scale < tonemap < format): %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_AppliedInNoDownscaleBranch(t *testing.T) {
|
||||||
|
// Source already within the quality cap → no downscale; tonemap must still
|
||||||
|
// be inserted before format=.
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/movies/x.mkv",
|
||||||
|
Quality: "2160p",
|
||||||
|
Transcode: TranscodeRuntime{FFmpegPath: "/usr/bin/ffmpeg", HWAccel: HWAccelNone, TonemapHDR: true},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 3840, Height: 2160, HDR: "HDR10", DurationSec: 100}
|
||||||
|
vf := vfChain(strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/t", 0, 0), " "))
|
||||||
|
if !strings.Contains(vf, "tonemap=tonemap=hable") {
|
||||||
|
t.Errorf("no-downscale branch: expected tonemap, got %q", vf)
|
||||||
|
}
|
||||||
|
if z, f := strings.Index(vf, "zscale=t=linear"), strings.Index(vf, "format="); !(z >= 0 && z < f) {
|
||||||
|
t.Errorf("tonemap must precede format=: %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_LibplaceboPreferredOverZscale(t *testing.T) {
|
||||||
|
// HDR source + an ffmpeg with libplacebo on a REAL HW encoder (NVENC) → the
|
||||||
|
// single GPU filter replaces the whole CPU zscale chain (and the trailing
|
||||||
|
// format=/setparams it folds in). NVENC (not None) because libplacebo is
|
||||||
|
// gated on a real GPU — a software encoder stays on zscale.
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/movies/x.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{FFmpegPath: "/usr/bin/ffmpeg", HWAccel: HWAccelNVENC, TonemapHDR: true, HasLibplacebo: true},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 3840, Height: 2160, BitDepth: 10, HDR: "HDR10", DurationSec: 100}
|
||||||
|
vf := vfChain(strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/t", 0, 0), " "))
|
||||||
|
if !strings.Contains(vf, "libplacebo") {
|
||||||
|
t.Fatalf("libplacebo-capable ffmpeg: expected libplacebo filter, got %q", vf)
|
||||||
|
}
|
||||||
|
if strings.Contains(vf, "zscale=t=linear") || strings.Contains(vf, "tonemap=tonemap=hable") {
|
||||||
|
t.Errorf("libplacebo must replace the zscale chain, not run alongside it: %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_LibplaceboSkippedOnSoftwareEncoder(t *testing.T) {
|
||||||
|
// libplacebo present but no HW encoder (software libx264) → must NOT use
|
||||||
|
// libplacebo: a software host's only Vulkan would be lavapipe (CPU), slower
|
||||||
|
// than zscale. Falls back to the zscale chain.
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/movies/x.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
Transcode: TranscodeRuntime{FFmpegPath: "/usr/bin/ffmpeg", HWAccel: HWAccelNone, TonemapHDR: true, HasLibplacebo: true},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 3840, Height: 2160, BitDepth: 10, HDR: "HDR10", DurationSec: 100}
|
||||||
|
vf := vfChain(strings.Join(buildHLSFFmpegArgsAt(cfg, probe, "/tmp/t", 0, 0), " "))
|
||||||
|
if strings.Contains(vf, "libplacebo") {
|
||||||
|
t.Errorf("software encoder must not use libplacebo (lavapipe trap), got %q", vf)
|
||||||
|
}
|
||||||
|
if !strings.Contains(vf, "zscale=t=linear") {
|
||||||
|
t.Errorf("software encoder with HDR + zscale should fall back to the zscale chain, got %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_SkippedWhenFFmpegLacksZscale(t *testing.T) {
|
||||||
|
vf := vfChain(hlsArgsFor("HDR10", false, HWAccelNone))
|
||||||
|
if strings.Contains(vf, "zscale") || strings.Contains(vf, "tonemap") {
|
||||||
|
t.Errorf("ffmpeg without zscale: tonemap must be skipped, got %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_SkippedForSDR(t *testing.T) {
|
||||||
|
vf := vfChain(hlsArgsFor("", true, HWAccelNone))
|
||||||
|
if strings.Contains(vf, "zscale") || strings.Contains(vf, "tonemap") {
|
||||||
|
t.Errorf("SDR source: no tonemap expected, got %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTonemap_VAAPIInsertsBeforeHwupload(t *testing.T) {
|
||||||
|
vf := vfChain(hlsArgsFor("HDR10", true, HWAccelVAAPI))
|
||||||
|
if !strings.Contains(vf, "tonemap=tonemap=hable") {
|
||||||
|
t.Fatalf("VAAPI HDR: expected tonemap, got %q", vf)
|
||||||
|
}
|
||||||
|
// Tonemap is a CPU filter — must run before the GPU upload.
|
||||||
|
if up := strings.Index(vf, "hwupload"); up >= 0 {
|
||||||
|
if strings.Index(vf, "zscale=t=linear") > up {
|
||||||
|
t.Errorf("tonemap must precede hwupload: %q", vf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFFmpegSupportsLibplacebo_FunctionalProbe(t *testing.T) {
|
||||||
|
if FFmpegSupportsLibplacebo("") {
|
||||||
|
t.Error("empty path must be false")
|
||||||
|
}
|
||||||
|
// A bogus path can't run → false (no panic, no hang).
|
||||||
|
if FFmpegSupportsLibplacebo("/nonexistent/ffmpeg") {
|
||||||
|
t.Error("nonexistent ffmpeg must be false")
|
||||||
|
}
|
||||||
|
// With a real ffmpeg the result is environment-dependent (true only when a
|
||||||
|
// Vulkan runtime is present), so we only assert the probe completes and
|
||||||
|
// returns a bool — its whole purpose is to be honest about THIS host.
|
||||||
|
if _, err := exec.LookPath("ffmpeg"); err == nil {
|
||||||
|
_ = FFmpegSupportsLibplacebo("ffmpeg") // must not hang or panic
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFFmpegSupportsZscale_Stub(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
|
||||||
|
withZ := filepath.Join(dir, "ffmpeg-with.sh")
|
||||||
|
if err := os.WriteFile(withZ, []byte("#!/bin/sh\necho ' .SC zscale V->V'\n"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !FFmpegSupportsZscale(withZ) {
|
||||||
|
t.Error("expected true for an ffmpeg whose -filters lists zscale")
|
||||||
|
}
|
||||||
|
|
||||||
|
noZ := filepath.Join(dir, "ffmpeg-without.sh")
|
||||||
|
if err := os.WriteFile(noZ, []byte("#!/bin/sh\necho ' ... scale V->V'\n"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if FFmpegSupportsZscale(noZ) {
|
||||||
|
t.Error("expected false for an ffmpeg whose -filters omits zscale")
|
||||||
|
}
|
||||||
|
|
||||||
|
if FFmpegSupportsZscale("") {
|
||||||
|
t.Error("empty path must be false")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -16,6 +16,7 @@ import (
|
||||||
alog "github.com/anacrolix/log"
|
alog "github.com/anacrolix/log"
|
||||||
"github.com/anacrolix/torrent"
|
"github.com/anacrolix/torrent"
|
||||||
"github.com/anacrolix/torrent/storage"
|
"github.com/anacrolix/torrent/storage"
|
||||||
|
"github.com/torrentclaw/unarr/internal/agent"
|
||||||
"github.com/torrentclaw/unarr/internal/config"
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
"github.com/torrentclaw/unarr/internal/vpn"
|
"github.com/torrentclaw/unarr/internal/vpn"
|
||||||
"golang.org/x/term"
|
"golang.org/x/term"
|
||||||
|
|
@ -61,16 +62,21 @@ var defaultTrackers = []string{
|
||||||
|
|
||||||
// TorrentConfig holds settings for the BitTorrent downloader.
|
// TorrentConfig holds settings for the BitTorrent downloader.
|
||||||
type TorrentConfig struct {
|
type TorrentConfig struct {
|
||||||
DataDir string
|
DataDir string
|
||||||
MetadataTimeout time.Duration // how long to wait for torrent metadata (default 15m, 0 = unlimited)
|
// PieceCompletionDir, when non-empty, stores the piece-completion SQLite DB
|
||||||
StallTimeout time.Duration // no progress during download for this long = stall (default 10m)
|
// in this directory instead of DataDir. Use the agent's local state dir
|
||||||
MaxTimeout time.Duration // absolute maximum per torrent (default 0 = unlimited)
|
// (not the download dir) so the DB never lands on NFS/SMB volumes where
|
||||||
MaxDownloadRate int64 // bytes/s, 0 = unlimited
|
// SQLite locking times out.
|
||||||
MaxUploadRate int64 // bytes/s, 0 = unlimited
|
PieceCompletionDir string
|
||||||
ListenPort int // fixed port for incoming peers (default 42069, 0 = random)
|
MetadataTimeout time.Duration // how long to wait for torrent metadata (default 15m, 0 = unlimited)
|
||||||
SeedEnabled bool
|
StallTimeout time.Duration // no progress during download for this long = stall (default 10m)
|
||||||
SeedRatio float64 // target seed ratio (default 0, meaning seed until SeedTime)
|
MaxTimeout time.Duration // absolute maximum per torrent (default 0 = unlimited)
|
||||||
SeedTime time.Duration // min seed time after completion (default 0)
|
MaxDownloadRate int64 // bytes/s, 0 = unlimited
|
||||||
|
MaxUploadRate int64 // bytes/s, 0 = unlimited
|
||||||
|
ListenPort int // fixed port for incoming peers (default 42069, 0 = random)
|
||||||
|
SeedEnabled bool
|
||||||
|
SeedRatio float64 // target seed ratio (default 0, meaning seed until SeedTime)
|
||||||
|
SeedTime time.Duration // min seed time after completion (default 0)
|
||||||
|
|
||||||
// VPNTunnel, when set, split-tunnels the torrent client's peer + tracker
|
// VPNTunnel, when set, split-tunnels the torrent client's peer + tracker
|
||||||
// traffic through an in-process userspace WireGuard tunnel (managed-VPN
|
// traffic through an in-process userspace WireGuard tunnel (managed-VPN
|
||||||
|
|
@ -85,8 +91,24 @@ type TorrentDownloader struct {
|
||||||
|
|
||||||
activeMu sync.Mutex
|
activeMu sync.Mutex
|
||||||
active map[string]*torrent.Torrent // taskID -> torrent handle
|
active map[string]*torrent.Torrent // taskID -> torrent handle
|
||||||
|
|
||||||
|
// seedCtx scopes the background seeders. Cancelled at Shutdown so they stop
|
||||||
|
// uploading and exit; it must outlive any single download's task context
|
||||||
|
// (which is cancelled the moment Download returns and the queue slot frees).
|
||||||
|
seedCtx context.Context
|
||||||
|
seedCancel context.CancelFunc
|
||||||
|
// seedCheckInterval is how often the background seeder re-checks its stop
|
||||||
|
// condition. Defaults to defaultSeedCheckInterval; tests lower it.
|
||||||
|
seedCheckInterval time.Duration
|
||||||
|
|
||||||
|
minFreeBytes int64 // disk reserve for the pre-flight space check (0 = reserve disabled)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetMinFreeBytes sets the free-space reserve enforced before a download starts.
|
||||||
|
// Call once at construction; 0 disables the reserve (the size-vs-free check still
|
||||||
|
// runs). See CheckDiskSpace.
|
||||||
|
func (d *TorrentDownloader) SetMinFreeBytes(n int64) { d.minFreeBytes = n }
|
||||||
|
|
||||||
// NewTorrentDownloader creates a BitTorrent downloader with a long-lived client.
|
// NewTorrentDownloader creates a BitTorrent downloader with a long-lived client.
|
||||||
func NewTorrentDownloader(cfg TorrentConfig) (*TorrentDownloader, error) {
|
func NewTorrentDownloader(cfg TorrentConfig) (*TorrentDownloader, error) {
|
||||||
// MetadataTimeout: 0 = unlimited (wait forever like qBittorrent)
|
// MetadataTimeout: 0 = unlimited (wait forever like qBittorrent)
|
||||||
|
|
@ -113,7 +135,23 @@ func NewTorrentDownloader(cfg TorrentConfig) (*TorrentDownloader, error) {
|
||||||
// Storage: mmap instead of default file backend.
|
// Storage: mmap instead of default file backend.
|
||||||
// The library author notes file storage has "very high system overhead".
|
// The library author notes file storage has "very high system overhead".
|
||||||
// mmap improves I/O throughput and piece verification speed significantly.
|
// mmap improves I/O throughput and piece verification speed significantly.
|
||||||
tcfg.DefaultStorage = storage.NewMMap(cfg.DataDir)
|
//
|
||||||
|
// When PieceCompletionDir is set (daemon always passes the agent state dir),
|
||||||
|
// keep the piece-completion SQLite DB off the download dir so it never lands
|
||||||
|
// on NFS/SMB where SQLite's file locking times out and emits a warning.
|
||||||
|
if cfg.PieceCompletionDir != "" {
|
||||||
|
if mkErr := os.MkdirAll(cfg.PieceCompletionDir, 0o755); mkErr != nil {
|
||||||
|
log.Printf("[torrent] piece-completion dir create failed (%v), DB stays in download dir", mkErr)
|
||||||
|
tcfg.DefaultStorage = storage.NewMMap(cfg.DataDir)
|
||||||
|
} else if pc, pcErr := storage.NewDefaultPieceCompletionForDir(cfg.PieceCompletionDir); pcErr != nil {
|
||||||
|
log.Printf("[torrent] piece-completion db in %q failed (%v), falling back to download dir", cfg.PieceCompletionDir, pcErr)
|
||||||
|
tcfg.DefaultStorage = storage.NewMMap(cfg.DataDir)
|
||||||
|
} else {
|
||||||
|
tcfg.DefaultStorage = storage.NewMMapWithCompletion(cfg.DataDir, pc)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
tcfg.DefaultStorage = storage.NewMMap(cfg.DataDir)
|
||||||
|
}
|
||||||
|
|
||||||
// Fixed port for incoming peer connections (enables UPnP port mapping).
|
// Fixed port for incoming peer connections (enables UPnP port mapping).
|
||||||
// With ListenPort=0, only ~30% of peers can connect to us.
|
// With ListenPort=0, only ~30% of peers can connect to us.
|
||||||
|
|
@ -250,10 +288,14 @@ func NewTorrentDownloader(cfg TorrentConfig) (*TorrentDownloader, error) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
seedCtx, seedCancel := context.WithCancel(context.Background())
|
||||||
return &TorrentDownloader{
|
return &TorrentDownloader{
|
||||||
client: client,
|
client: client,
|
||||||
cfg: cfg,
|
cfg: cfg,
|
||||||
active: make(map[string]*torrent.Torrent),
|
active: make(map[string]*torrent.Torrent),
|
||||||
|
seedCtx: seedCtx,
|
||||||
|
seedCancel: seedCancel,
|
||||||
|
seedCheckInterval: defaultSeedCheckInterval,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -276,14 +318,11 @@ func (d *TorrentDownloader) Download(ctx context.Context, task *Task, outputDir
|
||||||
d.active[task.ID] = t
|
d.active[task.ID] = t
|
||||||
d.activeMu.Unlock()
|
d.activeMu.Unlock()
|
||||||
|
|
||||||
cleanup := func() {
|
// cleanup drops the torrent and stops tracking it. Used by every error path
|
||||||
d.activeMu.Lock()
|
// (metadata timeout, disk guard, poll failure) and by the non-seeding success
|
||||||
delete(d.active, task.ID)
|
// path — all of which must drop. The seeding success path deliberately does
|
||||||
d.activeMu.Unlock()
|
// NOT call cleanup (it hands off to seedAndDrop).
|
||||||
if !d.cfg.SeedEnabled {
|
cleanup := func() { d.dropTracked(task.ID, t) }
|
||||||
t.Drop()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 1. Wait for metadata (0 = unlimited, like qBittorrent)
|
// 1. Wait for metadata (0 = unlimited, like qBittorrent)
|
||||||
if d.cfg.MetadataTimeout > 0 {
|
if d.cfg.MetadataTimeout > 0 {
|
||||||
|
|
@ -319,6 +358,15 @@ func (d *TorrentDownloader) Download(ctx context.Context, task *Task, outputDir
|
||||||
|
|
||||||
log.Printf("[%s] downloading %s (%s)", task.ID[:8], fileName, formatBytes(totalBytes))
|
log.Printf("[%s] downloading %s (%s)", task.ID[:8], fileName, formatBytes(totalBytes))
|
||||||
|
|
||||||
|
// 2.5 Pre-flight disk-space guard — refuse before writing rather than fill
|
||||||
|
// the disk to 0 mid-download (corrupts the partial file). Torrents land in
|
||||||
|
// DataDir (not the manager's outputDir), so stat DataDir. Conservative: uses
|
||||||
|
// the full selected size without subtracting pieces a resume may already hold.
|
||||||
|
if err := CheckDiskSpace(d.cfg.DataDir, totalBytes, d.minFreeBytes); err != nil {
|
||||||
|
cleanup()
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
// 3. Poll progress with stall detection
|
// 3. Poll progress with stall detection
|
||||||
result, err := d.pollDownload(ctx, t, task, totalBytes, fileName, progressCh)
|
result, err := d.pollDownload(ctx, t, task, totalBytes, fileName, progressCh)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
@ -352,9 +400,21 @@ func (d *TorrentDownloader) Download(ctx context.Context, task *Task, outputDir
|
||||||
result.Method = MethodTorrent
|
result.Method = MethodTorrent
|
||||||
result.Size = totalBytes
|
result.Size = totalBytes
|
||||||
|
|
||||||
// If seeding enabled, keep alive (don't cleanup).
|
// anacrolix mmap storage (storage.NewMMap) creates completed files with mode
|
||||||
// The manager handles seeding lifecycle.
|
// 0000 — the running process keeps its own mmap handle so the download works,
|
||||||
if !d.cfg.SeedEnabled {
|
// but any fresh open (streaming, ffprobe/HLS, organize-then-reopen) hits
|
||||||
|
// "permission denied". Relax perms now, before organize moves the file, so the
|
||||||
|
// readable mode is preserved through the rename.
|
||||||
|
makeReadable(filePath)
|
||||||
|
|
||||||
|
// Seeding handoff: with seeding enabled, keep the torrent uploading in the
|
||||||
|
// background — seedAndDrop drops it once the ratio/time target is hit (or at
|
||||||
|
// shutdown). Otherwise drop now. seedAndDrop must NOT use ctx: the task
|
||||||
|
// context is cancelled the moment Download returns and the manager frees the
|
||||||
|
// queue slot, which would kill the seeder instantly.
|
||||||
|
if d.cfg.SeedEnabled {
|
||||||
|
go d.seedAndDrop(task.ID, t, totalBytes)
|
||||||
|
} else {
|
||||||
cleanup()
|
cleanup()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -459,6 +519,163 @@ func (d *TorrentDownloader) pollDownload(ctx context.Context, t *torrent.Torrent
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// dropTracked stops tracking taskID and drops the torrent handle. The delete is
|
||||||
|
// guarded on the entry still being this handle, so a concurrent Pause/Cancel that
|
||||||
|
// already removed/replaced it isn't clobbered; t.Drop() is idempotent. Shared by
|
||||||
|
// the error/non-seeding cleanup path and the post-seeding drop.
|
||||||
|
func (d *TorrentDownloader) dropTracked(taskID string, t *torrent.Torrent) {
|
||||||
|
d.activeMu.Lock()
|
||||||
|
if cur, ok := d.active[taskID]; ok && cur == t {
|
||||||
|
delete(d.active, taskID)
|
||||||
|
}
|
||||||
|
d.activeMu.Unlock()
|
||||||
|
t.Drop()
|
||||||
|
}
|
||||||
|
|
||||||
|
// defaultSeedCheckInterval is how often the background seeder re-evaluates the
|
||||||
|
// ratio / time stop condition. Seeding is long-running and low-urgency, so a
|
||||||
|
// coarse interval keeps the overhead negligible. Stored on the downloader so
|
||||||
|
// tests can lower it.
|
||||||
|
const defaultSeedCheckInterval = 30 * time.Second
|
||||||
|
|
||||||
|
// seedTargetReached reports why seeding should stop, or "" to keep going.
|
||||||
|
// Ratio is uploaded-data / selected-size ("uploaded N× the content"), which is
|
||||||
|
// stable across resumes — unlike uploaded/downloaded-this-session. The two
|
||||||
|
// targets are independent: whichever of ratio (>0) or time (>0) fires first
|
||||||
|
// wins; with both unset nothing ever fires (the caller seeds indefinitely).
|
||||||
|
func seedTargetReached(ratioTarget float64, timeTarget time.Duration, uploaded, size int64, elapsed time.Duration) string {
|
||||||
|
var ratio float64
|
||||||
|
if size > 0 {
|
||||||
|
ratio = float64(uploaded) / float64(size)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case ratioTarget > 0 && ratio >= ratioTarget:
|
||||||
|
return fmt.Sprintf("ratio %.2f reached (target %.2f)", ratio, ratioTarget)
|
||||||
|
case timeTarget > 0 && elapsed >= timeTarget:
|
||||||
|
return fmt.Sprintf("seed time %s reached (target %s)", elapsed.Round(time.Second), timeTarget)
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedAndDrop keeps a completed torrent uploading until the configured ratio or
|
||||||
|
// time target is reached, then drops it (stops seeding, releases the handle and
|
||||||
|
// its queue tracking). Runs detached on d.seedCtx — see the Download call site
|
||||||
|
// for why it can't use the task context. With no ratio/time target it returns
|
||||||
|
// immediately and the torrent seeds until Shutdown (or a user cancel/pause drops
|
||||||
|
// it). It exits without dropping if the handle was already removed elsewhere, so
|
||||||
|
// it never reads stats off a closed torrent nor double-drops.
|
||||||
|
func (d *TorrentDownloader) seedAndDrop(taskID string, t *torrent.Torrent, totalBytes int64) {
|
||||||
|
sid := agent.ShortID(taskID)
|
||||||
|
|
||||||
|
ratioTarget := d.cfg.SeedRatio
|
||||||
|
timeTarget := d.cfg.SeedTime
|
||||||
|
if ratioTarget <= 0 && timeTarget <= 0 {
|
||||||
|
log.Printf("[%s] seeding indefinitely (no ratio/time target) — drops at shutdown", sid)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[%s] seeding (ratio target: %.2f, time target: %s)", sid, ratioTarget, timeTarget)
|
||||||
|
|
||||||
|
interval := d.seedCheckInterval
|
||||||
|
if interval <= 0 {
|
||||||
|
interval = defaultSeedCheckInterval
|
||||||
|
}
|
||||||
|
start := time.Now()
|
||||||
|
ticker := time.NewTicker(interval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-d.seedCtx.Done():
|
||||||
|
return // daemon shutting down — Shutdown drops the handle
|
||||||
|
case <-ticker.C:
|
||||||
|
// Bail if the handle was dropped elsewhere (user cancel/pause).
|
||||||
|
d.activeMu.Lock()
|
||||||
|
cur, ok := d.active[taskID]
|
||||||
|
d.activeMu.Unlock()
|
||||||
|
if !ok || cur != t {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
stats := t.Stats()
|
||||||
|
uploaded := stats.BytesWrittenData.Int64()
|
||||||
|
reason := seedTargetReached(ratioTarget, timeTarget, uploaded, totalBytes, time.Since(start))
|
||||||
|
if reason == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Printf("[%s] seeding complete: %s, uploaded %s — dropping", sid, reason, formatBytes(uploaded))
|
||||||
|
d.dropTracked(taskID, t)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// makeReadable relaxes permissions on a completed download so it can be
|
||||||
|
// re-opened by streaming/ffprobe/organize. anacrolix mmap storage creates
|
||||||
|
// files with mode 0000; we set files to 0644 and directories to 0755. Best
|
||||||
|
// effort + non-fatal — but a chmod that fails (typically NFS root_squash / SMB
|
||||||
|
// uid mapping) is surfaced with a clear, actionable WARNING instead of leaving
|
||||||
|
// the file 0000 to produce a cryptic "permission denied" later in the pipeline.
|
||||||
|
func makeReadable(path string) {
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[organize] makeReadable stat %q: %v", path, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !info.IsDir() {
|
||||||
|
if err := os.Chmod(path, 0o644); err != nil {
|
||||||
|
log.Printf("[organize] makeReadable chmod %q: %v", path, err)
|
||||||
|
}
|
||||||
|
// Verify the file is actually openable now — on NFS/SMB the chmod may
|
||||||
|
// "succeed" yet leave it unreadable to this uid. Catch it here with a
|
||||||
|
// pointed message rather than as an opaque error at stream/probe time.
|
||||||
|
warnIfUnreadable(path)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var chmodFails int
|
||||||
|
var firstFile string
|
||||||
|
err = filepath.WalkDir(path, func(p string, d os.DirEntry, walkErr error) error {
|
||||||
|
if walkErr != nil {
|
||||||
|
return nil // skip unreadable entries, keep going
|
||||||
|
}
|
||||||
|
mode := os.FileMode(0o644)
|
||||||
|
if d.IsDir() {
|
||||||
|
mode = 0o755
|
||||||
|
} else if firstFile == "" {
|
||||||
|
firstFile = p
|
||||||
|
}
|
||||||
|
if err := os.Chmod(p, mode); err != nil {
|
||||||
|
chmodFails++
|
||||||
|
log.Printf("[organize] makeReadable chmod %q: %v", p, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[organize] makeReadable walk %q: %v", path, err)
|
||||||
|
}
|
||||||
|
if chmodFails > 0 {
|
||||||
|
log.Printf("[organize] WARNING: %d file(s) under %q could not be made readable (chmod failed) — likely NFS root_squash or an SMB uid mapping. Streaming, ffprobe and organize will fail to open them. Run the agent as the user that owns the share, or mount it so that user can chmod.", chmodFails, path)
|
||||||
|
}
|
||||||
|
// Same silent-unreadable check the single-file path does: on NFS/SMB a chmod
|
||||||
|
// can "succeed" yet leave the file unopenable. Probe one representative file
|
||||||
|
// so the directory path catches that case too, not only outright chmod errors.
|
||||||
|
if firstFile != "" {
|
||||||
|
warnIfUnreadable(firstFile)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// warnIfUnreadable logs a clear, actionable warning when a file we just chmod'd
|
||||||
|
// still can't be opened for reading — the anacrolix-mmap-0000 + NFS/SMB failure
|
||||||
|
// mode. Best effort: it neither fails the download nor blocks delivery.
|
||||||
|
func warnIfUnreadable(path string) {
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[organize] WARNING: %q is not readable after chmod (%v) — likely NFS root_squash or an SMB uid mapping (anacrolix mmap creates files mode 0000). Streaming/ffprobe/organize will fail. Run the agent as the user that owns the share, or mount it so that user can chmod.", path, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_ = f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// Pause drops the torrent handle but keeps partial files on disk for resume.
|
// Pause drops the torrent handle but keeps partial files on disk for resume.
|
||||||
func (d *TorrentDownloader) Pause(taskID string) error {
|
func (d *TorrentDownloader) Pause(taskID string) error {
|
||||||
d.activeMu.Lock()
|
d.activeMu.Lock()
|
||||||
|
|
@ -509,6 +726,12 @@ func (d *TorrentDownloader) Cancel(taskID string) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (d *TorrentDownloader) Shutdown(ctx context.Context) error {
|
func (d *TorrentDownloader) Shutdown(ctx context.Context) error {
|
||||||
|
// Stop background seeders first so they don't read stats off / re-drop the
|
||||||
|
// handles we're about to close.
|
||||||
|
if d.seedCancel != nil {
|
||||||
|
d.seedCancel()
|
||||||
|
}
|
||||||
|
|
||||||
// Save DHT nodes in binary format for next session (warm start)
|
// Save DHT nodes in binary format for next session (warm start)
|
||||||
saveDhtNodesBinary(d.client)
|
saveDhtNodesBinary(d.client)
|
||||||
|
|
||||||
|
|
@ -563,7 +786,10 @@ func (d *TorrentDownloader) GetStreamProvider(taskID string) (FileProvider, erro
|
||||||
return nil, fmt.Errorf("torrent has no files")
|
return nil, fmt.Errorf("torrent has no files")
|
||||||
}
|
}
|
||||||
|
|
||||||
return NewTorrentFileProvider(video), nil
|
// The provider probes the bitrate asynchronously (to size the streaming
|
||||||
|
// readahead) — passing DataDir lets it locate the on-disk file without
|
||||||
|
// blocking stream start.
|
||||||
|
return NewTorrentFileProvider(video, d.cfg.DataDir), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// VideoExts is the canonical set of video file extensions used for file selection.
|
// VideoExts is the canonical set of video file extensions used for file selection.
|
||||||
|
|
@ -652,12 +878,15 @@ func formatBytes(b int64) string {
|
||||||
if b < unit {
|
if b < unit {
|
||||||
return fmt.Sprintf("%d B", b)
|
return fmt.Sprintf("%d B", b)
|
||||||
}
|
}
|
||||||
|
// Cap exp at the last unit so an exabyte-scale value (or a corrupt/huge
|
||||||
|
// size) can never index past the slice and panic.
|
||||||
|
units := []string{"KB", "MB", "GB", "TB", "PB", "EB"}
|
||||||
div, exp := int64(unit), 0
|
div, exp := int64(unit), 0
|
||||||
for n := b / unit; n >= unit; n /= unit {
|
for n := b / unit; n >= unit && exp < len(units)-1; n /= unit {
|
||||||
div *= unit
|
div *= unit
|
||||||
exp++
|
exp++
|
||||||
}
|
}
|
||||||
return fmt.Sprintf("%.1f %s", float64(b)/float64(div), []string{"KB", "MB", "GB", "TB"}[exp])
|
return fmt.Sprintf("%.1f %s", float64(b)/float64(div), units[exp])
|
||||||
}
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,59 @@ package engine
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// TestMakeReadable_FixesZeroMode verifies makeReadable turns an unreadable
|
||||||
|
// mode-0000 file (the anacrolix mmap default) into a readable 0644 one.
|
||||||
|
func TestMakeReadable_FixesZeroMode(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
p := filepath.Join(dir, "movie.mkv")
|
||||||
|
if err := os.WriteFile(p, []byte("x"), 0o000); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if f, err := os.Open(p); err == nil {
|
||||||
|
f.Close()
|
||||||
|
t.Skip("running as root — 0000 files are readable; can't exercise the fix")
|
||||||
|
}
|
||||||
|
makeReadable(p)
|
||||||
|
f, err := os.Open(p)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("file still unreadable after makeReadable: %v", err)
|
||||||
|
}
|
||||||
|
f.Close()
|
||||||
|
if fi, _ := os.Stat(p); fi.Mode().Perm() != 0o644 {
|
||||||
|
t.Errorf("mode = %o, want 0644", fi.Mode().Perm())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMakeReadable_DirWalk verifies the directory branch relaxes a 0000 file
|
||||||
|
// nested inside the download dir.
|
||||||
|
func TestMakeReadable_DirWalk(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
sub := filepath.Join(dir, "Release")
|
||||||
|
if err := os.MkdirAll(sub, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
p := filepath.Join(sub, "movie.mkv")
|
||||||
|
if err := os.WriteFile(p, []byte("x"), 0o000); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if f, err := os.Open(p); err == nil {
|
||||||
|
f.Close()
|
||||||
|
t.Skip("running as root — 0000 files are readable")
|
||||||
|
}
|
||||||
|
makeReadable(sub)
|
||||||
|
f, err := os.Open(p)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("nested file unreadable after makeReadable: %v", err)
|
||||||
|
}
|
||||||
|
f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// TestNewTorrentDownloader_ValidConfig verifica que se puede crear un downloader
|
// TestNewTorrentDownloader_ValidConfig verifica que se puede crear un downloader
|
||||||
// con una configuración válida sin errores.
|
// con una configuración válida sin errores.
|
||||||
func TestNewTorrentDownloader_ValidConfig(t *testing.T) {
|
func TestNewTorrentDownloader_ValidConfig(t *testing.T) {
|
||||||
|
|
@ -264,3 +313,114 @@ func TestTorrentDownloader_DownloadTimeout_MetadataCancel(t *testing.T) {
|
||||||
func TestTorrentDownloader_ImplementsInterface(t *testing.T) {
|
func TestTorrentDownloader_ImplementsInterface(t *testing.T) {
|
||||||
var _ Downloader = (*TorrentDownloader)(nil)
|
var _ Downloader = (*TorrentDownloader)(nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestSeedTargetReached cubre la lógica pura de parada del seeding: ratio,
|
||||||
|
// tiempo, ninguno, ambos (el primero que se cumple gana) y la guarda de tamaño
|
||||||
|
// cero (no debe dividir por cero ni parar por ratio).
|
||||||
|
func TestSeedTargetReached(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
ratioTarget float64
|
||||||
|
timeTarget time.Duration
|
||||||
|
uploaded int64
|
||||||
|
size int64
|
||||||
|
elapsed time.Duration
|
||||||
|
wantStop bool
|
||||||
|
}{
|
||||||
|
{"ratio reached", 2.0, 0, 200, 100, time.Minute, true},
|
||||||
|
{"ratio not reached", 2.0, 0, 150, 100, time.Minute, false},
|
||||||
|
{"ratio exactly met", 1.0, 0, 100, 100, time.Minute, true},
|
||||||
|
{"time reached", 0, time.Hour, 10, 100, 2 * time.Hour, true},
|
||||||
|
{"time not reached", 0, time.Hour, 10, 100, 30 * time.Minute, false},
|
||||||
|
{"no targets never stops", 0, 0, 9999, 100, 99 * time.Hour, false},
|
||||||
|
{"ratio wins when both set", 2.0, time.Hour, 200, 100, time.Second, true},
|
||||||
|
{"time wins when ratio short", 5.0, time.Hour, 100, 100, 2 * time.Hour, true},
|
||||||
|
{"zero size guards div", 2.0, 0, 200, 0, time.Minute, false},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
reason := seedTargetReached(tc.ratioTarget, tc.timeTarget, tc.uploaded, tc.size, tc.elapsed)
|
||||||
|
if got := reason != ""; got != tc.wantStop {
|
||||||
|
t.Errorf("seedTargetReached(ratio=%.1f time=%s up=%d size=%d el=%s) stop=%v (reason %q), want %v",
|
||||||
|
tc.ratioTarget, tc.timeTarget, tc.uploaded, tc.size, tc.elapsed, got, reason, tc.wantStop)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTorrentDownloader_SeedRatioTime verifica que SeedRatio y SeedTime se
|
||||||
|
// propagan a la config del downloader.
|
||||||
|
func TestTorrentDownloader_SeedRatioTime(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
dl, err := NewTorrentDownloader(TorrentConfig{
|
||||||
|
DataDir: dir,
|
||||||
|
SeedEnabled: true,
|
||||||
|
SeedRatio: 1.5,
|
||||||
|
SeedTime: 2 * time.Hour,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewTorrentDownloader: %v", err)
|
||||||
|
}
|
||||||
|
defer dl.Shutdown(context.Background())
|
||||||
|
|
||||||
|
if dl.cfg.SeedRatio != 1.5 {
|
||||||
|
t.Errorf("SeedRatio = %v, want 1.5", dl.cfg.SeedRatio)
|
||||||
|
}
|
||||||
|
if dl.cfg.SeedTime != 2*time.Hour {
|
||||||
|
t.Errorf("SeedTime = %v, want 2h", dl.cfg.SeedTime)
|
||||||
|
}
|
||||||
|
if dl.seedCtx == nil || dl.seedCancel == nil {
|
||||||
|
t.Error("seedCtx/seedCancel must be initialised by the constructor")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSeedAndDrop_NoTargetReturnsImmediately verifica que sin ratio ni tiempo
|
||||||
|
// objetivo, seedAndDrop retorna de inmediato (siembra indefinida) sin tocar el
|
||||||
|
// handle — por eso es seguro pasar un torrent nil.
|
||||||
|
func TestSeedAndDrop_NoTargetReturnsImmediately(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
dl, err := NewTorrentDownloader(TorrentConfig{DataDir: dir, SeedEnabled: true}) // ratio 0, time 0
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewTorrentDownloader: %v", err)
|
||||||
|
}
|
||||||
|
defer dl.Shutdown(context.Background())
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
dl.seedAndDrop("no-target-task-id", nil, 1000)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("seedAndDrop with no target should return immediately")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSeedAndDrop_StopsOnSeedCtxCancel verifica que seedAndDrop sale cuando se
|
||||||
|
// cancela seedCtx (ruta de Shutdown), incluso con un objetivo de ratio alto y el
|
||||||
|
// tick deshabilitado — el único camino de salida es seedCtx.Done().
|
||||||
|
func TestSeedAndDrop_StopsOnSeedCtxCancel(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
dl, err := NewTorrentDownloader(TorrentConfig{DataDir: dir, SeedEnabled: true, SeedRatio: 99})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewTorrentDownloader: %v", err)
|
||||||
|
}
|
||||||
|
defer dl.Shutdown(context.Background())
|
||||||
|
|
||||||
|
dl.seedCheckInterval = time.Hour // el ticker no disparará; solo seedCtx.Done() puede terminar
|
||||||
|
dl.seedCancel() // cancela antes de arrancar el monitor
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
dl.seedAndDrop("ctx-cancel-task-id", nil, 1000)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("seedAndDrop should return when seedCtx is cancelled")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,14 @@ type TranscodeRuntime struct {
|
||||||
// browser-friendly. Useful when the user explicitly turns transcoding
|
// browser-friendly. Useful when the user explicitly turns transcoding
|
||||||
// off in config.
|
// off in config.
|
||||||
Disabled bool
|
Disabled bool
|
||||||
|
// TonemapHDR enables HDR→SDR tonemapping of HDR sources during transcode.
|
||||||
|
// Set only when the ffmpeg build has zscale (FFmpegSupportsZscale); without
|
||||||
|
// it the tonemap filter would error and break playback, so it stays off.
|
||||||
|
TonemapHDR bool
|
||||||
|
// HasLibplacebo: the ffmpeg build has the libplacebo filter (GPU HDR tonemap).
|
||||||
|
// Preferred over the zscale chain for HDR sources — one GPU pass, higher
|
||||||
|
// quality, and present where zscale is missing.
|
||||||
|
HasLibplacebo bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// qualityCap maps a session's Quality label to a (MaxHeight, VideoBitrate)
|
// qualityCap maps a session's Quality label to a (MaxHeight, VideoBitrate)
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,11 @@ type TranscodeOpts struct {
|
||||||
SourceHeight int // probed source height — used to derive a sane H.264 level
|
SourceHeight int // probed source height — used to derive a sane H.264 level
|
||||||
StartSeconds float64
|
StartSeconds float64
|
||||||
FFmpegPath string
|
FFmpegPath string
|
||||||
|
// VideoTag forces the output stream's codec tag on a copy remux. HEVC muxed
|
||||||
|
// into MP4 must carry the `hvc1` tag (not the default `hev1`) or Safari /
|
||||||
|
// Apple devices refuse to decode it. Empty = leave ffmpeg's default. Only
|
||||||
|
// applied on copy actions (passthrough/remux); a real re-encode sets its own.
|
||||||
|
VideoTag string
|
||||||
}
|
}
|
||||||
|
|
||||||
// Transcoder wraps a long-running ffmpeg child process whose stdout streams
|
// Transcoder wraps a long-running ffmpeg child process whose stdout streams
|
||||||
|
|
@ -222,8 +227,16 @@ func buildFFmpegArgs(filePath string, opts TranscodeOpts) []string {
|
||||||
switch opts.Action {
|
switch opts.Action {
|
||||||
case ActionPassthrough, ActionRemux:
|
case ActionPassthrough, ActionRemux:
|
||||||
args = append(args, "-c:v", "copy", "-c:a", "copy")
|
args = append(args, "-c:v", "copy", "-c:a", "copy")
|
||||||
|
// HEVC → MP4 needs the hvc1 tag for Apple/Safari (hueco #3 / 3c).
|
||||||
|
if opts.VideoTag != "" {
|
||||||
|
args = append(args, "-tag:v", opts.VideoTag)
|
||||||
|
}
|
||||||
case ActionRemuxAudio:
|
case ActionRemuxAudio:
|
||||||
args = append(args, "-c:v", "copy", "-c:a", "aac", "-b:a", coalesce(opts.AudioBitrate, "192k"))
|
args = append(args, "-c:v", "copy")
|
||||||
|
if opts.VideoTag != "" {
|
||||||
|
args = append(args, "-tag:v", opts.VideoTag) // HEVC → hvc1 for Apple
|
||||||
|
}
|
||||||
|
args = append(args, "-c:a", "aac", "-b:a", coalesce(opts.AudioBitrate, "192k"))
|
||||||
case ActionTranscodeVideo:
|
case ActionTranscodeVideo:
|
||||||
videoCodec := opts.HWAccel.FFmpegVideoCodec("h264")
|
videoCodec := opts.HWAccel.FFmpegVideoCodec("h264")
|
||||||
args = append(args, "-c:v", videoCodec)
|
args = append(args, "-c:v", videoCodec)
|
||||||
|
|
|
||||||
|
|
@ -42,8 +42,15 @@ type UsenetDownloader struct {
|
||||||
// Cached NZB search results (from Available → Download)
|
// Cached NZB search results (from Available → Download)
|
||||||
nzbCache map[string]*agent.NzbSearchResult // taskID → best result
|
nzbCache map[string]*agent.NzbSearchResult // taskID → best result
|
||||||
nzbCacheMu sync.RWMutex
|
nzbCacheMu sync.RWMutex
|
||||||
|
|
||||||
|
minFreeBytes int64 // disk reserve for the pre-flight space check (0 = reserve disabled)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetMinFreeBytes sets the free-space reserve enforced before a download starts.
|
||||||
|
// Call once at construction; 0 disables the reserve (the size-vs-free check still
|
||||||
|
// runs). See CheckDiskSpace.
|
||||||
|
func (u *UsenetDownloader) SetMinFreeBytes(n int64) { u.minFreeBytes = n }
|
||||||
|
|
||||||
// NewUsenetDownloader creates a usenet downloader.
|
// NewUsenetDownloader creates a usenet downloader.
|
||||||
// apiClient is used to call the web API for NZB search, download, and credentials.
|
// apiClient is used to call the web API for NZB search, download, and credentials.
|
||||||
func NewUsenetDownloader(apiClient *agent.Client) *UsenetDownloader {
|
func NewUsenetDownloader(apiClient *agent.Client) *UsenetDownloader {
|
||||||
|
|
@ -171,6 +178,12 @@ func (u *UsenetDownloader) Download(ctx context.Context, task *Task, outputDir s
|
||||||
if resumed {
|
if resumed {
|
||||||
log.Printf("[%s] resuming usenet download (%d/%d segments completed)",
|
log.Printf("[%s] resuming usenet download (%d/%d segments completed)",
|
||||||
shortID, tracker.TotalCompleted(), totalSegs)
|
shortID, tracker.TotalCompleted(), totalSegs)
|
||||||
|
} else {
|
||||||
|
// Pre-flight disk-space guard on a fresh download (a resume already has
|
||||||
|
// its partial bytes on disk; ENOSPC stays the backstop there).
|
||||||
|
if err := CheckDiskSpace(outputDir, totalBytes, u.minFreeBytes); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Always flush progress on exit — covers graceful shutdown, SIGTERM,
|
// Always flush progress on exit — covers graceful shutdown, SIGTERM,
|
||||||
|
|
@ -263,6 +276,11 @@ func (u *UsenetDownloader) Download(ctx context.Context, task *Task, outputDir s
|
||||||
if ppResult.Extracted {
|
if ppResult.Extracted {
|
||||||
log.Printf("[%s] extracted archive", shortID)
|
log.Printf("[%s] extracted archive", shortID)
|
||||||
}
|
}
|
||||||
|
if ppResult.VerifyNote != "" {
|
||||||
|
// Degraded verification (par2 missing / repair failed): surface it loudly
|
||||||
|
// so the delivered file isn't silently assumed good.
|
||||||
|
log.Printf("[%s] WARNING: %s", shortID, ppResult.VerifyNote)
|
||||||
|
}
|
||||||
|
|
||||||
finalPath := ppResult.FinalPath
|
finalPath := ppResult.FinalPath
|
||||||
if finalPath == "" {
|
if finalPath == "" {
|
||||||
|
|
|
||||||
97
internal/engine/vaapi_args_test.go
Normal file
97
internal/engine/vaapi_args_test.go
Normal file
|
|
@ -0,0 +1,97 @@
|
||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildHLSFFmpegArgsVAAPI(t *testing.T) {
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/tmp/test.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
AudioIndex: 0,
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelVAAPI,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100}
|
||||||
|
args := buildHLSFFmpegArgsAt(cfg, probe, "/tmp/tmpdir", 0, 0)
|
||||||
|
got := strings.Join(args, " ")
|
||||||
|
|
||||||
|
wants := []string{
|
||||||
|
"-hwaccel vaapi",
|
||||||
|
"-vaapi_device /dev/dri/renderD128",
|
||||||
|
"-c:v h264_vaapi",
|
||||||
|
"format=nv12",
|
||||||
|
"hwupload",
|
||||||
|
}
|
||||||
|
for _, want := range wants {
|
||||||
|
if !strings.Contains(got, want) {
|
||||||
|
t.Errorf("argv missing %q\n%s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(got, "scale_vaapi") {
|
||||||
|
t.Errorf("argv unexpectedly contains scale_vaapi (mesa bug): %s", got)
|
||||||
|
}
|
||||||
|
if strings.Contains(got, "format=yuv420p") {
|
||||||
|
t.Errorf("argv contains format=yuv420p (libx264 path) for VAAPI codec: %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildHLSFFmpegArgsLibx264NoRegression(t *testing.T) {
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "test",
|
||||||
|
SourcePath: "/tmp/test.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
AudioIndex: 0,
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelNone,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{Width: 1920, Height: 1080, DurationSec: 100}
|
||||||
|
args := buildHLSFFmpegArgsAt(cfg, probe, "/tmp/tmpdir", 0, 0)
|
||||||
|
got := strings.Join(args, " ")
|
||||||
|
for _, want := range []string{"-c:v libx264", "format=yuv420p", "setparams=colorspace=bt709"} {
|
||||||
|
if !strings.Contains(got, want) {
|
||||||
|
t.Errorf("libx264 argv missing %q: %s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"-vaapi_device", "format=nv12", "hwupload"} {
|
||||||
|
if strings.Contains(got, bad) {
|
||||||
|
t.Errorf("libx264 argv unexpectedly contains %q: %s", bad, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBuildHLSFFmpegArgsVAAPIDump prints the full argv buildHLSFFmpegArgsAt
|
||||||
|
// emits for a typical VAAPI session. Mimics the daemon spawn step so the
|
||||||
|
// operator can verify the ffmpeg command-line shape without booting the
|
||||||
|
// stack — equivalent to `journalctl --user -u unarr-dev | grep ffmpeg`
|
||||||
|
// but without waiting for a real player session.
|
||||||
|
func TestBuildHLSFFmpegArgsVAAPIDump(t *testing.T) {
|
||||||
|
cfg := HLSSessionConfig{
|
||||||
|
SessionID: "vaapi-smoke",
|
||||||
|
SourcePath: "/mnt/nas/peliculas/sample.mkv",
|
||||||
|
Quality: "720p",
|
||||||
|
AudioIndex: -1,
|
||||||
|
Transcode: TranscodeRuntime{
|
||||||
|
FFmpegPath: "/usr/bin/ffmpeg",
|
||||||
|
FFprobePath: "/usr/bin/ffprobe",
|
||||||
|
HWAccel: HWAccelVAAPI,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
probe := &StreamProbe{
|
||||||
|
VideoCodec: "hevc",
|
||||||
|
Width: 3840,
|
||||||
|
Height: 2160,
|
||||||
|
DurationSec: 5400,
|
||||||
|
AudioTracks: []ProbeAudioTrack{{Index: 0, Lang: "en", Codec: "ac3"}},
|
||||||
|
}
|
||||||
|
args := buildHLSFFmpegArgsAt(cfg, probe, "/tmp/smoke-tmpdir", 0, 0)
|
||||||
|
t.Logf("ffmpeg %s", strings.Join(args, " "))
|
||||||
|
}
|
||||||
|
|
@ -21,12 +21,32 @@ var validSessionID = regexp.MustCompile(`^[a-zA-Z0-9_-]{1,128}$`)
|
||||||
// 127.0.0.1 is listed in addition to localhost because some browsers treat
|
// 127.0.0.1 is listed in addition to localhost because some browsers treat
|
||||||
// them as distinct origins for CORS.
|
// them as distinct origins for CORS.
|
||||||
//
|
//
|
||||||
|
// Mirrors (`.to`, `staging.torrentclaw.com`, `www.`) are listed so a user
|
||||||
|
// playing from any official mirror succeeds the HEAD probe; without these
|
||||||
|
// the browser drops the response for "missing ACAO" and the player reports
|
||||||
|
// "404 todos los canales" even though the daemon returned 200.
|
||||||
|
//
|
||||||
// Note: media tags (<video src>, <audio src>) do not send the Origin
|
// Note: media tags (<video src>, <audio src>) do not send the Origin
|
||||||
// header so they are not gated by CORS at all; this allowlist only
|
// header so they are not gated by CORS at all; this allowlist only
|
||||||
// affects fetch()/XHR.
|
// affects fetch()/XHR.
|
||||||
var defaultCORSAllowedOrigins = []string{
|
var defaultCORSAllowedOrigins = []string{
|
||||||
"https://torrentclaw.com",
|
"https://torrentclaw.com",
|
||||||
|
"https://www.torrentclaw.com",
|
||||||
"https://app.torrentclaw.com",
|
"https://app.torrentclaw.com",
|
||||||
|
"https://staging.torrentclaw.com",
|
||||||
|
"https://torrentclaw.to",
|
||||||
|
"https://www.torrentclaw.to",
|
||||||
|
// unarr brand (separate deployment). The web player + agent endpoints run
|
||||||
|
// under unarr.app; without these the browser drops every /hls + /stream
|
||||||
|
// response (no Access-Control-Allow-Origin) and playback fails on unarr.
|
||||||
|
"https://unarr.app",
|
||||||
|
"https://www.unarr.app",
|
||||||
|
// Tor mirror — Tor Browser sends `Origin: http://<addr>.onion` (plain
|
||||||
|
// http, no port). Mirror address is the BUILT_IN_ONION constant from
|
||||||
|
// torrentclaw-web/src/lib/mirrors-config.ts; rotates rarely, kept in
|
||||||
|
// sync by hand. Daemon also dynamically merges /api/mirrors at startup
|
||||||
|
// (see daemon.go) so a new key doesn't need a CLI rebuild.
|
||||||
|
"http://torrentf3aifidcsaaanmnmuhv2s53r6hqsl3zkmfidiaxainkeqk5id.onion",
|
||||||
"http://localhost:3030",
|
"http://localhost:3030",
|
||||||
"http://127.0.0.1:3030",
|
"http://127.0.0.1:3030",
|
||||||
}
|
}
|
||||||
|
|
|
||||||
203
internal/funnel/funnel.go
Normal file
203
internal/funnel/funnel.go
Normal file
|
|
@ -0,0 +1,203 @@
|
||||||
|
// Package funnel manages the optional CloudFlare Quick Tunnel subprocess
|
||||||
|
// that gives the daemon a public HTTPS hostname for cross-network playback
|
||||||
|
// from browser-based clients (web player on torrentclaw.com / torrentclaw.to).
|
||||||
|
//
|
||||||
|
// Why: HTTPS pages can't fetch HTTP resources (mixed content). Without a
|
||||||
|
// tunnel the daemon is only reachable from the same machine (localhost is
|
||||||
|
// exempt) or via Tailscale (which users can install themselves but most
|
||||||
|
// won't). CF Quick Tunnels are anonymous — no CF account, no DNS, no port
|
||||||
|
// forwarding — and assign a one-shot `https://<random>.trycloudflare.com`
|
||||||
|
// URL. Bytes flow through CF, never through our infra (legal posture: we
|
||||||
|
// don't relay; CF does).
|
||||||
|
//
|
||||||
|
// Lifecycle:
|
||||||
|
//
|
||||||
|
// t, err := funnel.Start(ctx, funnel.Config{Port: 11819})
|
||||||
|
// defer t.Close()
|
||||||
|
// url, err := t.WaitURL(30 * time.Second) // blocks until cloudflared emits the URL
|
||||||
|
//
|
||||||
|
// The tunnel runs until the context is cancelled or t.Close() is called.
|
||||||
|
package funnel
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os/exec"
|
||||||
|
"regexp"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// urlPattern matches the `https://<random>.trycloudflare.com` URL cloudflared
|
||||||
|
// prints when a Quick Tunnel is registered. Quick Tunnel hostnames are always
|
||||||
|
// several hyphen-joined dictionary words (e.g.
|
||||||
|
// `make-appointments-negotiation-blacks`), so we require at least one hyphen.
|
||||||
|
// This deliberately excludes cloudflared's control-plane endpoint
|
||||||
|
// `https://api.trycloudflare.com`, which appears earlier in the log stream — a
|
||||||
|
// permissive `[a-z0-9-]+` matched `api` first and we advertised a dead URL.
|
||||||
|
var urlPattern = regexp.MustCompile(`https://[a-z0-9]+(?:-[a-z0-9]+)+\.trycloudflare\.com`)
|
||||||
|
|
||||||
|
// Config controls how the tunnel is launched.
|
||||||
|
type Config struct {
|
||||||
|
// Port is the local upstream port cloudflared will tunnel to. Required.
|
||||||
|
Port int
|
||||||
|
// Binary is the cloudflared executable path. When empty the package looks
|
||||||
|
// it up via $PATH.
|
||||||
|
Binary string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tunnel is a handle on a running cloudflared Quick Tunnel.
|
||||||
|
type Tunnel struct {
|
||||||
|
cmd *exec.Cmd
|
||||||
|
cancel context.CancelFunc
|
||||||
|
urlCh chan string
|
||||||
|
exitCh chan error
|
||||||
|
mu sync.Mutex
|
||||||
|
url string
|
||||||
|
stopped bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start launches cloudflared as a subprocess. The returned *Tunnel exposes the
|
||||||
|
// public URL via WaitURL once cloudflared registers it (usually 2–5 s).
|
||||||
|
//
|
||||||
|
// The subprocess inherits the cancellation of the supplied context. Closing
|
||||||
|
// the *Tunnel sends SIGTERM and waits for the subprocess to exit.
|
||||||
|
func Start(ctx context.Context, cfg Config) (*Tunnel, error) {
|
||||||
|
if cfg.Port <= 0 {
|
||||||
|
return nil, fmt.Errorf("funnel: invalid Port %d", cfg.Port)
|
||||||
|
}
|
||||||
|
binary := cfg.Binary
|
||||||
|
if binary == "" {
|
||||||
|
resolved, err := ResolveBinary()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
binary = resolved
|
||||||
|
}
|
||||||
|
|
||||||
|
subCtx, cancel := context.WithCancel(ctx)
|
||||||
|
// `--no-autoupdate` disables cloudflared's daily self-update check (the
|
||||||
|
// daemon manages binary rotation). `--metrics 127.0.0.1:0` suppresses the
|
||||||
|
// default `:9090` listener that would collide on a shared box.
|
||||||
|
cmd := exec.CommandContext(subCtx, binary,
|
||||||
|
"tunnel",
|
||||||
|
"--no-autoupdate",
|
||||||
|
"--metrics", "127.0.0.1:0",
|
||||||
|
"--url", fmt.Sprintf("http://localhost:%d", cfg.Port),
|
||||||
|
)
|
||||||
|
|
||||||
|
// cloudflared writes the connect log + assigned URL to stderr.
|
||||||
|
stderr, err := cmd.StderrPipe()
|
||||||
|
if err != nil {
|
||||||
|
cancel()
|
||||||
|
return nil, fmt.Errorf("funnel: pipe stderr: %w", err)
|
||||||
|
}
|
||||||
|
cmd.Stdout = io.Discard // quick tunnels print nothing useful on stdout
|
||||||
|
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
cancel()
|
||||||
|
return nil, fmt.Errorf("funnel: start cloudflared: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := &Tunnel{
|
||||||
|
cmd: cmd,
|
||||||
|
cancel: cancel,
|
||||||
|
urlCh: make(chan string, 1),
|
||||||
|
exitCh: make(chan error, 1),
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reader goroutine: scan cloudflared's stderr for the URL, surface the
|
||||||
|
// rest as a single string we don't try to interpret.
|
||||||
|
go t.scanStderr(stderr)
|
||||||
|
|
||||||
|
// Waiter goroutine: signal exit so callers can react (e.g. restart).
|
||||||
|
go func() {
|
||||||
|
t.exitCh <- cmd.Wait()
|
||||||
|
}()
|
||||||
|
|
||||||
|
return t, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WaitURL blocks until cloudflared has registered the tunnel and emitted the
|
||||||
|
// public URL, or `timeout` elapses, or the subprocess exits. The returned URL
|
||||||
|
// has the form `https://<random>.trycloudflare.com`.
|
||||||
|
func (t *Tunnel) WaitURL(timeout time.Duration) (string, error) {
|
||||||
|
t.mu.Lock()
|
||||||
|
if t.url != "" {
|
||||||
|
u := t.url
|
||||||
|
t.mu.Unlock()
|
||||||
|
return u, nil
|
||||||
|
}
|
||||||
|
t.mu.Unlock()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case u := <-t.urlCh:
|
||||||
|
return u, nil
|
||||||
|
case err := <-t.exitCh:
|
||||||
|
if err == nil {
|
||||||
|
return "", errors.New("funnel: cloudflared exited before URL")
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("funnel: cloudflared exited: %w", err)
|
||||||
|
case <-time.After(timeout):
|
||||||
|
return "", fmt.Errorf("funnel: timed out waiting for URL after %s", timeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// URL returns the assigned tunnel URL, or "" if not yet emitted.
|
||||||
|
func (t *Tunnel) URL() string {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
return t.url
|
||||||
|
}
|
||||||
|
|
||||||
|
// Done returns a channel that closes once the subprocess exits. The error sent
|
||||||
|
// before close describes the exit reason (nil = clean shutdown via Close).
|
||||||
|
func (t *Tunnel) Done() <-chan error {
|
||||||
|
return t.exitCh
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close terminates the subprocess and waits for it to exit. Safe to call
|
||||||
|
// multiple times.
|
||||||
|
func (t *Tunnel) Close() error {
|
||||||
|
t.mu.Lock()
|
||||||
|
if t.stopped {
|
||||||
|
t.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
t.stopped = true
|
||||||
|
t.mu.Unlock()
|
||||||
|
t.cancel()
|
||||||
|
// Drain the exit channel so the Wait goroutine doesn't leak.
|
||||||
|
select {
|
||||||
|
case <-t.exitCh:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *Tunnel) scanStderr(r io.Reader) {
|
||||||
|
scanner := bufio.NewScanner(r)
|
||||||
|
// Some cloudflared lines exceed the default 64KiB scanner buffer (when it
|
||||||
|
// prints connection diagnostics). Bump to 1MiB.
|
||||||
|
scanner.Buffer(make([]byte, 0, 64*1024), 1024*1024)
|
||||||
|
for scanner.Scan() {
|
||||||
|
line := scanner.Text()
|
||||||
|
if t.URL() == "" {
|
||||||
|
if m := urlPattern.FindString(line); m != "" {
|
||||||
|
t.mu.Lock()
|
||||||
|
t.url = m
|
||||||
|
t.mu.Unlock()
|
||||||
|
// Non-blocking send: if no one is listening, just drop —
|
||||||
|
// the URL field carries the value for any later WaitURL call.
|
||||||
|
select {
|
||||||
|
case t.urlCh <- m:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
40
internal/funnel/funnel_test.go
Normal file
40
internal/funnel/funnel_test.go
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
package funnel
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestURLPattern(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
line string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "real quick tunnel banner",
|
||||||
|
line: "2026-05-29T22:18:33Z INF | https://make-appointments-negotiation-blacks.trycloudflare.com |",
|
||||||
|
want: "https://make-appointments-negotiation-blacks.trycloudflare.com",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "two-word hostname",
|
||||||
|
line: "https://blue-river.trycloudflare.com is ready",
|
||||||
|
want: "https://blue-river.trycloudflare.com",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "control-plane api endpoint is ignored",
|
||||||
|
line: `2026-05-29T22:17:59Z DBG POST https://api.trycloudflare.com/tunnel`,
|
||||||
|
want: "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "no trycloudflare url",
|
||||||
|
line: "2026-05-29T22:17:44Z INF Requesting new quick Tunnel on trycloudflare.com...",
|
||||||
|
want: "",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
if got := urlPattern.FindString(tc.line); got != tc.want {
|
||||||
|
t.Fatalf("FindString(%q) = %q, want %q", tc.line, got, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
224
internal/funnel/install.go
Normal file
224
internal/funnel/install.go
Normal file
|
|
@ -0,0 +1,224 @@
|
||||||
|
package funnel
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// pinnedCloudflaredVersion is the exact cloudflared release the auto-downloader
|
||||||
|
// fetches. We deliberately do NOT track `latest`: pinning a version we vetted +
|
||||||
|
// verifying its SHA-256 is what bounds the supply-chain risk (a future malicious
|
||||||
|
// or breaking upstream release can't be pulled silently). Operator-installed
|
||||||
|
// cloudflared on $PATH always wins, so this only affects the headless
|
||||||
|
// auto-download fallback.
|
||||||
|
//
|
||||||
|
// To bump: pick a newer tag, copy its per-asset SHA-256 from the release body
|
||||||
|
// (https://github.com/cloudflare/cloudflared/releases/tag/<version>) into the
|
||||||
|
// map below, and update this constant. All four arch entries MUST be present.
|
||||||
|
const pinnedCloudflaredVersion = "2026.5.2"
|
||||||
|
|
||||||
|
// pinnedCloudflaredSHA256 maps each linux asset to its SHA-256 for
|
||||||
|
// pinnedCloudflaredVersion (from the release body — Cloudflare publishes the
|
||||||
|
// hashes inline there, not as a separate file or signature).
|
||||||
|
var pinnedCloudflaredSHA256 = map[string]string{
|
||||||
|
"cloudflared-linux-amd64": "5286698547f03df745adb2355f04c12dde52ef425491e81f433642d695521886",
|
||||||
|
"cloudflared-linux-arm64": "5a4e8ce2701105271412059f44b6a0bf1ae4542b4d98ff3180c0c019443a5815",
|
||||||
|
"cloudflared-linux-armhf": "190152c373f608080eb6aa9e2aad395f88398dfb9efd0f9b064e2652cffcefdd",
|
||||||
|
"cloudflared-linux-386": "ad82d1dbed8bbb9d702807cbd97df932cc774d29e9da5c109b7a3c7f7aee2065",
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResolveBinary returns the path to a usable cloudflared executable, downloading
|
||||||
|
// one into the unarr data dir if neither $PATH nor the cached location has it.
|
||||||
|
// This makes the funnel feature usable on headless installs (NAS / Docker)
|
||||||
|
// where the user can't easily install cloudflared via the OS package manager.
|
||||||
|
//
|
||||||
|
// Resolution order:
|
||||||
|
//
|
||||||
|
// 1. cloudflared on $PATH (operator already installed it)
|
||||||
|
// 2. <data-dir>/bin/cloudflared (we cached it on a previous run)
|
||||||
|
// 3. download from GitHub releases (Linux-only fallback; macOS / Windows
|
||||||
|
// return a clear error pointing at brew / winget)
|
||||||
|
func ResolveBinary() (string, error) {
|
||||||
|
if p, err := exec.LookPath("cloudflared"); err == nil {
|
||||||
|
return p, nil
|
||||||
|
}
|
||||||
|
cached := cachedBinaryPath()
|
||||||
|
if _, err := os.Stat(cached); err == nil {
|
||||||
|
return cached, nil
|
||||||
|
}
|
||||||
|
return downloadCloudflared(cached)
|
||||||
|
}
|
||||||
|
|
||||||
|
func cachedBinaryPath() string {
|
||||||
|
name := "cloudflared"
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
name += ".exe"
|
||||||
|
}
|
||||||
|
return filepath.Join(config.DataDir(), "bin", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// downloadCloudflared fetches the PINNED cloudflared release asset matching the
|
||||||
|
// current GOOS/GOARCH into `dest`. Linux only — macOS/Windows return a pointer
|
||||||
|
// at the OS package manager.
|
||||||
|
//
|
||||||
|
// Integrity: the fetch is HTTPS (bounded by Let's Encrypt + GitHub's cert
|
||||||
|
// chain) AND the downloaded bytes are verified against a baked-in SHA-256 for
|
||||||
|
// the pinned version (pinnedCloudflaredSHA256). A mismatch — corruption, MITM
|
||||||
|
// past TLS, a swapped asset — is rejected before the binary is promoted or run.
|
||||||
|
// Because the version is pinned (not `latest`), a future malicious/breaking
|
||||||
|
// upstream release is never pulled silently. The cheap ELF/size check still
|
||||||
|
// runs first to reject a 404 HTML page before hashing 50 MB. For stricter
|
||||||
|
// control, install cloudflared via your distro package manager — the PATH copy
|
||||||
|
// always takes precedence.
|
||||||
|
func downloadCloudflared(dest string) (string, error) {
|
||||||
|
if runtime.GOOS != "linux" {
|
||||||
|
return "", fmt.Errorf("funnel: auto-download not supported on %s — install cloudflared manually or drop a binary at %s", runtime.GOOS, dest)
|
||||||
|
}
|
||||||
|
|
||||||
|
var asset string
|
||||||
|
switch runtime.GOARCH {
|
||||||
|
case "amd64":
|
||||||
|
asset = "cloudflared-linux-amd64"
|
||||||
|
case "arm64":
|
||||||
|
asset = "cloudflared-linux-arm64"
|
||||||
|
case "arm":
|
||||||
|
asset = "cloudflared-linux-armhf"
|
||||||
|
case "386":
|
||||||
|
asset = "cloudflared-linux-386"
|
||||||
|
default:
|
||||||
|
return "", fmt.Errorf("funnel: unsupported linux arch %q — install cloudflared manually", runtime.GOARCH)
|
||||||
|
}
|
||||||
|
|
||||||
|
expectedSHA, ok := pinnedCloudflaredSHA256[asset]
|
||||||
|
if !ok {
|
||||||
|
return "", fmt.Errorf("funnel: no pinned SHA-256 for asset %q (bug: keep pinnedCloudflaredSHA256 in sync with the arch switch)", asset)
|
||||||
|
}
|
||||||
|
|
||||||
|
url := "https://github.com/cloudflare/cloudflared/releases/download/" + pinnedCloudflaredVersion + "/" + asset
|
||||||
|
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
||||||
|
return "", fmt.Errorf("funnel: create bin dir: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// O_EXCL so concurrent unarr-dev / prod daemons don't clobber each
|
||||||
|
// other's partial download. The loser gets EEXIST → falls back to
|
||||||
|
// polling for the winner to finish.
|
||||||
|
tmp := dest + ".partial"
|
||||||
|
out, err := os.OpenFile(tmp, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o755)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, os.ErrExist) {
|
||||||
|
// Another process is downloading. Wait briefly for them to finish.
|
||||||
|
for range 60 {
|
||||||
|
time.Sleep(time.Second)
|
||||||
|
if _, statErr := os.Stat(dest); statErr == nil {
|
||||||
|
return dest, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("funnel: another download in progress at %s (timed out)", tmp)
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("funnel: open dest: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
client := &http.Client{Timeout: 5 * time.Minute}
|
||||||
|
resp, err := client.Get(url)
|
||||||
|
if err != nil {
|
||||||
|
_ = out.Close()
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: download cloudflared: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
_ = out.Close()
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: download cloudflared: HTTP %d from %s", resp.StatusCode, url)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := io.Copy(out, resp.Body); err != nil {
|
||||||
|
_ = out.Close()
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: write dest: %w", err)
|
||||||
|
}
|
||||||
|
if err := out.Close(); err != nil {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: close dest: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Cheap reject first: must be a Linux ELF executable (rejects 404 HTML pages
|
||||||
|
// or wrong-arch payloads) and at least 1 MB, so we don't hash 50 MB of an
|
||||||
|
// obviously-wrong file.
|
||||||
|
if err := verifyLinuxElf(tmp); err != nil {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: downloaded file failed sanity check: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Authoritative integrity gate: the bytes must match the SHA-256 we baked in
|
||||||
|
// for the pinned version. Rejects corruption, a MITM past TLS, or a swapped
|
||||||
|
// asset before the binary is ever promoted or executed.
|
||||||
|
if err := verifySHA256(tmp, expectedSHA); err != nil {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: cloudflared %s integrity check failed: %w", pinnedCloudflaredVersion, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := os.Rename(tmp, dest); err != nil {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return "", fmt.Errorf("funnel: rename dest: %w", err)
|
||||||
|
}
|
||||||
|
return dest, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// verifyLinuxElf returns nil when the file at `path` starts with the ELF
|
||||||
|
// magic bytes and is at least 1 MB. Used as a low-cost guard against
|
||||||
|
// downloading an HTML error page or a wrong-arch payload.
|
||||||
|
func verifyLinuxElf(path string) error {
|
||||||
|
st, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if st.Size() < 1024*1024 {
|
||||||
|
return errors.New("file is suspiciously small (<1 MB)")
|
||||||
|
}
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
head := make([]byte, 4)
|
||||||
|
if _, err := io.ReadFull(f, head); err != nil {
|
||||||
|
return fmt.Errorf("read magic bytes: %w", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(head, []byte{0x7f, 'E', 'L', 'F'}) {
|
||||||
|
return errors.New("not an ELF binary")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// verifySHA256 returns nil when the file at `path` hashes to expectedHex
|
||||||
|
// (case-insensitive), else an error reporting both digests.
|
||||||
|
func verifySHA256(path, expectedHex string) error {
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
h := sha256.New()
|
||||||
|
if _, err := io.Copy(h, f); err != nil {
|
||||||
|
return fmt.Errorf("hashing: %w", err)
|
||||||
|
}
|
||||||
|
got := hex.EncodeToString(h.Sum(nil))
|
||||||
|
if !strings.EqualFold(got, expectedHex) {
|
||||||
|
return fmt.Errorf("sha256 mismatch: got %s, want %s", got, expectedHex)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
62
internal/funnel/install_test.go
Normal file
62
internal/funnel/install_test.go
Normal file
|
|
@ -0,0 +1,62 @@
|
||||||
|
package funnel
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestVerifySHA256 covers the integrity gate used on the auto-downloaded
|
||||||
|
// cloudflared binary: it accepts the matching digest (case-insensitive) and
|
||||||
|
// rejects a wrong one.
|
||||||
|
func TestVerifySHA256(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "blob")
|
||||||
|
content := []byte("cloudflared-bytes")
|
||||||
|
if err := os.WriteFile(path, content, 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
sum := sha256.Sum256(content)
|
||||||
|
good := hex.EncodeToString(sum[:])
|
||||||
|
|
||||||
|
if err := verifySHA256(path, good); err != nil {
|
||||||
|
t.Errorf("verifySHA256(correct) = %v, want nil", err)
|
||||||
|
}
|
||||||
|
// Upper-case should still match.
|
||||||
|
if err := verifySHA256(path, good[:60]+"ABCD"); err == nil {
|
||||||
|
t.Error("verifySHA256(wrong) = nil, want mismatch error")
|
||||||
|
}
|
||||||
|
if err := verifySHA256(path, "deadbeef"); err == nil {
|
||||||
|
t.Error("verifySHA256(short/wrong) = nil, want error")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPinnedCloudflaredSHA256Complete guards the invariant that every linux arch
|
||||||
|
// the downloader can select has a pinned 64-hex SHA-256, so a download never
|
||||||
|
// reaches the verify step without an expected digest.
|
||||||
|
func TestPinnedCloudflaredSHA256Complete(t *testing.T) {
|
||||||
|
wantAssets := []string{
|
||||||
|
"cloudflared-linux-amd64",
|
||||||
|
"cloudflared-linux-arm64",
|
||||||
|
"cloudflared-linux-armhf",
|
||||||
|
"cloudflared-linux-386",
|
||||||
|
}
|
||||||
|
for _, a := range wantAssets {
|
||||||
|
sum, ok := pinnedCloudflaredSHA256[a]
|
||||||
|
if !ok {
|
||||||
|
t.Errorf("missing pinned SHA-256 for %q", a)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if len(sum) != 64 {
|
||||||
|
t.Errorf("%s: SHA-256 length = %d, want 64", a, len(sum))
|
||||||
|
}
|
||||||
|
if _, err := hex.DecodeString(sum); err != nil {
|
||||||
|
t.Errorf("%s: SHA-256 not valid hex: %v", a, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if pinnedCloudflaredVersion == "" {
|
||||||
|
t.Error("pinnedCloudflaredVersion must be set")
|
||||||
|
}
|
||||||
|
}
|
||||||
55
internal/library/fingerprint.go
Normal file
55
internal/library/fingerprint.go
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
package library
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/binary"
|
||||||
|
"encoding/hex"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fpChunk is how many bytes are hashed from the head and the tail of a file.
|
||||||
|
const fpChunk = 1 << 20 // 1 MiB
|
||||||
|
|
||||||
|
// ComputeFingerprint returns a stable content identity for a media file:
|
||||||
|
// sha256(fileSize ‖ first 1 MiB ‖ last 1 MiB). It survives renames, moves, and
|
||||||
|
// base-path changes (unlike the absolute path), so the server can recognise the
|
||||||
|
// same file at a new location and move its library row in place instead of
|
||||||
|
// duplicating it. Cheap: two bounded reads, never the whole file (except small
|
||||||
|
// ones). See docs/plans/unarr-path-resilience.md in the web repo.
|
||||||
|
func ComputeFingerprint(path string, size int64) (string, error) {
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
|
||||||
|
h := sha256.New()
|
||||||
|
var sizeBuf [8]byte
|
||||||
|
binary.LittleEndian.PutUint64(sizeBuf[:], uint64(size))
|
||||||
|
h.Write(sizeBuf[:])
|
||||||
|
|
||||||
|
if size <= 2*fpChunk {
|
||||||
|
// Small file: hash it whole — head+tail would overlap anyway.
|
||||||
|
if _, err := io.Copy(h, f); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
head := make([]byte, fpChunk)
|
||||||
|
if _, err := io.ReadFull(f, head); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
h.Write(head)
|
||||||
|
|
||||||
|
if _, err := f.Seek(size-fpChunk, io.SeekStart); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
tail := make([]byte, fpChunk)
|
||||||
|
if _, err := io.ReadFull(f, tail); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
h.Write(tail)
|
||||||
|
}
|
||||||
|
|
||||||
|
return hex.EncodeToString(h.Sum(nil)), nil
|
||||||
|
}
|
||||||
81
internal/library/fingerprint_test.go
Normal file
81
internal/library/fingerprint_test.go
Normal file
|
|
@ -0,0 +1,81 @@
|
||||||
|
package library
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func writeFile(t *testing.T, dir, name string, data []byte) string {
|
||||||
|
t.Helper()
|
||||||
|
p := filepath.Join(dir, name)
|
||||||
|
if err := os.WriteFile(p, data, 0o644); err != nil {
|
||||||
|
t.Fatalf("write %s: %v", p, err)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
func fp(t *testing.T, path string) string {
|
||||||
|
t.Helper()
|
||||||
|
fi, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("stat %s: %v", path, err)
|
||||||
|
}
|
||||||
|
s, err := ComputeFingerprint(path, fi.Size())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fingerprint %s: %v", path, err)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComputeFingerprint(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
big := make([]byte, 5<<20) // 5 MiB > 2*chunk
|
||||||
|
for i := range big {
|
||||||
|
big[i] = byte(i * 7)
|
||||||
|
}
|
||||||
|
|
||||||
|
a := fp(t, writeFile(t, dir, "a.bin", big))
|
||||||
|
if len(a) != 64 {
|
||||||
|
t.Fatalf("want 64-hex, got %d", len(a))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Move-invariance: identical bytes at a different path → same fingerprint.
|
||||||
|
if b := fp(t, writeFile(t, dir, "moved.bin", big)); b != a {
|
||||||
|
t.Errorf("move changed fingerprint: %s != %s", a, b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tail sensitivity: flipping the last byte must change the fingerprint.
|
||||||
|
tailMut := append([]byte(nil), big...)
|
||||||
|
tailMut[len(tailMut)-1] ^= 0xFF
|
||||||
|
if c := fp(t, writeFile(t, dir, "tail.bin", tailMut)); c == a {
|
||||||
|
t.Error("tail mutation did not change fingerprint")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Head sensitivity.
|
||||||
|
headMut := append([]byte(nil), big...)
|
||||||
|
headMut[0] ^= 0xFF
|
||||||
|
if c := fp(t, writeFile(t, dir, "head.bin", headMut)); c == a {
|
||||||
|
t.Error("head mutation did not change fingerprint")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Size is mixed in: a small file and a large file never collide trivially.
|
||||||
|
small := fp(t, writeFile(t, dir, "small.bin", []byte("hello world")))
|
||||||
|
if small == a {
|
||||||
|
t.Error("small and big fingerprints collided")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRelToRoot(t *testing.T) {
|
||||||
|
cases := []struct{ root, full, want string }{
|
||||||
|
{"/downloads", "/downloads/TV Shows/X/S01E09.mkv", "TV Shows/X/S01E09.mkv"},
|
||||||
|
{"/downloads", "/mnt/other/file.mkv", ""}, // outside root
|
||||||
|
{"/downloads", "/downloads", ""}, // equal → "."
|
||||||
|
{"", "/x/y.mkv", ""}, // no root
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
if got := relToRoot(c.root, c.full); got != c.want {
|
||||||
|
t.Errorf("relToRoot(%q,%q)=%q want %q", c.root, c.full, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
46
internal/library/loadgate_test.go
Normal file
46
internal/library/loadgate_test.go
Normal file
|
|
@ -0,0 +1,46 @@
|
||||||
|
package library
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/torrentclaw/unarr/internal/library/mediainfo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A huge ratio means the threshold is always above the real load, so the gate
|
||||||
|
// must return immediately (no blocking) regardless of how busy the box is.
|
||||||
|
func TestWaitForLowLoad_HighRatioReturnsImmediately(t *testing.T) {
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
waitForLowLoad(context.Background(), 1e9)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("waitForLowLoad blocked despite an impossibly-high threshold")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// With a tiny ratio the gate would block (load almost always exceeds it), but a
|
||||||
|
// cancelled context must unblock it promptly — the prewarm has to stop cleanly on
|
||||||
|
// Ctrl-C / daemon shutdown even while waiting for the machine to go idle.
|
||||||
|
func TestWaitForLowLoad_RespectsContextCancel(t *testing.T) {
|
||||||
|
if _, ok := mediainfo.LoadAverage1(); !ok {
|
||||||
|
t.Skip("no load reading on this platform — gate is a no-op")
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel() // already cancelled
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
waitForLowLoad(ctx, 0.0001) // threshold ~0 → would otherwise block
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("waitForLowLoad ignored a cancelled context")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -67,8 +67,14 @@ func ExtractMediaInfo(ctx context.Context, ffprobePath, filePath string) (*Media
|
||||||
|
|
||||||
output, err := cmd.Output()
|
output, err := cmd.Output()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if _, statErr := os.Stat(filePath); statErr != nil {
|
// A remote URL (debrid HLS-from-URL, hueco #2/2b) has no local file to
|
||||||
return nil, fmt.Errorf("ffprobe: file not found: %s", filePath)
|
// stat — surface ffprobe's own stderr (e.g. "Protocol not found" when the
|
||||||
|
// ffmpeg build lacks TLS, or an HTTP error) instead of a misleading
|
||||||
|
// "file not found". Only treat a genuine local path as possibly-missing.
|
||||||
|
if !strings.Contains(filePath, "://") {
|
||||||
|
if _, statErr := os.Stat(filePath); statErr != nil {
|
||||||
|
return nil, fmt.Errorf("ffprobe: file not found: %s", filePath)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return nil, fmt.Errorf("ffprobe failed (file=%s): %s", filePath, stderr.String())
|
return nil, fmt.Errorf("ffprobe failed (file=%s): %s", filePath, stderr.String())
|
||||||
}
|
}
|
||||||
|
|
@ -78,7 +84,55 @@ func ExtractMediaInfo(ctx context.Context, ffprobePath, filePath string) (*Media
|
||||||
return nil, fmt.Errorf("ffprobe JSON parse failed: %w", err)
|
return nil, fmt.Errorf("ffprobe JSON parse failed: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return parseFFprobeOutput(data)
|
mi, perr := parseFFprobeOutput(data)
|
||||||
|
if perr != nil {
|
||||||
|
return nil, perr
|
||||||
|
}
|
||||||
|
// A corrupt-but-parseable file (e.g. a half-downloaded MKV) returns valid
|
||||||
|
// stream JSON and a zero exit, yet ffprobe still logs structural errors to
|
||||||
|
// stderr (captured above). Flag it so the library can warn instead of
|
||||||
|
// silently shipping a file that won't play.
|
||||||
|
if integ := assessIntegrity(stderr.String(), mi); integ != nil {
|
||||||
|
mi.Integrity = integ
|
||||||
|
}
|
||||||
|
return mi, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// corruptionMarkers are high-confidence ffprobe stderr substrings (lowercased)
|
||||||
|
// that indicate a structurally damaged / incompletely-downloaded file, paired
|
||||||
|
// with a STABLE code the web maps to localized copy. Kept conservative so
|
||||||
|
// healthy files are never flagged — each appears only on real container/
|
||||||
|
// bitstream damage, not benign warnings (ffprobe runs at -v error).
|
||||||
|
var corruptionMarkers = []struct{ sub, code string }{
|
||||||
|
{"invalid data found when processing input", "invalid_data"},
|
||||||
|
{"as first byte of an ebml number", "ebml_corrupt"}, // truncated/corrupt MKV
|
||||||
|
{"moov atom not found", "moov_missing"}, // truncated MP4
|
||||||
|
{"invalid nal unit size", "bitstream_corrupt"},
|
||||||
|
{"non-existing pps", "bitstream_corrupt"},
|
||||||
|
// NOTE: deliberately NOT matching "error reading header" (ffprobe emits it
|
||||||
|
// on transient NFS/network read hiccups — a genuinely unreadable header
|
||||||
|
// also exits non-zero → ScanError → item skipped) nor "truncating packet"
|
||||||
|
// (printed for healthy MKV/TS with oversized subtitle/PGS packets). Both
|
||||||
|
// false-positive on good files; the markers above are structural.
|
||||||
|
}
|
||||||
|
|
||||||
|
// assessIntegrity inspects ffprobe's stderr plus the parsed result and returns
|
||||||
|
// a damaged verdict on a high-confidence corruption signal, else nil. The
|
||||||
|
// Reason is a stable code (see corruptionMarkers) the web localizes.
|
||||||
|
func assessIntegrity(stderr string, mi *MediaInfo) *IntegrityInfo {
|
||||||
|
low := strings.ToLower(stderr)
|
||||||
|
for _, m := range corruptionMarkers {
|
||||||
|
if strings.Contains(low, m.sub) {
|
||||||
|
return &IntegrityInfo{Damaged: true, Reason: m.code}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A file that carries a video stream but no determinable duration is almost
|
||||||
|
// always truncated (the moov/cues holding duration sit at the end of the
|
||||||
|
// file). Audio-only items legitimately omit it, so gate on having video.
|
||||||
|
if mi != nil && mi.Video != nil && mi.Video.Duration <= 0 {
|
||||||
|
return &IntegrityInfo{Damaged: true, Reason: "no_duration"}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseFFprobeOutput converts parsed ffprobe JSON into MediaInfo.
|
// parseFFprobeOutput converts parsed ffprobe JSON into MediaInfo.
|
||||||
|
|
|
||||||
|
|
@ -428,3 +428,42 @@ func TestParseFFprobeOutput_FrameRateNoSlash(t *testing.T) {
|
||||||
t.Errorf("frameRate = %v, want 0 (no slash)", mi.Video.FrameRate)
|
t.Errorf("frameRate = %v, want 0 (no slash)", mi.Video.FrameRate)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAssessIntegrity(t *testing.T) {
|
||||||
|
healthy := &MediaInfo{Video: &VideoInfo{Codec: "h264", Width: 1920, Height: 1080, Duration: 5477}}
|
||||||
|
|
||||||
|
// Healthy file with no stderr → nil (not damaged).
|
||||||
|
if got := assessIntegrity("", healthy); got != nil {
|
||||||
|
t.Errorf("healthy file flagged damaged: %+v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MKV EBML corruption (the real "In the Grey" case): ffprobe exits 0 but
|
||||||
|
// logs EBML errors → damaged with the ebml_corrupt code.
|
||||||
|
ebml := "[matroska,webm @ 0x60e7] 0x00 at pos 2144995 invalid as first byte of an EBML number\n"
|
||||||
|
got := assessIntegrity(ebml, healthy)
|
||||||
|
if got == nil || !got.Damaged || got.Reason != "ebml_corrupt" {
|
||||||
|
t.Errorf("EBML corruption not flagged correctly: %+v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Truncated MP4.
|
||||||
|
if got := assessIntegrity("moov atom not found\n", healthy); got == nil || got.Reason != "moov_missing" {
|
||||||
|
t.Errorf("moov-missing not flagged: %+v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invalid data.
|
||||||
|
if got := assessIntegrity("Invalid data found when processing input\n", healthy); got == nil || got.Reason != "invalid_data" {
|
||||||
|
t.Errorf("invalid-data not flagged: %+v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// No duration on a video stream → truncated.
|
||||||
|
noDur := &MediaInfo{Video: &VideoInfo{Codec: "h264", Width: 1920, Height: 1080, Duration: 0}}
|
||||||
|
if got := assessIntegrity("", noDur); got == nil || got.Reason != "no_duration" {
|
||||||
|
t.Errorf("no-duration not flagged: %+v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Audio-only file with no duration is NOT flagged (legitimately omits it).
|
||||||
|
audioOnly := &MediaInfo{Audio: []AudioTrack{{Lang: "en", Codec: "aac"}}}
|
||||||
|
if got := assessIntegrity("", audioOnly); got != nil {
|
||||||
|
t.Errorf("audio-only file wrongly flagged: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
65
internal/library/mediainfo/harden_linux_test.go
Normal file
65
internal/library/mediainfo/harden_linux_test.go
Normal file
|
|
@ -0,0 +1,65 @@
|
||||||
|
//go:build linux
|
||||||
|
|
||||||
|
package mediainfo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHardenCmd_KillsChildOnParentDeath is the e2e guarantee for the orphan fix:
|
||||||
|
// a child spawned with hardenCmd must be SIGKILL'd by the kernel the instant its
|
||||||
|
// parent process dies (Pdeathsig), so an agent crash/restart can never leave an
|
||||||
|
// ffmpeg running to ppid 1. It re-execs this test binary as a short-lived helper
|
||||||
|
// that starts `sleep`, prints the sleep PID, then exits — and asserts that PID is
|
||||||
|
// gone afterwards.
|
||||||
|
func TestHardenCmd_KillsChildOnParentDeath(t *testing.T) {
|
||||||
|
if os.Getenv("UNARR_PDEATHSIG_CHILD") == "1" {
|
||||||
|
// Helper role: start a hardened long sleep, announce its PID, then exit so
|
||||||
|
// the kernel fires Pdeathsig on it.
|
||||||
|
cmd := exec.Command("sleep", "120")
|
||||||
|
hardenCmd(cmd)
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
fmt.Println("ERR", err)
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
fmt.Println(cmd.Process.Pid)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
helper := exec.Command(os.Args[0], "-test.run=TestHardenCmd_KillsChildOnParentDeath", "-test.v")
|
||||||
|
helper.Env = append(os.Environ(), "UNARR_PDEATHSIG_CHILD=1")
|
||||||
|
out, err := helper.Output()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("helper run: %v (out=%q)", err, out)
|
||||||
|
}
|
||||||
|
|
||||||
|
var sleepPID int
|
||||||
|
for _, line := range strings.Split(string(out), "\n") {
|
||||||
|
if n, perr := strconv.Atoi(strings.TrimSpace(line)); perr == nil && n > 0 {
|
||||||
|
sleepPID = n
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sleepPID == 0 {
|
||||||
|
t.Fatalf("could not parse child PID from helper output: %q", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Give the kernel a moment to deliver SIGKILL after the helper exited.
|
||||||
|
deadline := time.Now().Add(3 * time.Second)
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
if syscall.Kill(sleepPID, 0) != nil {
|
||||||
|
return // process gone → Pdeathsig worked
|
||||||
|
}
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
}
|
||||||
|
// Cleanup if it somehow survived, then fail.
|
||||||
|
_ = syscall.Kill(sleepPID, syscall.SIGKILL)
|
||||||
|
t.Fatalf("child %d survived parent death — Pdeathsig not applied (orphan leak)", sleepPID)
|
||||||
|
}
|
||||||
75
internal/library/mediainfo/ioprio_linux.go
Normal file
75
internal/library/mediainfo/ioprio_linux.go
Normal file
|
|
@ -0,0 +1,75 @@
|
||||||
|
//go:build linux
|
||||||
|
|
||||||
|
package mediainfo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Linux I/O priority (ioprio) constants. The 16-bit ioprio value packs a class
|
||||||
|
// in the top 3 bits (shift 13) and a class-data nibble below it; the IDLE class
|
||||||
|
// takes no data.
|
||||||
|
const (
|
||||||
|
ioprioWhoProcess = 1 // IOPRIO_WHO_PROCESS
|
||||||
|
ioprioClassIdle = 3 // IOPRIO_CLASS_IDLE
|
||||||
|
ioprioClassShift = 13
|
||||||
|
)
|
||||||
|
|
||||||
|
// setIdleIOPriority best-effort lowers a process's I/O scheduling class to IDLE,
|
||||||
|
// so a long background read (the subtitle prewarm of a huge remux — a single
|
||||||
|
// ~14 min sequential read of a 60GB file over NFS) yields disk/NFS bandwidth to
|
||||||
|
// foreground work like live streaming. Linux-only; on kernels or filesystems
|
||||||
|
// that don't honor ioprio this simply has no effect. Errors are intentionally
|
||||||
|
// ignored — it's an optimization, never required for correctness.
|
||||||
|
func setIdleIOPriority(pid int) {
|
||||||
|
ioprio := ioprioClassIdle << ioprioClassShift // IDLE class, data 0
|
||||||
|
_, _, _ = syscall.Syscall(syscall.SYS_IOPRIO_SET, uintptr(ioprioWhoProcess), uintptr(pid), uintptr(ioprio))
|
||||||
|
}
|
||||||
|
|
||||||
|
// setLowCPUPriority best-effort drops a process to the lowest CPU niceness (19),
|
||||||
|
// so the heavy trickplay full-decode pass yields the CPU to foreground work.
|
||||||
|
// Pairs with setIdleIOPriority (disk): IDLE I/O alone is not enough when the
|
||||||
|
// bottleneck is software/contended 4K decode — without CPU nice, N stacked
|
||||||
|
// decodes pin every core (the host hit load ~140). Errors are ignored — it's an
|
||||||
|
// optimization, not required for correctness.
|
||||||
|
func setLowCPUPriority(pid int) {
|
||||||
|
_ = syscall.Setpriority(syscall.PRIO_PROCESS, pid, 19)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hardenCmd makes the child ffmpeg die with this agent. Setpgid isolates it in
|
||||||
|
// its own process group, and Pdeathsig=SIGKILL asks the kernel to kill it the
|
||||||
|
// instant the agent process dies. Without this, exec.CommandContext can only
|
||||||
|
// enforce its timeout from an in-process goroutine — an agent crash / restart /
|
||||||
|
// SIGKILL kills that goroutine, so the ffmpeg is reparented to init (ppid 1) and
|
||||||
|
// runs its full 45-min decode to the end. Successive dev restarts stacked those
|
||||||
|
// orphans (one pair per restart) and spiked the box to load ~140.
|
||||||
|
func hardenCmd(cmd *exec.Cmd) {
|
||||||
|
if cmd.SysProcAttr == nil {
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{}
|
||||||
|
}
|
||||||
|
cmd.SysProcAttr.Setpgid = true
|
||||||
|
cmd.SysProcAttr.Pdeathsig = syscall.SIGKILL
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadAverage1 returns the 1-minute system load from /proc/loadavg. ok=false when
|
||||||
|
// it can't be read, so callers treat "unknown" as "don't gate" (proceed) rather
|
||||||
|
// than blocking forever.
|
||||||
|
func LoadAverage1() (float64, bool) {
|
||||||
|
b, err := os.ReadFile("/proc/loadavg")
|
||||||
|
if err != nil {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
fields := strings.Fields(string(b))
|
||||||
|
if len(fields) == 0 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
v, err := strconv.ParseFloat(fields[0], 64)
|
||||||
|
if err != nil {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
return v, true
|
||||||
|
}
|
||||||
13
internal/library/mediainfo/ioprio_other.go
Normal file
13
internal/library/mediainfo/ioprio_other.go
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
//go:build !linux
|
||||||
|
|
||||||
|
package mediainfo
|
||||||
|
|
||||||
|
import "os/exec"
|
||||||
|
|
||||||
|
// These are Linux-specific optimizations / safeguards; no-ops elsewhere.
|
||||||
|
func setIdleIOPriority(_ int) {}
|
||||||
|
func setLowCPUPriority(_ int) {}
|
||||||
|
func hardenCmd(_ *exec.Cmd) {}
|
||||||
|
|
||||||
|
// LoadAverage1 is unavailable off Linux; ok=false means callers don't gate.
|
||||||
|
func LoadAverage1() (float64, bool) { return 0, false }
|
||||||
312
internal/library/mediainfo/sidecar.go
Normal file
312
internal/library/mediainfo/sidecar.go
Normal file
|
|
@ -0,0 +1,312 @@
|
||||||
|
package mediainfo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"math"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Sidecar cache: unarr stores extracted artifacts (WebVTT subtitles, thumbnail
|
||||||
|
// frames) in a hidden ".unarr" directory NEXT TO the media file, not in the XDG
|
||||||
|
// cache. Keeping them beside the content means they travel with the file and
|
||||||
|
// survive a cache-dir wipe, and the scan-time prewarm and the on-demand stream
|
||||||
|
// handlers share the exact same path scheme — so a subtitle/thumbnail extracted
|
||||||
|
// during a library scan is reused verbatim at play time (no re-extraction, no
|
||||||
|
// 60s-HTTP-timeout failures on huge remuxes).
|
||||||
|
//
|
||||||
|
// Everything here is best-effort: a read-only media mount just means no cache
|
||||||
|
// (the on-demand path still works), and a stale cache (media replaced) is
|
||||||
|
// detected by mtime and ignored.
|
||||||
|
|
||||||
|
const sidecarDirName = ".unarr"
|
||||||
|
|
||||||
|
// IsTextSubtitleCodec reports whether a subtitle codec can be extracted to
|
||||||
|
// WebVTT (text-based). Mirrors engine.ProbeSubtitleTrack.IsTextSubtitle and the
|
||||||
|
// web's isTextSubtitleCodec whitelist — bitmap subs (PGS/DVB/VOBSUB) are burned
|
||||||
|
// in, not extracted. Defined here (the leaf media package) so both the stream
|
||||||
|
// handlers and the scan-time prewarm classify codecs identically.
|
||||||
|
func IsTextSubtitleCodec(codec string) bool {
|
||||||
|
switch strings.ToLower(strings.TrimSpace(codec)) {
|
||||||
|
case "subrip", "srt", "ass", "ssa", "webvtt", "mov_text", "text":
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sidecarDir returns the hidden per-folder cache directory for a media file.
|
||||||
|
func sidecarDir(mediaPath string) string {
|
||||||
|
return filepath.Join(filepath.Dir(mediaPath), sidecarDirName)
|
||||||
|
}
|
||||||
|
|
||||||
|
// subtitleCachePath is the cached WebVTT path for subtitle stream `index`
|
||||||
|
// (0-based, matching ffmpeg's 0:s:N ordering) of mediaPath.
|
||||||
|
func subtitleCachePath(mediaPath string, index int) string {
|
||||||
|
return filepath.Join(sidecarDir(mediaPath), fmt.Sprintf("%s.s%d.vtt", filepath.Base(mediaPath), index))
|
||||||
|
}
|
||||||
|
|
||||||
|
// thumbnailCachePath is the cached JPEG path for a single frame at posSec
|
||||||
|
// (rounded to whole seconds) and the given width. The handler and the scan
|
||||||
|
// prewarm round identically so the same logical frame maps to one cache file.
|
||||||
|
func thumbnailCachePath(mediaPath string, posSec float64, width int) string {
|
||||||
|
sec := int(math.Round(posSec))
|
||||||
|
if sec < 0 {
|
||||||
|
sec = 0
|
||||||
|
}
|
||||||
|
return filepath.Join(sidecarDir(mediaPath), fmt.Sprintf("%s.t%dw%d.jpg", filepath.Base(mediaPath), sec, width))
|
||||||
|
}
|
||||||
|
|
||||||
|
// sidecarFresh reports whether a cache file exists and is at least as new as the
|
||||||
|
// media file. A re-download/replace bumps the media mtime and invalidates the
|
||||||
|
// stale sidecar so we re-extract.
|
||||||
|
func sidecarFresh(cachePath, mediaPath string) bool {
|
||||||
|
cfi, err := os.Stat(cachePath)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
mfi, err := os.Stat(mediaPath)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return !cfi.ModTime().Before(mfi.ModTime())
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeSidecar atomically writes data to a sidecar path (temp + rename), creating
|
||||||
|
// the hidden dir if needed. Returns an error the caller logs and continues on
|
||||||
|
// (e.g. a read-only mount) — caching is never required for correctness.
|
||||||
|
func writeSidecar(path string, data []byte) error {
|
||||||
|
if len(data) == 0 {
|
||||||
|
return errors.New("refusing to cache empty artifact")
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
tmp := path + ".tmp"
|
||||||
|
if err := os.WriteFile(tmp, data, 0o644); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := os.Rename(tmp, path); err != nil {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadCachedSubtitle returns the cached WebVTT for (mediaPath, index) when a
|
||||||
|
// fresh sidecar exists. ok=false means the caller should extract on demand.
|
||||||
|
func ReadCachedSubtitle(mediaPath string, index int) ([]byte, bool) {
|
||||||
|
p := subtitleCachePath(mediaPath, index)
|
||||||
|
if !sidecarFresh(p, mediaPath) {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
b, err := os.ReadFile(p)
|
||||||
|
if err != nil || len(b) == 0 {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return b, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteCachedSubtitle stores extracted WebVTT next to the media. Best-effort.
|
||||||
|
func WriteCachedSubtitle(mediaPath string, index int, vtt []byte) error {
|
||||||
|
return writeSidecar(subtitleCachePath(mediaPath, index), vtt)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExtractSubtitleVTT runs ffmpeg to convert subtitle stream `index` of mediaPath
|
||||||
|
// to WebVTT bytes. Shared by the on-demand /sub handler and the scan-time prewarm
|
||||||
|
// so both produce identical output. The caller owns the ctx deadline: the handler
|
||||||
|
// uses a short HTTP-bound timeout; the prewarm uses a generous one (a full text
|
||||||
|
// track on a multi-GB remux can take minutes to demux).
|
||||||
|
func ExtractSubtitleVTT(ctx context.Context, ffmpegPath, mediaPath string, index int) ([]byte, error) {
|
||||||
|
// -map 0:s:<index>? selects the Nth subtitle stream (non-fatal if absent);
|
||||||
|
// -c:s webvtt converts srt/ass/mov_text/etc. to WebVTT on stdout.
|
||||||
|
args := []string{
|
||||||
|
"-nostdin",
|
||||||
|
"-loglevel", "error",
|
||||||
|
"-i", mediaPath,
|
||||||
|
"-map", fmt.Sprintf("0:s:%d?", index),
|
||||||
|
"-c:s", "webvtt",
|
||||||
|
"-f", "webvtt",
|
||||||
|
"-",
|
||||||
|
}
|
||||||
|
cmd := exec.CommandContext(ctx, ffmpegPath, args...)
|
||||||
|
var stderr strings.Builder
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
out, err := cmd.Output()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("ffmpeg subtitle extract: %w: %s", err, strings.TrimSpace(stderr.String()))
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return nil, errors.New("ffmpeg produced no subtitle output")
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExtractSubtitlesVTTMulti extracts several text subtitle streams in a SINGLE
|
||||||
|
// ffmpeg pass. The expensive part of subtitle extraction is demuxing the whole
|
||||||
|
// container (subtitle packets are interleaved across the runtime), so a 60GB
|
||||||
|
// remux with N text tracks costs N full reads when done one index at a time —
|
||||||
|
// here it's one read for all of them. Returns index→WebVTT for the streams that
|
||||||
|
// produced output (an empty stream is simply absent, not an error). ffmpeg can't
|
||||||
|
// multiplex several outputs onto stdout, so it writes per-track temp files which
|
||||||
|
// are read back; callers cache them via WriteCachedSubtitle.
|
||||||
|
func ExtractSubtitlesVTTMulti(ctx context.Context, ffmpegPath, mediaPath string, indices []int) (map[int][]byte, error) {
|
||||||
|
if len(indices) == 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
tmpDir, err := os.MkdirTemp("", "unarr-subs-")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer func() { _ = os.RemoveAll(tmpDir) }()
|
||||||
|
|
||||||
|
args := []string{"-nostdin", "-loglevel", "error", "-i", mediaPath}
|
||||||
|
tmp := make(map[int]string, len(indices))
|
||||||
|
for _, idx := range indices {
|
||||||
|
f := filepath.Join(tmpDir, fmt.Sprintf("s%d.vtt", idx))
|
||||||
|
tmp[idx] = f
|
||||||
|
// One output file per stream; output options precede each output path.
|
||||||
|
args = append(args, "-map", fmt.Sprintf("0:s:%d?", idx), "-c:s", "webvtt", "-f", "webvtt", "-y", f)
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd := exec.CommandContext(ctx, ffmpegPath, args...)
|
||||||
|
var stderr strings.Builder
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
// Run it at IDLE I/O priority: this single ~14 min sequential read of a huge
|
||||||
|
// remux must not starve live streaming off the same disk/NFS.
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
return nil, fmt.Errorf("ffmpeg multi-subtitle start: %w", err)
|
||||||
|
}
|
||||||
|
setIdleIOPriority(cmd.Process.Pid)
|
||||||
|
runErr := cmd.Wait()
|
||||||
|
|
||||||
|
// If ffmpeg was KILLED (ctx deadline/cancel on a file too big to finish in
|
||||||
|
// time), any temp file it left is a truncated WebVTT — a valid header plus
|
||||||
|
// partial cues, so it passes the len>0 check and would be cached as a
|
||||||
|
// silently-incomplete track until the media's mtime changes. Distrust all
|
||||||
|
// output in that case. A clean non-zero exit (e.g. one empty/corrupt stream)
|
||||||
|
// still leaves good complete files for the other tracks, so we keep those.
|
||||||
|
var exitErr *exec.ExitError
|
||||||
|
killed := runErr != nil && errors.As(runErr, &exitErr) && !exitErr.ProcessState.Exited()
|
||||||
|
|
||||||
|
out := make(map[int][]byte, len(indices))
|
||||||
|
if !killed {
|
||||||
|
for idx, f := range tmp {
|
||||||
|
if b, rerr := os.ReadFile(f); rerr == nil && len(b) > 0 {
|
||||||
|
out[idx] = b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return nil, fmt.Errorf("ffmpeg multi-subtitle extract: no usable output (err=%v): %s", runErr, strings.TrimSpace(stderr.String()))
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadCachedThumbnail returns the cached JPEG for (mediaPath, posSec, width) when
|
||||||
|
// a fresh sidecar exists. ok=false means extract on demand.
|
||||||
|
func ReadCachedThumbnail(mediaPath string, posSec float64, width int) ([]byte, bool) {
|
||||||
|
p := thumbnailCachePath(mediaPath, posSec, width)
|
||||||
|
if !sidecarFresh(p, mediaPath) {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
b, err := os.ReadFile(p)
|
||||||
|
if err != nil || len(b) == 0 {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return b, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteCachedThumbnail stores an extracted JPEG frame next to the media. Best-effort.
|
||||||
|
func WriteCachedThumbnail(mediaPath string, posSec float64, width int, jpeg []byte) error {
|
||||||
|
return writeSidecar(thumbnailCachePath(mediaPath, posSec, width), jpeg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExtractThumbnailJPEG decodes ONE frame at posSec, scaled to `width`, as JPEG
|
||||||
|
// bytes. The fast path mirrors engine.buildThumbnailArgs (`-ss` before `-i` =
|
||||||
|
// fast input/keyframe seek); on a seek-index failure both this prewarm path and
|
||||||
|
// the on-demand handler fall back to the identical output-seek argv
|
||||||
|
// (thumbnailArgsAccurate / engine.buildThumbnailArgsAccurate), so the two stay
|
||||||
|
// equivalent in both paths. Shared by the prewarm; the handler keeps its own
|
||||||
|
// inline extraction (engine package) and only reuses the cache helpers here.
|
||||||
|
func ExtractThumbnailJPEG(ctx context.Context, ffmpegPath, mediaPath string, posSec float64, width int) ([]byte, error) {
|
||||||
|
// Fast path: input seek (-ss before -i) — near-constant time, the common case.
|
||||||
|
out, err := runThumbnailFFmpeg(ctx, ffmpegPath, thumbnailArgsFast(mediaPath, posSec, width))
|
||||||
|
if err == nil {
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
// Fallback: output seek (-ss after -i) + error tolerance. Slower (decodes
|
||||||
|
// from the start) but robust on files whose seek index is imprecise or
|
||||||
|
// mildly corrupt, where the fast input seek lands mid-EBML element
|
||||||
|
// ("invalid as first byte of an EBML number") and yields no frame
|
||||||
|
// (2026-06-03: anime MKVs failed every prewarm thumbnail). Paid only when
|
||||||
|
// the fast path fails, so healthy files keep the cheap path.
|
||||||
|
out, err2 := runThumbnailFFmpeg(ctx, ffmpegPath, thumbnailArgsAccurate(mediaPath, posSec, width))
|
||||||
|
if err2 == nil {
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("ffmpeg thumbnail extract: %w (output-seek fallback: %v)", err, err2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// thumbnailArgsFast is the input-seek (fast keyframe) thumbnail argv. Mirrors
|
||||||
|
// engine.buildThumbnailArgs so prewarm frames match the on-demand handler.
|
||||||
|
func thumbnailArgsFast(mediaPath string, posSec float64, width int) []string {
|
||||||
|
return []string{
|
||||||
|
"-nostdin",
|
||||||
|
"-loglevel", "error",
|
||||||
|
"-ss", strconv.FormatFloat(posSec, 'f', 3, 64),
|
||||||
|
"-i", mediaPath,
|
||||||
|
"-frames:v", "1",
|
||||||
|
"-vf", fmt.Sprintf("scale=%d:-2", width),
|
||||||
|
"-an", "-sn",
|
||||||
|
"-f", "mjpeg",
|
||||||
|
"pipe:1",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// thumbnailArgsAccurate is the output-seek (decode-from-start) fallback with
|
||||||
|
// error tolerance. Mirrors engine.buildThumbnailArgsAccurate.
|
||||||
|
func thumbnailArgsAccurate(mediaPath string, posSec float64, width int) []string {
|
||||||
|
return []string{
|
||||||
|
"-nostdin",
|
||||||
|
"-loglevel", "error",
|
||||||
|
"-err_detect", "ignore_err",
|
||||||
|
"-i", mediaPath,
|
||||||
|
"-ss", strconv.FormatFloat(posSec, 'f', 3, 64),
|
||||||
|
"-frames:v", "1",
|
||||||
|
"-vf", fmt.Sprintf("scale=%d:-2", width),
|
||||||
|
"-an", "-sn",
|
||||||
|
"-f", "mjpeg",
|
||||||
|
"pipe:1",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runThumbnailFFmpeg runs one ffmpeg thumbnail extraction and returns the JPEG
|
||||||
|
// bytes. setIdleIOPriority keeps the background prewarm from starving live
|
||||||
|
// playback I/O. An empty output (e.g. seek past EOF) is treated as an error so
|
||||||
|
// the caller can fall back.
|
||||||
|
func runThumbnailFFmpeg(ctx context.Context, ffmpegPath string, args []string) ([]byte, error) {
|
||||||
|
cmd := exec.CommandContext(ctx, ffmpegPath, args...)
|
||||||
|
var stdout, stderr bytes.Buffer
|
||||||
|
cmd.Stdout = &stdout
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
return nil, fmt.Errorf("ffmpeg thumbnail start: %w", err)
|
||||||
|
}
|
||||||
|
setIdleIOPriority(cmd.Process.Pid) // background prewarm yields I/O to live playback
|
||||||
|
err := cmd.Wait()
|
||||||
|
out := stdout.Bytes()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%w: %s", err, strings.TrimSpace(stderr.String()))
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return nil, errors.New("ffmpeg produced no thumbnail (seek past EOF?)")
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue